Skip to content
Registry StackDocsDevelopment (unreleased)

Fetch this OpenAPI document

GET
/openapi.json
curl --request GET \
--url https://example.com/openapi.json

The generated public contract for this service. This route is intentionally unauthenticated: the served bytes are the released generated artifact and describe no deployment, definition, or authority.

The generated Version 1 OpenAPI document

Media typeapplication/openapi+json
object
Examplegenerated
{}
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.

The document could not be produced

Media typeapplication/problem+json
object
One of:
Evidence public problem Version 1
object
code
required
string
Allowed values: malformed_request
operation
required
string
/^[0-9A-HJKMNP-TV-Z]{26}$/
status
required
integer
Allowed values: 400
title
required
string
Allowed values: Request is not valid
type
required
string
Allowed values: https://registrystack.org/problems/evidence/malformed_request
code
required
string
Allowed values: service_unavailable
status
required
integer
Allowed values: 503
title
required
string
Allowed values: Service temporarily unavailable
type
required
string
Allowed values: https://registrystack.org/problems/evidence/service_unavailable
Example
{
"code": "service_unavailable",
"status": 503,
"title": "Service temporarily unavailable",
"type": "https://registrystack.org/problems/evidence/service_unavailable"
}
Cache-Control
string
Allowed values: no-store

Evidence responses are never cacheable.

X-Request-Id
string
/^[0-9A-HJKMNP-TV-Z]{26}$/

Server-minted operation identifier for this request. It is generated by Evidence, never taken from the caller, and is the identifier a caller quotes to an operator. Problem responses repeat it in the operation member.