Auto-generated OpenAPI specs for Apache Custos.
One spec per code-ownership unit:
| Spec | Path | Scope |
|---|---|---|
| Core | api/core.openapi.yaml | Core REST endpoints. |
| Connector | connectors/<NAME>/api/<name>.openapi.yaml | A connector's endpoints under /connectors/<name>/. |
Connector specs ship alongside the connector code; the core spec never declares connector endpoints. The reference connector today is AMIE at connectors/ACCESS/AMIE-Processor/api/amie.openapi.yaml.
Specs are produced from swag annotations on each handler in the Go source. Regenerate after editing any annotation:
make gen-api
CI enforces freshness via make verify-no-drift: modifying a handler annotation without committing the regenerated spec fails the build. The swag version is pinned in go.sum; go generate invokes it through go run, so contributors do not need to install the binary separately.
Both files are standard OpenAPI documents and load into any OpenAPI-aware client, viewer, or codegen tool.