Instance-specific OpenAPI document
GET
/openapi.json
const url = 'https://data.example.test/openapi.json';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://data.example.test/openapi.jsonReturns the OpenAPI document for the running instance.
Responses
Section titled “Responses”Successful response
Media typeapplication/json
Published JSON Schema document.
object
key
additional properties
any
Examplegenerated
{}Requested provenance artefact is not available.
Media typeapplication/problem+json
RFC 9457 Problem Details, returned for every non-2xx response.
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{ "code": "auth.missing_credential", "detail": "no credential provided in Authorization or x-api-key header", "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "status": 401, "title": "Missing credential", "type": "https://registry-relay.dev/problems/auth/missing_credential"}default
Section titled “default”Problem Details error response.
Media typeapplication/problem+json
RFC 9457 Problem Details, returned for every non-2xx response.
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{ "code": "auth.missing_credential", "detail": "no credential provided in Authorization or x-api-key header", "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "status": 401, "title": "Missing credential", "type": "https://registry-relay.dev/problems/auth/missing_credential"}