@@ -167,10 +167,16 @@ consumer as "no public identifier".
167167
168168## OpenAPI specification
169169
170- The contract lives alongside this RFC as a machine-readable spec:
170+ The contract lives with the code it describes, in
171+ [ ` catalogue-api/identifiers/spec ` ] ( https://github.com/wellcomecollection/catalogue-api/tree/main/identifiers/spec ) :
171172
172- - ** [ ` openapi.yaml ` ] ( openapi.yaml ) :** the OpenAPI 3.0 specification (the source of truth).
173- - ** [ ` openapi.md ` ] ( openapi.md ) :** a human-readable rendering of the same spec, generated from it.
173+ - ** [ ` openapi.yaml ` ] ( https://github.com/wellcomecollection/catalogue-api/blob/main/identifiers/spec/openapi.yaml ) :**
174+ the OpenAPI 3.0 specification (the source of truth).
175+ - ** [ ` openapi.md ` ] ( https://github.com/wellcomecollection/catalogue-api/blob/main/identifiers/spec/openapi.md ) :**
176+ a human-readable rendering of the same spec, generated from it.
177+
178+ It moved there with the implementation, so that the API Gateway body can template it from the same
179+ repository and there is no copy to keep in step. This RFC previously carried its own copy.
174180
175181The spec is deliberately a fragment: it carries the two lookup operations, their schemas, the
176182` ApiKeyAuth ` security scheme with ` x-amazon-apigateway-api-key-source: HEADER ` (so API Gateway
@@ -179,13 +185,8 @@ API keys, the per-consumer throttle, or their stage bindings; those are separate
179185Gateway resources configured in Terraform, so importing or re-importing this definition does not
180186disturb them.
181187
182- The rendered ` openapi.md ` is produced by a small self-contained ` uv ` project in this directory,
183- which also validates the spec. After editing ` openapi.yaml ` , regenerate the docs with:
184-
185- ``` bash
186- cd rfcs/089-identifiers-api
187- uv run python render_docs.py
188- ```
188+ ` openapi.md ` is generated by ` render_docs.py ` alongside the spec, which also validates it. That runs
189+ on every pull request in catalogue-api.
189190
190191---
191192
0 commit comments