Registry API reference
Normative contract (draft)Source OpenAPI · Download OpenAPI
Technical metadata
{
"openapi": "3.1.2",
"operations": [
{
"method": "get",
"path": "/health",
"operationId": "getHealth"
},
{
"method": "get",
"path": "/.well-known/api-catalog",
"operationId": "getApiCatalog"
},
{
"method": "head",
"path": "/.well-known/api-catalog",
"operationId": "headApiCatalog"
},
{
"method": "get",
"path": "/v1/capabilities",
"operationId": "getCallerCapabilities"
},
{
"method": "get",
"path": "/v1/collections/{collectionId}/records/{recordId}",
"operationId": "retrieveRecord",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "retrieve",
"view": "record-public",
"features": [
"conditional-read"
]
}
},
{
"method": "patch",
"path": "/v1/collections/{collectionId}/records/{recordId}",
"operationId": "updateRecord",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "update",
"inputSchema": "#/components/schemas/UpdateInput",
"inputMediaType": "application/merge-patch+json",
"companionRead": {
"operationId": "retrieveRecord",
"view": "record-public"
}
}
},
{
"method": "get",
"path": "/v1/collections/{collectionId}/records",
"operationId": "listRecords",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "list",
"view": "record-public"
}
},
{
"method": "post",
"path": "/v1/collections/{collectionId}/records",
"operationId": "createRecord",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "create",
"inputSchema": "#/components/schemas/CreateInput"
}
},
{
"method": "post",
"path": "/v1/collections/{collectionId}/lookup",
"operationId": "lookupRecord",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "lookup",
"view": "record-public"
}
},
{
"method": "post",
"path": "/v1/collections/{collectionId}/search",
"operationId": "searchRecords",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "search",
"view": "record-public"
}
},
{
"method": "get",
"path": "/v1/collections/{collectionId}/records/{recordId}/revisions",
"operationId": "listRecordRevisions",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "revision-list",
"view": "record-history"
}
},
{
"method": "get",
"path": "/v1/collections/{collectionId}/records/{recordId}/revisions/{revisionId}",
"operationId": "retrieveRecordRevision",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "revision-retrieve",
"view": "record-history"
}
},
{
"method": "post",
"path": "/v1/collections/{collectionId}/records/{recordId}/transition",
"operationId": "applyRecordTransition",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"collection": "records",
"capability": "transition",
"inputSchema": "#/components/schemas/TransitionInput",
"action": "transition",
"transitionProfile": "record-transition",
"companionRead": {
"operationId": "retrieveRecord",
"view": "record-public"
}
}
},
{
"method": "post",
"path": "/v1/change-requests",
"operationId": "submitChangeRequest",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"capability": "change-requests",
"inputSchema": "#/components/schemas/CreateChangeRequest"
}
},
{
"method": "get",
"path": "/v1/change-requests",
"operationId": "listChangeRequests"
},
{
"method": "get",
"path": "/v1/change-requests/{changeRequestId}",
"operationId": "getChangeRequest"
},
{
"method": "post",
"path": "/v1/change-requests/{changeRequestId}/approve",
"operationId": "approveChangeRequest",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"capability": "change-requests"
}
},
{
"method": "post",
"path": "/v1/change-requests/{changeRequestId}/reject",
"operationId": "rejectChangeRequest",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"capability": "change-requests"
}
},
{
"method": "post",
"path": "/v1/change-requests/{changeRequestId}/withdraw",
"operationId": "withdrawChangeRequest",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/records",
"capability": "change-requests"
}
},
{
"method": "get",
"path": "/v1/operations/{operationId}",
"operationId": "getOperation"
}
]
}Unofficial preview · 3.0.0-alpha.2 · Source revision 2350fdf8.
Content snapshot 5e66af7b9724.