/ready

GET

/ready

const url = 'https://example.com/ready';
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://example.com/ready

Responses

200

Immutable index is loaded

400

Invalid request or request body exceeds the configured bound

application/problem+json

One of:

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.invalid

detail

required

string

<= 1024 characters

Allowed value: The Discovery request is invalid.

status

required

integer

Allowed value: 400

title

required

string

Allowed value: Invalid request

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/invalid-request

Example

{
  "code": "request.invalid",
  "detail": "The Discovery request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-discovery/invalid-request"
}

Headers

traceparent

required

string

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

Canonical W3C Trace Context version 0; the trace identifier equals the problem traceId.

503

Request exceeded the configured time limit or the response could not be produced

application/problem+json

One of:

object

code

required

string

<= 128 characters /^[a-z][a-z0-9-]*[.][a-z][a-z0-9-]*$/

Allowed value: request.invalid

detail

required

string

<= 1024 characters

Allowed value: The Discovery request is invalid.

status

required

integer

Allowed value: 400

title

required

string

Allowed value: Invalid request

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

Allowed value: 00000000000000000000000000000000

type

required

string format: uri

Allowed value: https://id.registrystack.org/problems/registry-discovery/invalid-request

Example

{
  "code": "request.invalid",
  "detail": "The Discovery request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-discovery/invalid-request"
}

Headers

traceparent

required

string

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

Canonical W3C Trace Context version 0; the trace identifier equals the problem traceId.