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.

Responses

200

The generated Version 1 OpenAPI document

Media typeapplication/json

object

Example ^generated

{}

Headers

Cache-Control

string

Allowed values: no-store

Evidence responses are never cacheable.

traceparent

string

/^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Effective W3C trace context. One valid inbound traceparent is retained; missing, invalid, or duplicate values are replaced and tracestate is never reflected.

503

The document could not be produced

Media typeapplication/problem+json

object

One of:

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: evidence.invalid-request

detail

required

string

Allowed values: the Evidence request is invalid

status

required

integer

Allowed values: 400

title

required

string

Allowed values: Evidence request is invalid

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/evidence/invalid-request

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: request.selector-invalid

detail

required

string

Allowed values: selector does not match an available request profile

status

required

integer

Allowed values: 400

title

required

string

Allowed values: Selector is invalid

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/request/selector-invalid

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: auth.invalid-credential

detail

required

string

Allowed values: bearer access token validation failed

status

required

integer

Allowed values: 401

title

required

string

Allowed values: Bearer access token is invalid

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/auth/invalid-credential

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: evidence.denied

detail

required

string

Allowed values: the Evidence request is not permitted

status

required

integer

Allowed values: 403

title

required

string

Allowed values: Evidence request is not permitted

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/evidence/denied

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: format.unsupported

detail

required

string

Allowed values: the requested format is not supported

status

required

integer

Allowed values: 406

title

required

string

Allowed values: Requested format is not supported

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/format/unsupported

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: evidence.unavailable

detail

required

string

Allowed values: evidence could not be produced for this request

status

required

integer

Allowed values: 422

title

required

string

Allowed values: Evidence could not be produced

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/evidence/unavailable

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: evidence.rate-limited

detail

required

string

Allowed values: the Evidence request rate is exhausted

status

required

integer

Allowed values: 429

title

required

string

Allowed values: Evidence request rate is exhausted

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/evidence/rate-limited

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: source.unavailable

detail

required

string

Allowed values: the authoritative source is unavailable

status

required

integer

Allowed values: 503

title

required

string

Allowed values: Authoritative source is unavailable

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/source/unavailable

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: service.unavailable

detail

required

string

Allowed values: the request could not be served

status

required

integer

Allowed values: 503

title

required

string

Allowed values: Service is unavailable

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/service/unavailable

Evidence public problem Version 1

Evidence public problem Version 1

object

code

required

string

Allowed values: resource.not-found

detail

required

string

Allowed values: the requested resource was not found

status

required

integer

Allowed values: 404

title

required

string

Allowed values: Requested resource was not found

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/resource/not-found

code

required

string

Allowed values: service.unavailable

detail

required

string

Allowed values: the request could not be served

status

required

integer

Allowed values: 503

title

required

string

Allowed values: Service is unavailable

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/service/unavailable

Example

{
  "code": "service.unavailable",
  "detail": "the request could not be served",
  "status": 503,
  "title": "Service is unavailable",
  "type": "https://id.registrystack.org/problems/registry-evidence/service/unavailable"
}

Headers

Cache-Control

string

Allowed values: no-store

Evidence responses are never cacheable.

traceparent

string

/^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Effective W3C trace context. One valid inbound traceparent is retained; missing, invalid, or duplicate values are replaced and tracestate is never reflected.