Business Registry API example
Illustrative exampleSource 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/collections/businesses/records/{recordId}",
"operationId": "retrieveBusiness",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/business",
"collection": "businesses",
"capability": "retrieve",
"view": "business-public",
"features": [
"conditional-read",
"field-selection"
]
}
},
{
"method": "get",
"path": "/v1/collections/businesses/records",
"operationId": "listBusinesses",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/business",
"collection": "businesses",
"capability": "list",
"view": "business-public",
"features": [
"field-selection",
"complete-traversal"
]
}
},
{
"method": "post",
"path": "/v1/collections/businesses/lookup",
"operationId": "lookupBusiness",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/business",
"collection": "businesses",
"capability": "lookup",
"view": "business-public",
"features": [
"field-selection"
]
}
},
{
"method": "post",
"path": "/v1/collections/businesses/search",
"operationId": "searchBusinesses",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/business",
"collection": "businesses",
"capability": "search",
"view": "business-public",
"features": [
"field-selection",
"complete-traversal"
]
}
}
]
}Unofficial preview · 3.0.0-alpha.2 · Source revision 2350fdf8.
Content snapshot 5e66af7b9724.