Skip to content
Registry StackDocsDevelopment (unreleased)

actions.correct-address.start

POST
/v1/actions/correct-address/proposals
curl --request POST \
  --url https://example.com/v1/actions/correct-address/proposals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "input": { "addressLine": "example", "city": "example", "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "postalCode": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Optional W3C trace context. Responses carry Registry trace context for the request.

Idempotency-Key
required
string
>= 1 characters <= 256 characters /^[\x21-\x2B\x2D-\x3A\x3C-\x7E]+$/

Idempotency key bound to the action route, selected profile, package revision, normalized action input, preconditions, and granted result contract.

Query Parameters

Section titled “Query Parameters”
accessProfile
string
<= 128 characters

Select one compiled access profile. Required when the route has no default; otherwise omission uses its default.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
input
required
object
addressLine
required
string
>= 1 characters <= 240 characters
city
required
string
>= 1 characters <= 120 characters
facilityId
required
string format: uuid
postalCode
required
string
>= 1 characters <= 24 characters

Example generated

{
  "input": {
    "addressLine": "example",
    "city": "example",
    "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "postalCode": "example"
  }
}

Responses

Section titled “Responses”

201

Section titled “201”

Proposal created

Media typeapplication/json
object
actionId
required
string
actionRevision
required
string
application
object
applicationId
required
string format: uuid
effectDigest
required
string
/^sha256:[0-9a-f]{64}$/
resultLinks
required
Array<object>
<= 16 items
object
recordId
required
string format: uuid
recordType
required
string
revision
required
integer
>= 1
submissionVersion
required
integer
>= 1
applicationStatus
object
automaticRetry
object
attempts
required
integer
<= 1000
maximumAttempts
required
integer
>= 1 <= 1000
scheduled
required
boolean
mode
required
Allowed values: automatic manual
reason
Allowed values: contract-changed dependency-outage lease-expired application-refused attempts-exhausted
recovery
Allowed values: retry correct-input
state
required
Allowed values: awaiting-review pending applying blocked applied cancelled rejected
attachments
object
<= 8 properties
key
additional properties
object
classification
required
Allowed values: public internal restricted
contentTypes
required
Array<string>
>= 1 items <= 16 items unique items
id
required
string
links
required
object
key
additional properties
object
accessProfile
required
string
availability
object
available
required
boolean
observedRevision
required
integer
>= 1
reason
Allowed values: pending-review review-rejected review-changes-requested review-ended stale-revision contract-changed dependency-outage invalid-input already-applied
recovery
Allowed values: refresh revise retry correct-input receipt-only
ifMatch
string
method
required
Allowed values: GET PATCH DELETE
operation
required
Allowed values: download upload remove
path
required
string
maximumBytes
required
integer
>= 1 <= 16777216
required
required
boolean
value
object
byteSize
required
integer
>= 1
contentType
required
string
sha256
required
string
/^[a-f0-9]{64}$/
submissionVersion
required
integer
uploadedAt
string
verificationStatus
required
Allowed values: notRequired pending approved rejected
blockedReason
Allowed values: package-changed
decision
object
decidedAt
required
string format: date-time
publicReason
string
>= 1 characters /^[^\u0000-\u001F\u007F-\u009F]*[^\u0000-\u0020\u007F-\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000][^\u0000-\u001F\u007F-\u009F]*$/
status
required
Allowed values: approved rejected changes-requested answered
effectDigest
string
id
required
string format: uuid
input
object
links
required
object
key
additional properties
object
accessProfile
required
string
availability
object
available
required
boolean
observedRevision
required
integer
>= 1
reason
Allowed values: pending-review review-rejected review-changes-requested review-ended stale-revision contract-changed dependency-outage invalid-input already-applied
recovery
Allowed values: refresh revise retry correct-input receipt-only
ifMatch
string
method
required
Allowed values: GET POST
operation
required
string
path
required
string
revision
required
integer
>= 1
state
required
Allowed values: draft submitted applied cancelled rejected
submissionVersion
required
integer
title
string
<= 1024 characters
turn
required
Allowed values: party official nobody

