Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions rfcs/089-identifiers-api/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion rfcs/089-identifiers-api/.python-version

This file was deleted.

21 changes: 11 additions & 10 deletions rfcs/089-identifiers-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,16 @@ consumer as "no public identifier".

## OpenAPI specification

The contract lives alongside this RFC as a machine-readable spec:
The contract lives with the code it describes, in
[`catalogue-api/identifiers/spec`](https://github.com/wellcomecollection/catalogue-api/tree/main/identifiers/spec):

- **[`openapi.yaml`](openapi.yaml):** the OpenAPI 3.0 specification (the source of truth).
- **[`openapi.md`](openapi.md):** a human-readable rendering of the same spec, generated from it.
- **[`openapi.yaml`](https://github.com/wellcomecollection/catalogue-api/blob/main/identifiers/spec/openapi.yaml):**
the OpenAPI 3.0 specification (the source of truth).
- **[`openapi.md`](https://github.com/wellcomecollection/catalogue-api/blob/main/identifiers/spec/openapi.md):**
a human-readable rendering of the same spec, generated from it.

It moved there with the implementation, so that the API Gateway body can template it from the same
repository and there is no copy to keep in step. This RFC previously carried its own copy.

The spec is deliberately a fragment: it carries the two lookup operations, their schemas, the
`ApiKeyAuth` security scheme with `x-amazon-apigateway-api-key-source: HEADER` (so API Gateway
Expand All @@ -179,13 +185,8 @@ API keys, the per-consumer throttle, or their stage bindings; those are separate
Gateway resources configured in Terraform, so importing or re-importing this definition does not
disturb them.

The rendered `openapi.md` is produced by a small self-contained `uv` project in this directory,
which also validates the spec. After editing `openapi.yaml`, regenerate the docs with:

```bash
cd rfcs/089-identifiers-api
uv run python render_docs.py
```
`openapi.md` is generated by `render_docs.py` alongside the spec, which also validates it. That runs
on every pull request in catalogue-api.

---

Expand Down
119 changes: 0 additions & 119 deletions rfcs/089-identifiers-api/openapi.md

This file was deleted.

Loading
Loading