Skip to content

RFC 089: correct the FOLIO item source system name to folio-item - #167

Merged
annak-k merged 1 commit into
mainfrom
fix-folio-item-name
Aug 21, 2026
Merged

RFC 089: correct the FOLIO item source system name to folio-item#167
annak-k merged 1 commit into
mainfrom
fix-folio-item-name

Conversation

@annak-k

@annak-k annak-k commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Preview


What does this change?

Closes wellcomecollection/platform#6538, together with the prototype-side change in location-movement-control-docs.

The catalogue pipeline names the FOLIO item identifier folio-item. RFC 089 said folio-item-id in four places. That name is a URL path segment, so a consumer following the RFC would call /v1/identifiers/by-source/folio-item-id/{uuid} against a registry storing folio-item and get a 404 indistinguishable from a genuine "no such identifier".

The pipeline is already emitting the correct value in both implementations, so the decision recorded on the issue is to amend the documentation rather than change the pipeline, which would mean rewriting rows rather than editing prose.

All four occurrences are prose about registry contents and pipeline sequencing (lines 337, 388, 390 and 476). No decisions change, and openapi.yaml and the generated openapi.md never contained the wrong spelling, so the contract is untouched.

The issue also asks whether any other source system name in RFC 089 disagrees with catalogue-pipeline's IdentifierType.scala. None does: the RFC names three, and with this change all three match, sierra-system-number (line 45), folio-instance (line 50) and folio-item (line 55).

How to test

Read the diff, and check the four paragraphs still read correctly rather than just that the string changed. The authority for the name is catalogue-pipeline/common/internal_model/src/main/scala/weco/catalogue/internal_model/identifiers/IdentifierType.scala:55, and the Python side sets the same value in catalogue_graph/src/adapters/transformers/builders/folio_work_builder.py.

Both repo CI checks pass locally: validate_rfc.py on the changed README, and create_table_summary.py --check-readme.

How can we measure success?

Not applicable: the measure is that one spelling now appears across the RFC, the prototype and the pipeline, which the diff shows directly.

Have we considered potential risks?

Not applicable beyond the change itself: this is prose in a merged RFC, with no runtime or deployment surface.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@annak-k
annak-k requested review from a team as code owners August 21, 2026 12:26
@annak-k
annak-k merged commit 428e670 into main Aug 21, 2026
7 checks passed
@annak-k
annak-k deleted the fix-folio-item-name branch August 21, 2026 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Correct the FOLIO item source system name to folio-item across RFC 089 and the prototype

2 participants