Registry Write API example
Illustrative exampleSource OpenAPI · Download OpenAPI
Technical metadata
{
"openapi": "3.1.2",
"operations": [
{
"method": "post",
"path": "/v1/collections/birth-registrations/records",
"operationId": "createBirthRegistration",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"collection": "birth-registrations",
"capability": "create",
"inputSchema": "./write-examples.schema.json#/$defs/BirthDeclarationCreateInput"
}
},
{
"method": "post",
"path": "/v1/collections/households/records",
"operationId": "createHousehold",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"collection": "households",
"capability": "create",
"inputSchema": "./write-examples.schema.json#/$defs/HouseholdCreateInput"
}
},
{
"method": "post",
"path": "/v1/collections/individuals/records",
"operationId": "createIndividual",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"collection": "individuals",
"capability": "create",
"inputSchema": "./write-examples.schema.json#/$defs/IndividualCreateInput"
}
},
{
"method": "get",
"path": "/v1/collections/individuals/records/{recordId}",
"operationId": "retrieveIndividualForWrite",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/example",
"collection": "individuals",
"capability": "retrieve",
"view": "individual-write",
"features": [
"conditional-read"
]
}
},
{
"method": "patch",
"path": "/v1/collections/individuals/records/{recordId}",
"operationId": "updateRecord",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"collection": "individuals",
"capability": "update",
"inputSchema": "./write-examples.schema.json#/$defs/IndividualUpdateInput",
"inputMediaType": "application/merge-patch+json",
"companionRead": {
"operationId": "retrieveIndividualForWrite",
"view": "individual-write"
}
}
},
{
"method": "get",
"path": "/v1/collections/birth-registrations/records/{recordId}",
"operationId": "retrieveBirthRegistrationForWrite",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/example",
"collection": "birth-registrations",
"capability": "retrieve",
"view": "birth-registration-write",
"features": [
"conditional-read"
]
}
},
{
"method": "post",
"path": "/v1/collections/birth-registrations/records/{recordId}/correct-birth",
"operationId": "correctBirth",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"collection": "birth-registrations",
"capability": "transition",
"inputSchema": "./write-examples.schema.json#/$defs/BirthCorrectionInput",
"action": "correct-birth",
"transitionProfile": "publicschema-birth-correction",
"companionRead": {
"operationId": "retrieveBirthRegistrationForWrite",
"view": "birth-registration-write"
}
}
},
{
"method": "get",
"path": "/v1/collections/households/records/{recordId}",
"operationId": "retrieveHouseholdForWrite",
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/example",
"collection": "households",
"capability": "retrieve",
"view": "household-write",
"features": [
"conditional-read"
]
}
},
{
"method": "post",
"path": "/v1/collections/households/records/{recordId}/add-member",
"operationId": "addHouseholdMember",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"collection": "households",
"capability": "transition",
"inputSchema": "./write-examples.schema.json#/$defs/HouseholdAddMemberInput",
"action": "add-member",
"transitionProfile": "publicschema-household-add-member",
"companionRead": {
"operationId": "retrieveHouseholdForWrite",
"view": "household-write"
}
}
},
{
"method": "post",
"path": "/v1/change-requests",
"operationId": "submitChangeRequest",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"capability": "change-requests",
"inputSchema": "./write-examples.schema.json#/$defs/PublicSchemaChangeRequestInput"
}
},
{
"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/example",
"capability": "change-requests"
}
},
{
"method": "post",
"path": "/v1/change-requests/{changeRequestId}/reject",
"operationId": "rejectChangeRequest",
"x-govstack-digital-registries-write": {
"registry": "https://registry.example/registries/example",
"capability": "change-requests"
}
}
]
}Unofficial preview · 3.0.0-alpha.2 · Source revision 2350fdf8.
Content snapshot 5e66af7b9724.