Example 

{
  "applicationStatus": {
    "mode": "automatic",
    "reason": "contract-changed",
    "recovery": "retry",
    "state": "awaiting-review"
  },
  "attachments": {
    "additionalProperty": {
      "classification": "public",
      "links": {
        "additionalProperty": {
          "availability": {
            "reason": "pending-review",
            "recovery": "refresh"
          },
          "method": "GET",
          "operation": "download"
        }
      },
      "value": {
        "verificationStatus": "notRequired"
      }
    }
  },
  "blockedReason": "package-changed",
  "decision": {
    "status": "approved"
  },
  "links": {
    "additionalProperty": {
      "availability": {
        "reason": "pending-review",
        "recovery": "refresh"
      },
      "method": "GET"
    }
  },
  "state": "draft",
  "turn": "party"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

ETag
string
/^\"breg-[\x21\x23-\x7E]+\"$/

Strong Registry ETag for the created Proposal.

Location
string

Relative URL of the created Proposal.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

400

Section titled “400”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Examplerequest.invalid
{
  "code": "request.invalid",
  "detail": "The request is invalid.",
  "status": 400,
  "title": "Bad Request",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/request/invalid"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

401

Section titled “401”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Exampleauthentication.refused
{
  "code": "authentication.refused",
  "detail": "The bearer credential is missing or refused.",
  "status": 401,
  "title": "Unauthorized",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/authentication/refused"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

404

Section titled “404”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Exampleresource.not_found
{
  "code": "resource.not_found",
  "detail": "The requested resource was not found.",
  "status": 404,
  "title": "Not Found",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/resource/not_found"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

409

Section titled “409”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

{
  "code": "idempotency.conflict",
  "detail": "The idempotency key is bound to another request.",
  "status": 409,
  "title": "Conflict",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/idempotency/conflict"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

410

Section titled “410”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Exampleidempotency.expired
{
  "code": "idempotency.expired",
  "detail": "The held response of the idempotency key expired; the key stays spent.",
  "status": 410,
  "title": "Gone",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/idempotency/expired"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

412

Section titled “412”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Exampleprecondition.failed
{
  "code": "precondition.failed",
  "detail": "The mutation precondition failed.",
  "status": 412,
  "title": "Precondition Failed",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/precondition/failed"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

415

Section titled “415”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Exampleunsupported.media_type
{
  "code": "unsupported.media_type",
  "detail": "The request media type is not supported.",
  "status": 415,
  "title": "Unsupported Media Type",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/unsupported/media_type"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

503

Section titled “503”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Exampleservice.unavailable
{
  "code": "service.unavailable",
  "detail": "The Registry mutation service is unavailable.",
  "status": 503,
  "title": "Service Unavailable",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/service/unavailable"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01

504

Section titled “504”

Problem response

Media typeapplication/problem+json
object
code
required
string
Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type
constraintId
string
>= 1 characters <= 128 characters
constraintKind
string
Allowed values: compare int-range vocabulary
detail
required
string
<= 256 characters
field
string
>= 1 characters <= 128 characters
fieldId
string
>= 1 characters <= 128 characters
fieldPath
string
<= 256 characters
left
string
>= 1 characters <= 128 characters
reasonCode
string
Allowed values: computation-error source-data-error disclosure-risk
recordType
string
>= 1 characters <= 128 characters
refusalCode
string
>= 1 characters <= 128 characters
right
string
>= 1 characters <= 128 characters
status
required
integer
>= 400 <= 599
title
required
string
<= 128 characters
traceId
required
string
>= 32 characters <= 32 characters /^[0-9a-f]{32}$/
type
required
string format: uri
<= 256 characters

Examples

Examplerequest.timeout
{
  "code": "request.timeout",
  "detail": "The request timed out.",
  "status": 504,
  "title": "Gateway Timeout",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/request/timeout"
}

Headers

Section titled “Headers”
Cache-Control
Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent
string
>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example 
00-11111111111111111111111111111111-2222222222222222-01