Fetch this OpenAPI document

GET

/openapi.json

const url = 'https://example.com/openapi.json';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

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://example.com/openapi.json \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

apiKeyAuth
bearerAuth

Responses

200

OpenAPI document

application/json

Example

{
  "info": {
    "title": "Registry Notary API",
    "version": "0.6.2"
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/evaluations": {}
  }
}

401

Missing or invalid credential

application/problem+json

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": "missing authentication credential",
  "status": 401,
  "title": "Missing credential",
  "type": "https://docs.registry-notary.dev/problems/auth/missing_credential"
}