{
"openapi": "3.0.0",
"info": {
"title": "Catalyst Gateway",
"description": "# Catalyst Gateway API.\n\nThe Catalyst Gateway API provides realtime data for all prior, current and future Catalyst Voices voting events.",
"version": "1.2.0",
"termsOfService": "https://github.com/input-output-hk/catalyst-voices/blob/main/CODE_OF_CONDUCT.md",
"contact": {
"name": "Project Catalyst Team",
"url": "https://projectcatalyst.io",
"email": "contact@projectcatalyst.io"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
}
},
"servers": [
{
"url": "http://buildkitsandbox:3030",
"description": "Server at localhost name."
}
],
"tags": [
{
"name": "Cardano",
"description": "General Cardano Blockchain Information."
},
{
"name": "Config",
"description": "Service Configuration and Status."
},
{
"name": "Documents",
"description": "Signed Document endpoints"
},
{
"name": "Health",
"description": "Service Health and Readiness."
}
],
"paths": {
"/api/gateway/v1/health/started": {
"get": {
"tags": [
"Health"
],
"summary": "Service Started",
"description": "This endpoint is used to determine if the service has started properly\nand is able to serve requests.\n\n## Note\n\n*This endpoint is for internal use of the service deployment infrastructure.\nIt may not be exposed publicly.*",
"responses": {
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"204": {
"description": "## No Content\n\nService is Started and can serve requests.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
}
},
"security": [
{
"NoAuthorization": []
}
],
"operationId": "healthStarted"
}
},
"/api/gateway/v1/health/ready": {
"get": {
"tags": [
"Health"
],
"summary": "Service Ready",
"description": "This endpoint is used to determine if the service is ready and able to serve\nrequests.\n\n## Note\n\n*This endpoint is for internal use of the service deployment infrastructure.\nIt may not be exposed publicly.*",
"responses": {
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"204": {
"description": "## No Content\n\nService is Started and can serve requests.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
}
},
"security": [
{
"NoAuthorization": []
}
],
"operationId": "healthReady"
}
},
"/api/gateway/v1/health/live": {
"get": {
"tags": [
"Health"
],
"summary": "Service Live",
"description": "This endpoint is used to determine if the service is live.\n\n## Note\n\n*This endpoint is for internal use of the service deployment infrastructure.\nIt may not be exposed publicly. Refer to []*",
"responses": {
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"204": {
"description": "## No Content\n\nService is OK and can keep running.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
}
},
"security": [
{
"NoAuthorization": []
}
],
"operationId": "healthLive"
}
},
"/api/gateway/v1/rbac/registration": {
"get": {
"tags": [
"Cardano"
],
"summary": "Get RBAC registrations",
"description": "This endpoint returns RBAC registrations by provided auth Catalyst Id credentials\nor by the `lookup` argument if provided.",
"parameters": [
{
"name": "lookup",
"schema": {
"type": "string",
"format": "catalyst_id|cardano:cip19-address",
"title": "Catalyst Id or Stake Address.",
"description": "Restrict the query to this Catalyst Id or Stake Address. If neither are defined, the auth token is used.",
"example": "stake_test1uqehkck0lajq8gr28t9uxnuvgcqrc6070x3k9r8048z8y5gssrtvn",
"pattern": "^(.+\\/[A-Za-z0-9_-]{43})|(^(stake|stake_test)1[a,c-h,j-n,p-z,0,2-9]{53}$)$"
},
"in": "query",
"description": "Stake address or Catalyst ID to get the RBAC registration for.",
"required": false,
"deprecated": false,
"explode": true
}
],
"responses": {
"422": {
"description": "Response for unprocessable content.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RbacUnprocessableContent"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"200": {
"description": "## Ok\n\nSuccess returns a list of registration transaction ids.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RbacRegistrationChain"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"404": {
"description": "No valid registration.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
},
{
"NoAuthorization": []
}
],
"operationId": "rbacRegistrations"
}
},
"/api/gateway/v1/cardano/assets/{stake_address}": {
"get": {
"tags": [
"Cardano"
],
"summary": "Get staked assets.",
"description": "This endpoint returns the total Cardano's staked assets to the corresponded\nuser's stake address.",
"parameters": [
{
"name": "stake_address",
"schema": {
"type": "string",
"format": "cardano:cip19-address",
"title": "Cardano stake address",
"description": "Cardano stake address, also known as a reward address.",
"externalDocs": {
"url": "https://cips.cardano.org/cip/CIP-19",
"description": "CIP-19 - Cardano Addresses"
},
"example": "stake_test1uqehkck0lajq8gr28t9uxnuvgcqrc6070x3k9r8048z8y5gssrtvn",
"maxLength": 64,
"minLength": 59,
"pattern": "^(stake|stake_test)1[a,c-h,j-n,p-z,0,2-9]{53}$"
},
"in": "path",
"description": "The stake address of the user.\nShould be a valid Bech32 encoded address followed by the https://cips.cardano.org/cip/CIP-19/#stake-addresses.",
"required": true,
"deprecated": false,
"explode": true
},
{
"name": "network",
"schema": {
"$ref": "#/components/schemas/Network"
},
"in": "query",
"description": "Cardano network type.\nIf omitted network type is identified from the stake address.\nIf specified it must be correspondent to the network type encoded in the stake\naddress.\nAs `preprod` and `preview` network types in the stake address encoded as a\n`testnet`, to specify `preprod` or `preview` network type use this\nquery parameter.",
"required": false,
"deprecated": false,
"explode": true
},
{
"name": "asat",
"schema": {
"type": "string",
"format": "slot or time",
"title": "As At this Time OR Slot.",
"description": "Restrict the query to this time.\nTime can be represented as either the blockchains slot number, \nor the number of seconds since midnight 1970, UTC.\n\nIf this parameter is not defined, the query will retrieve data up to the current time.",
"example": "TIME:1730861339",
"maxLength": 25,
"minLength": 6,
"pattern": "^(SLOT|TIME):(\\d{1,20})$"
},
"in": "query",
"description": "A time point at which the assets should be calculated.\nIf omitted latest slot number is used.",
"required": false,
"deprecated": false,
"explode": true
}
],
"responses": {
"404": {
"description": "## Not Found\n\nThe queried stake address was not found at the requested slot number.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"200": {
"description": "## Ok\n\nThe amount of ADA staked by the queried stake address, as at the indicated slot.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/FullStakeInfo"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
},
{
"NoAuthorization": []
}
],
"operationId": "stakedAssetsGet"
}
},
"/api/gateway/v1/config/frontend": {
"get": {
"tags": [
"Config"
],
"summary": "Get the configuration for the frontend.",
"description": "Get the frontend configuration for the requesting client.\n\n### Security\n\nDoes not require any Catalyst RBAC Token to access.",
"responses": {
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"404": {
"description": "No frontend config defined.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"200": {
"description": "Configuration result.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"type": "object",
"example": {
"name": "Alex"
}
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
},
{
"NoAuthorization": []
}
],
"operationId": "get_config_frontend"
}
},
"/api/gateway/v1/document/{document_id}": {
"get": {
"tags": [
"Documents"
],
"summary": "Get A Signed Document.",
"description": "This endpoint returns either a specific or latest version of a registered signed\ndocument.",
"parameters": [
{
"name": "document_id",
"schema": {
"type": "string",
"format": "uuidv7",
"title": "UUIDv7",
"description": "128 Bit UUID Version 7 - Timestamp + Random",
"example": "01943a32-9f35-7a14-b364-36ad693465e6",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"in": "path",
"description": "UUIDv7 Document ID to retrieve",
"required": true,
"deprecated": false,
"explode": true
},
{
"name": "version",
"schema": {
"type": "string",
"format": "uuidv7",
"title": "UUIDv7",
"description": "128 Bit UUID Version 7 - Timestamp + Random",
"example": "01943a32-9f35-7a14-b364-36ad693465e6",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"in": "query",
"description": "UUIDv7 Version of the Document to retrieve, if omitted, returns the latest\nversion.",
"required": false,
"deprecated": false,
"explode": true
}
],
"responses": {
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"200": {
"description": "## OK\n\nThe Document that was requested.",
"content": {
"application/cbor": {
"schema": {
"type": "string",
"format": "binary",
"example": "(binary data)"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"404": {
"description": "## Not Found\n\nThe document could not be found.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
},
{
"NoAuthorization": []
}
],
"operationId": "getDocument"
}
},
"/api/gateway/v1/document": {
"put": {
"tags": [
"Documents"
],
"summary": "Put A Signed Document.",
"description": "This endpoint returns OK if the document is valid, able to be put by the\nsubmitter, and if it already exists, is identical to the existing document.",
"requestBody": {
"description": "The document to PUT",
"content": {
"application/cbor": {
"schema": {
"type": "string",
"format": "binary",
"example": "(binary data)"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "## No Content\n\nThe Document was already stored, and has not changed.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"422": {
"description": "## Unprocessable Content\n\nError Response. The document submitted is invalid.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PutDocumentUnprocessableContent"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"413": {
"description": "## Content Too Large\n\nPayload Too Large. The document exceeds the maximum size of a legitimate single\ndocument.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"201": {
"description": "## Created\n\nThe Document was stored OK for the first time.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
}
],
"operationId": "putDocument"
}
},
"/api/gateway/v1/document/index": {
"post": {
"tags": [
"Documents"
],
"summary": "Post A Signed Document Index Query.",
"description": "This endpoint produces a summary of signed documents that meet the criteria\ndefined in the request body.\n\nIt does not return the actual documents, just an index of the document identifiers\nwhich allows the documents to be retrieved by the `GET document` endpoint.",
"parameters": [
{
"name": "page",
"schema": {
"type": "integer",
"format": "u32",
"title": "Page",
"description": "The page number of the data.\nThe size of each page, and its offset within the complete data set is determined by the `limit` parameter.",
"default": 0,
"example": 5,
"maximum": 4294967295.0,
"minimum": 0.0
},
"in": "query",
"required": false,
"deprecated": false,
"explode": true
},
{
"name": "limit",
"schema": {
"type": "integer",
"format": "u32",
"title": "Limit",
"description": "The size `limit` of each `page` of results.\nDetermines the maximum amount of data that can be returned in a valid response.\n\nThis `limit` of records of data will always be returned unless there is less data to return \nthan allowed for by the `limit` and `page`.\n\n*Exceeding the `page`/`limit` of all available records will not return `404`, it will return an \nempty response.*",
"default": 100,
"example": 10,
"maximum": 100.0,
"minimum": 1.0
},
"in": "query",
"required": false,
"deprecated": false,
"explode": true
}
],
"requestBody": {
"description": "The Query Filter Specification",
"content": {
"application/json; charset=utf-8": {
"schema": {
"title": "Document Index Query Filter",
"description": "A Query Filter which causes documents whose metadata matches the provided\nfields to be returned in the index list response.\n\nFields which are not set, are not used to filter documents based on those metadata\nfields. This is equivalent to returning documents where those metadata fields either\ndo not exist, or do exist, but have any value.",
"allOf": [
{
"$ref": "#/components/schemas/DocumentIndexQueryFilter"
},
{
"title": "Document Index Query Filter",
"description": "A Query Filter which causes documents whose metadata matches the provided\nfields to be returned in the index list response.\n\nFields which are not set, are not used to filter documents based on those metadata\nfields. This is equivalent to returning documents where those metadata fields either\ndo not exist, or do exist, but have any value.",
"example": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"ref": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"reply": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"template": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"ref": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"reply": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"template": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"404": {
"description": "## Not Found\n\nNo documents were found which match the query filter.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"200": {
"description": "## OK\n\nThe Index of documents which match the query filter.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"title": "Document Index List",
"description": "A list of all matching documents, limited by the paging parameters.\nDocuments are listed in Ascending order.\nThe Paging limit refers to the number fo document versions, not the number\nof unique Document IDs.",
"allOf": [
{
"$ref": "#/components/schemas/DocumentIndexList"
},
{
"title": "Document Index List",
"description": "A list of all matching documents, limited by the paging parameters.\nDocuments are listed in Ascending order.\nThe Paging limit refers to the number fo document versions, not the number\nof unique Document IDs.",
"example": {
"docs": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"page": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
}
],
"example": {
"docs": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"page": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
},
{
"NoAuthorization": []
}
],
"operationId": "postDocument"
}
},
"/api/gateway/v2/document/index": {
"post": {
"tags": [
"Documents"
],
"summary": "Post A Signed Document Index Query for Newer Versions of v0.04.",
"description": "Produces a summary of signed documents that meet the criteria\ndefined in the request body for new signed document versions of v0.04.\n\nIt does not return the actual documents, just an index of the document identifiers\nwhich allows the documents to be retrieved by the `GET document` endpoint.",
"parameters": [
{
"name": "page",
"schema": {
"type": "integer",
"format": "u32",
"title": "Page",
"description": "The page number of the data.\nThe size of each page, and its offset within the complete data set is determined by the `limit` parameter.",
"default": 0,
"example": 5,
"maximum": 4294967295.0,
"minimum": 0.0
},
"in": "query",
"required": false,
"deprecated": false,
"explode": true
},
{
"name": "limit",
"schema": {
"type": "integer",
"format": "u32",
"title": "Limit",
"description": "The size `limit` of each `page` of results.\nDetermines the maximum amount of data that can be returned in a valid response.\n\nThis `limit` of records of data will always be returned unless there is less data to return \nthan allowed for by the `limit` and `page`.\n\n*Exceeding the `page`/`limit` of all available records will not return `404`, it will return an \nempty response.*",
"default": 100,
"example": 10,
"maximum": 100.0,
"minimum": 1.0
},
"in": "query",
"required": false,
"deprecated": false,
"explode": true
}
],
"requestBody": {
"description": "The Query Filter Specification",
"content": {
"application/json; charset=utf-8": {
"schema": {
"title": "Document Index Query Filter",
"description": "A Query Filter which causes documents whose metadata matches the provided\nfields to be returned in the index list response.\n\nFields which are not set, are not used to filter documents based on those metadata\nfields. This is equivalent to returning documents where those metadata fields either\ndo not exist, or do exist, but have any value.",
"allOf": [
{
"$ref": "#/components/schemas/DocumentIndexQueryFilterV2"
},
{
"title": "Document Index Query Filter",
"description": "A Query Filter which causes documents whose metadata matches the provided\nfields to be returned in the index list response.\n\nFields which are not set, are not used to filter documents based on those metadata\nfields. This is equivalent to returning documents where those metadata fields either\ndo not exist, or do exist, but have any value.",
"example": {
"brand": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"id": [
{
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"ref": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"reply": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"template": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"type": [
"7808d2ba-d511-40af-84e8-c0d1625fdfdc"
],
"ver": [
{
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
]
}
}
],
"example": {
"brand": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"id": [
{
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"ref": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"reply": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"template": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"type": [
"7808d2ba-d511-40af-84e8-c0d1625fdfdc"
],
"ver": [
{
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
]
}
}
}
},
"required": true
},
"responses": {
"429": {
"description": "## Too Many Requests\n\nThe client has sent too many requests in a given amount of time.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
},
"RETRY-AFTER": {
"required": true,
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"431": {
"description": "## Request Header Fields Too Large\n\nThe client sent a request with too large header fields.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"500": {
"description": "## Internal Server Error.\n\nAn internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
}
}
},
"503": {
"description": "## Service Unavailable\n\nThe service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailable"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RETRY-AFTER": {
"deprecated": false,
"schema": {
"type": "string",
"format": "http-date || integer",
"title": "Retry-After Header",
"description": "Http Date or Interval in seconds.\nValid formats:\n\n* `Retry-After: <http-date>`\n* `Retry-After: <delay-seconds>`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After>",
"example": "300"
}
}
}
},
"200": {
"description": "## OK\n\nThe Index of documents which match the query filter.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"title": "Document Index List",
"description": "A list of all matching documents, limited by the paging parameters.\nDocuments are listed in Ascending order.\nThe Paging limit refers to the number fo document versions, not the number\nof unique Document IDs.",
"allOf": [
{
"$ref": "#/components/schemas/DocumentIndexListV2"
},
{
"title": "Document Index List",
"description": "A list of all matching documents, limited by the paging parameters.\nDocuments are listed in Ascending order.\nThe Paging limit refers to the number fo document versions, not the number\nof unique Document IDs.",
"example": {
"docs": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"page": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
}
],
"example": {
"docs": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"page": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"400": {
"description": "## Bad Request\n\nThe client has not sent valid request, could be an invalid HTTP in general or\nprovided not correct headers, path or query arguments.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"401": {
"description": "## Unauthorized\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"403": {
"description": "## Forbidden\n\nThe client has not sent valid authentication credentials for the requested\nresource.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"404": {
"description": "## Not Found\n\nNo documents were found which match the query filter.",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"412": {
"description": "## Precondition Failed\n\nThe client has not sent valid data in its request, headers, parameters or body.",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/PreconditionFailed"
}
}
},
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
},
"414": {
"description": "## URI Too Long\n\nThe client sent a request with the URI is longer than the server is willing to\ninterpret",
"headers": {
"Access-Control-Allow-Origin": {
"description": "Access-Control-Allow-Origin Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "origin",
"title": "Access-Control-Allow-Origin header.",
"description": "Valid formats:\n\n* `Access-Control-Allow-Origin: *`\n* `Access-Control-Allow-Origin: <origin>`\n* `Access-Control-Allow-Origin: null`\n",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin",
"description": "MDB Web Docs - Access-Control-Allow-Origin"
},
"example": "*"
}
},
"RateLimit": {
"description": "RateLimit Header.",
"deprecated": false,
"schema": {
"type": "string",
"format": "rate-limit",
"title": "RateLimit HTTP header.",
"description": "Allows this server to advertise its quota policies and the current\nservice limits, thereby allowing clients to avoid being throttled.",
"externalDocs": {
"url": "https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/",
"description": "IETF Draft - RateLimit header fields for HTTP"
},
"example": "\"default\";q=100;w=10"
}
}
}
}
},
"security": [
{
"CatalystRBACSecurityScheme": []
},
{
"NoAuthorization": []
}
],
"operationId": "postDocumentV2"
}
}
},
"components": {
"schemas": {
"ContentErrorDetail": {
"type": "object",
"description": "Individual details of a single error that was detected with the content of the\nrequest.",
"properties": {
"loc": {
"type": "array",
"description": "The location of the error",
"items": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "This is an error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
},
"example": [
"An error has occurred, the details of the error are ..."
],
"maxItems": 10
},
"msg": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "The error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
},
"type": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "The type of error",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
}
},
"example": {
"loc": [
"body"
],
"msg": "Value is not a valid dict.",
"type": "type_error.dict"
}
},
"CurrentPage": {
"type": "object",
"description": "Current Page of data being returned.",
"required": [
"page",
"limit",
"remaining"
],
"properties": {
"page": {
"type": "integer",
"format": "u32",
"title": "Page",
"description": "The page number of the data.\nThe size of each page, and its offset within the complete data set is determined by the `limit` parameter.",
"default": 0,
"example": 5,
"maximum": 4294967295.0,
"minimum": 0.0
},
"limit": {
"type": "integer",
"format": "u32",
"title": "Limit",
"description": "The size `limit` of each `page` of results.\nDetermines the maximum amount of data that can be returned in a valid response.\n\nThis `limit` of records of data will always be returned unless there is less data to return \nthan allowed for by the `limit` and `page`.\n\n*Exceeding the `page`/`limit` of all available records will not return `404`, it will return an \nempty response.*",
"default": 100,
"example": 10,
"maximum": 100.0,
"minimum": 1.0
},
"remaining": {
"type": "integer",
"format": "u32",
"title": "Remaining",
"description": "The number of items remaining to be returned after this page.\nThis is the absolute number of items remaining, and not the number of Pages.",
"example": 16384,
"maximum": 4294967295.0,
"minimum": 0.0
}
},
"example": {
"limit": 10,
"page": 5,
"remaining": 16384
}
},
"DocumentIndexList": {
"type": "object",
"description": "A single page of documents.\n\nThe page limit is defined by the number of document versions,\nnot the number of Document IDs.",
"required": [
"docs",
"page"
],
"properties": {
"docs": {
"type": "array",
"description": "List of documents that matched the filter.\n\nDocuments are listed in ascending order.",
"items": {
"title": "Individual Indexed Document",
"description": "An Individual Indexed Document and its Versions.\nDocument Versions are listed in Ascending order.",
"allOf": [
{
"$ref": "#/components/schemas/IndexedDocument"
},
{
"title": "Individual Indexed Document",
"description": "An Individual Indexed Document and its Versions.\nDocument Versions are listed in Ascending order.",
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
}
],
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
},
"example": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"maxItems": 4294967295
},
"page": {
"title": "The Page of Document Index List.",
"description": "Current Page",
"allOf": [
{
"$ref": "#/components/schemas/CurrentPage"
},
{
"title": "The Page of Document Index List.",
"example": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
],
"example": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
},
"example": {
"docs": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"page": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
},
"DocumentIndexListV2": {
"type": "object",
"description": "A single page of documents.\n\nThe page limit is defined by the number of document versions,\nnot the number of Document IDs.",
"required": [
"docs",
"page"
],
"properties": {
"docs": {
"type": "array",
"description": "List of documents that matched the filter.\n\nDocuments are listed in ascending order.",
"items": {
"title": "Individual Indexed Document",
"description": "An Individual Indexed Document and its Versions.\nDocument Versions are listed in Ascending order.",
"allOf": [
{
"$ref": "#/components/schemas/IndexedDocumentV2"
},
{
"title": "Individual Indexed Document",
"description": "An Individual Indexed Document and its Versions.\nDocument Versions are listed in Ascending order.",
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
}
],
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
},
"example": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"maxItems": 4294967295
},
"page": {
"title": "The Page of Document Index List.",
"description": "Current Page",
"allOf": [
{
"$ref": "#/components/schemas/CurrentPage"
},
{
"title": "The Page of Document Index List.",
"example": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
],
"example": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
},
"example": {
"docs": [
{
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
],
"page": {
"limit": 10,
"page": 5,
"remaining": 16384
}
}
},
"DocumentIndexQueryFilter": {
"type": "object",
"description": "Query Filter for the generation of a signed document index.\n\nThe Query works as a filter which acts like a sieve to filter out documents\nwhich do not strictly match the metadata or payload fields included in the query\nitself.",
"properties": {
"type": {
"type": "string",
"format": "uuid",
"title": "Signed Document Type",
"description": "## Signed Document Type.\n\nThe document type must match one of the\n[Registered Document Types](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/)\n\nUUIDv4 Formatted 128bit value.",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#type",
"description": "Specification"
},
"example": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"id": {
"title": "Document ID Selector",
"description": "## Document ID\n\nEither an absolute single Document ID or a range of\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedId"
},
{
"title": "Document ID Selector",
"description": "Either a absolute single Document ID or a range of Document IDs",
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"ver": {
"title": "Document Version Selector",
"description": "## Document Version\n\nEither an absolute single Document Version or a range of\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedVer"
},
{
"title": "Document Version Selector",
"description": "Either a absolute single Document Version or a range of Document Versions",
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"ref": {
"title": "Document Reference",
"description": "## Document Reference\n\nA [reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another signed document. This fields can match any reference that matches the\ndefined [Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nThe kind of document that the reference refers to is defined by the\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/)",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"template": {
"title": "Document Reference",
"description": "## Document Template\n\nDocuments that are created based on a template include the\n[template reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#template-template-reference)\nto another signed document. This fields can match any template reference that\nmatches the defined [Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nThe kind of document that the reference refers to is defined by the\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/)\nhowever, it will always be a template type document that matches the document\nitself.",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"reply": {
"title": "Document Reference",
"description": "## Document Reply\n\nThis is a\n[reply reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#reply-reply-reference)\nwhich links one document to another, when acting as a reply to it.\nReplies typically reference the same kind of document.\nThis fields can match any reply reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nThe kind of document that the reference refers to is defined by the\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"brand": {
"title": "Document Reference",
"description": "## Brand\n\nThis is a\n[brand reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#brand_id)\nto a brand document which defines the brand the document falls under.\nThis fields can match any brand reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nWhether a Document Type has a brand reference is defined by its\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"campaign": {
"title": "Document Reference",
"description": "## Campaign\n\nThis is a\n[campaign reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#campaign_id)\nto a campaign document which defines the campaign the document falls under.\nThis fields can match any campaign reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nWhether a Document Type has a campaign reference is defined by its\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"category": {
"title": "Document Reference",
"description": "## Category\n\nThis is a\n[category reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#category_id)\nto a category document which defines the category the document falls under.\nThis fields can match any category reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nWhether a Document Type has a category reference is defined by its\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
},
"example": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"ref": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"reply": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"template": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"DocumentIndexQueryFilterV2": {
"type": "object",
"description": "Query Filter for the generation of a signed document index.\n\nThe Query works as a filter which acts like a sieve to filter out documents\nwhich do not strictly match the metadata or payload fields included in the query\nitself.",
"properties": {
"type": {
"type": "array",
"description": "## Signed Document Type.\n\nThe document type must match one of the\n[Registered Document Types](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/)\n\nUUIDv4 Formatted 128bit value.",
"items": {
"type": "string",
"format": "uuid",
"title": "Signed Document Type",
"description": "Document Type. UUIDv4 Formatted 128bit value.",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#type",
"description": "Specification"
},
"example": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"example": [
"7808d2ba-d511-40af-84e8-c0d1625fdfdc"
],
"maxItems": 10
},
"id": {
"type": "array",
"description": "## Document ID\n\nEither an absolute single Document ID or a range of\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)",
"items": {
"title": "Document ID Selector",
"description": "Either a absolute single Document ID or a range of Document IDs",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedId"
},
{
"title": "Document ID Selector",
"description": "Either a absolute single Document ID or a range of Document IDs",
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"example": [
{
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 10
},
"ver": {
"type": "array",
"description": "## Document Version\n\nEither an absolute single Document Version or a range of\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)",
"items": {
"title": "Document Version Selector",
"description": "Either a absolute single Document Version or a range of Document Versions",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedVer"
},
{
"title": "Document Version Selector",
"description": "Either a absolute single Document Version or a range of Document Versions",
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"example": [
{
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
],
"maxItems": 10
},
"ref": {
"type": "array",
"description": "## Document Reference\n\nA [reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another signed document. This fields can match any reference that matches the\ndefined [Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nThe kind of document that the reference refers to is defined by the\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/)",
"items": {
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"example": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"maxItems": 10
},
"template": {
"type": "array",
"description": "## Document Template\n\nDocuments that are created based on a template include the\n[template reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#template-template-reference)\nto another signed document. This fields can match any template reference that\nmatches the defined [Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nThe kind of document that the reference refers to is defined by the\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/)\nhowever, it will always be a template type document that matches the document\nitself.",
"items": {
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"example": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"maxItems": 10
},
"reply": {
"type": "array",
"description": "## Document Reply\n\nThis is a\n[reply reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#reply-reply-reference)\nwhich links one document to another, when acting as a reply to it.\nReplies typically reference the same kind of document.\nThis fields can match any reply reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nThe kind of document that the reference refers to is defined by the\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"items": {
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"example": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"maxItems": 10
},
"brand": {
"type": "array",
"description": "## Brand\n\nThis is a\n[brand reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#brand_id)\nto a brand document which defines the brand the document falls under.\nThis fields can match any brand reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nWhether a Document Type has a brand reference is defined by its\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"items": {
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"example": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"maxItems": 10
},
"campaign": {
"type": "array",
"description": "## Campaign\n\nThis is a\n[campaign reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#campaign_id)\nto a campaign document which defines the campaign the document falls under.\nThis fields can match any campaign reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nWhether a Document Type has a campaign reference is defined by its\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"items": {
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"example": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"maxItems": 10
},
"category": {
"type": "array",
"description": "## Category\n\nThis is a\n[category reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#category_id)\nto a category document which defines the category the document falls under.\nThis fields can match any category reference that matches the defined\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id)\nand/or\n[Document Versions](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver)\n\nWhether a Document Type has a category reference is defined by its\n[Document Type](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/).",
"items": {
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"allOf": [
{
"$ref": "#/components/schemas/IdAndVerRef"
},
{
"title": "Document Reference",
"description": "A Signed Documents\n[Reference](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/meta/#ref-document-reference)\nto another Documents ID and/or Version.\n\n*Note: at least one of `id` or `ver` must be defined.*",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
},
"example": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"maxItems": 10
}
},
"example": {
"brand": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"id": [
{
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"ref": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"reply": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"template": [
{
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"type": [
"7808d2ba-d511-40af-84e8-c0d1625fdfdc"
],
"ver": [
{
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
]
}
},
"DocumentReference": {
"type": "object",
"description": "A Reference to another Signed Document",
"required": [
"id",
"ver"
],
"properties": {
"id": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "Document ID Reference",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ver": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "Document Version",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"DocumentReferenceV2": {
"type": "object",
"description": "A Reference to another Signed Document",
"required": [
"id",
"ver"
],
"properties": {
"id": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "Document ID Reference",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ver": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "Document Version",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"cid": {
"type": "string",
"format": "cidv0 || cidv1b32 || cidv1b36",
"title": "Signed Document Locator",
"description": "Document Locator",
"externalDocs": {
"url": "https://docs.ipfs.tech/concepts/content-addressing",
"description": "Content Identifiers (CIDs) | IPFS Docs"
},
"example": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"maxLength": 66,
"minLength": 2,
"pattern": "^(Qm[1-9A-HJ-NP-Za-km-z]{44})|(b[a-z2-7]{58})|([kK][0-9a-zA-Z]+)$"
}
},
"example": {
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"EqOrRangedId": {
"type": "object",
"description": "Either a Single Document ID, or a Range of Document IDs",
"oneOf": [
{
"title": "ID Equals",
"description": "A specific single\n[Document ID](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id).",
"allOf": [
{
"$ref": "#/components/schemas/IdEq"
},
{
"title": "ID Equals",
"description": "A specific single\n[Document ID](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id).",
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
{
"title": "ID Range",
"description": "A range of\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id).",
"allOf": [
{
"$ref": "#/components/schemas/IdRange"
},
{
"title": "ID Range",
"description": "A range of\n[Document IDs](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id).",
"example": {
"max": "01944e87-e68c-7fff-bfff-ffffffffffff",
"min": "01944e87-e68c-7000-8000-000000000000"
}
}
],
"example": {
"max": "01944e87-e68c-7fff-bfff-ffffffffffff",
"min": "01944e87-e68c-7000-8000-000000000000"
}
}
]
},
"EqOrRangedVer": {
"type": "object",
"description": "Document or Range of Documents\n\nEither a Single Document Version, or a Range of Document Versions",
"oneOf": [
{
"title": "Version Equals",
"description": "A specific single\n[Document Version](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver).",
"allOf": [
{
"$ref": "#/components/schemas/VerEq"
},
{
"title": "Version Equals",
"description": "A specific single\n[Document Version](https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver).",
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
{
"title": "Version Range",
"description": "A range of [Document Versions]().",
"allOf": [
{
"$ref": "#/components/schemas/VerRange"
},
{
"title": "Version Range",
"description": "A range of [Document Versions]().",
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
]
},
"Forbidden": {
"type": "object",
"description": "The client has not sent valid authentication credentials for the requested\nresource.",
"required": [
"id",
"msg"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Error Unique ID",
"description": "Unique ID of this Server Error so that it can be located easily for debugging.",
"example": "f51ffc58-337e-456e-8236-ff0c9176bfad"
},
"msg": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
},
"required": {
"type": "array",
"description": "List or Roles required to access the resource.",
"items": {
"type": "string",
"maxLength": 100,
"pattern": "^[0-9a-zA-Z].*$"
},
"example": [
"VOTER",
"PROPOSER"
],
"maxItems": 100
}
},
"example": {
"id": "7f75890e-7f7f-47a6-8e64-ebbf7f3b2659",
"msg": "Your request was not successful because your authentication credentials do not have the required roles for the requested resource.",
"required": [
"VOTER",
"PROPOSER"
]
}
},
"FullStakeInfo": {
"type": "object",
"description": "Full user's cardano stake info.",
"required": [
"volatile",
"persistent"
],
"properties": {
"volatile": {
"title": "Volatile stake information.",
"description": "Volatile stake information.",
"allOf": [
{
"$ref": "#/components/schemas/StakeInfo"
},
{
"title": "Volatile stake information.",
"example": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
}
}
],
"example": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
}
},
"persistent": {
"title": "Persistent stake information.",
"description": "Persistent stake information.",
"allOf": [
{
"$ref": "#/components/schemas/StakeInfo"
},
{
"title": "Persistent stake information.",
"example": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
}
}
],
"example": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
}
}
},
"example": {
"persistent": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
},
"volatile": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
}
}
},
"IdAndVerRef": {
"type": "object",
"description": "Either a Single Document ID, or a Range of Document IDs",
"anyOf": [
{
"title": "Document ID Reference",
"description": "A Reference to the Document ID Only.\n\nThis will match any document that matches the defined Document ID only.\nThe Document Version is not considered, and will match any version.",
"allOf": [
{
"$ref": "#/components/schemas/IdRefOnly"
},
{
"title": "Document ID Reference",
"description": "A Reference to the Document ID Only.\n\nThis will match any document that matches the defined Document ID only.\nThe Document Version is not considered, and will match any version.",
"example": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
}
],
"example": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
},
{
"title": "Document Version Reference",
"description": "A Reference to the Document Version, and optionally also the Document ID.\n\nThis will match any document that matches the defined Document Version and if\nspecified the Document ID.\nIf the Document ID is not specified, then all documents that match the version will be\nreturned in the index.",
"allOf": [
{
"$ref": "#/components/schemas/VerRefWithOptionalId"
},
{
"title": "Document Version Reference",
"description": "A Reference to the Document Version, and optionally also the Document ID.\n\nThis will match any document that matches the defined Document Version and if\nspecified the Document ID.\nIf the Document ID is not specified, then all documents that match the version will be\nreturned in the index.",
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
],
"example": {
"ver": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
]
},
"IdEq": {
"type": "object",
"description": "A single Document IDs.",
"required": [
"eq"
],
"properties": {
"eq": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "The exact Document ID to match against.",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"IdRange": {
"type": "object",
"description": "A range of Document IDs.",
"required": [
"min",
"max"
],
"properties": {
"min": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "Minimum Document ID to find (inclusive)",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"max": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "Maximum Document ID to find (inclusive)",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"example": {
"max": "01944e87-e68c-7fff-bfff-ffffffffffff",
"min": "01944e87-e68c-7000-8000-000000000000"
}
},
"IdRefOnly": {
"type": "object",
"description": "A Reference to a Document ID/s and their version/s.",
"required": [
"id"
],
"properties": {
"id": {
"title": "Document ID Selector",
"description": "Document ID, or range of Document IDs",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedId"
},
{
"title": "Document ID Selector",
"description": "Either a absolute single Document ID or a range of Document IDs",
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
},
"example": {
"id": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
},
"IndexedDocument": {
"type": "object",
"description": "List of Documents that matched the filter",
"required": [
"id",
"ver"
],
"properties": {
"id": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "Document ID that matches the filter",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ver": {
"type": "array",
"description": "List of matching versions of the document.\n\nVersions are listed in ascending order.",
"items": {
"title": "Individual Document Version",
"description": "A Matching version of the document.\n\nMetadata fields which are not set in the document, are not included in the version\ninformation. used to filter documents based on those metadata fields.\nThis is equivalent to returning documents where those metadata fields either do not\nexist, or do exist, but have any value.",
"allOf": [
{
"$ref": "#/components/schemas/IndexedDocumentVersion"
},
{
"title": "Individual Document Version",
"description": "A Matching version of the document.\n\nMetadata fields which are not set in the document, are not included in the version\ninformation. used to filter documents based on those metadata fields.\nThis is equivalent to returning documents where those metadata fields either do not\nexist, or do exist, but have any value.",
"example": {
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"example": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 100
}
},
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
},
"IndexedDocumentV2": {
"type": "object",
"description": "List of Documents that matched the filter",
"required": [
"id",
"ver"
],
"properties": {
"id": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document ID",
"description": "Document ID that matches the filter",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#id",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ver": {
"type": "array",
"description": "List of matching versions of the document.\n\nVersions are listed in ascending order.",
"items": {
"title": "Individual Document Version",
"description": "A Matching version of the document.\n\nMetadata fields which are not set in the document, are not included in the version\ninformation. used to filter documents based on those metadata fields.\nThis is equivalent to returning documents where those metadata fields either do not\nexist, or do exist, but have any value.",
"allOf": [
{
"$ref": "#/components/schemas/IndexedDocumentVersionV2"
},
{
"title": "Individual Document Version",
"description": "A Matching version of the document.\n\nMetadata fields which are not set in the document, are not included in the version\ninformation. used to filter documents based on those metadata fields.\nThis is equivalent to returning documents where those metadata fields either do not\nexist, or do exist, but have any value.",
"example": {
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"example": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 100
}
},
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": [
{
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
]
}
},
"IndexedDocumentVersion": {
"type": "object",
"description": "List of Documents that matched the filter",
"required": [
"ver",
"type"
],
"properties": {
"ver": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "Document Version that matches the filter",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"type": {
"type": "string",
"format": "uuid",
"title": "Signed Document Type",
"description": "Document Type that matches the filter",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#type",
"description": "Specification"
},
"example": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ref": {
"title": "Document Reference for filtered Documents.",
"description": "Document Reference that matches the filter",
"allOf": [
{
"$ref": "#/components/schemas/DocumentReference"
},
{
"title": "Document Reference for filtered Documents.",
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"reply": {
"title": "Document Reference for filtered Documents.",
"description": "Document Reply Reference that matches the filter",
"allOf": [
{
"$ref": "#/components/schemas/DocumentReference"
},
{
"title": "Document Reference for filtered Documents.",
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"template": {
"title": "Document Reference for filtered Documents.",
"description": "Document Template Reference that matches the filter",
"allOf": [
{
"$ref": "#/components/schemas/DocumentReference"
},
{
"title": "Document Reference for filtered Documents.",
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"doc_parameters": {
"title": "Document Reference for filtered Documents.",
"description": "Document Parameter Reference that matches the filter",
"allOf": [
{
"$ref": "#/components/schemas/DocumentReference"
},
{
"title": "Document Reference for filtered Documents.",
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
},
"example": {
"ref": {
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
},
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"IndexedDocumentVersionV2": {
"type": "object",
"description": "List of Documents that matched the filter",
"required": [
"ver",
"type"
],
"properties": {
"ver": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "Document Version that matches the filter",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"type": {
"type": "string",
"format": "uuid",
"title": "Signed Document Type",
"description": "Document Type that matches the filter",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#type",
"description": "Specification"
},
"example": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ref": {
"type": "array",
"description": "Document Reference that matches the filter",
"items": {
"$ref": "#/components/schemas/DocumentReferenceV2"
},
"example": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 10
},
"reply": {
"type": "array",
"description": "Document Reply Reference that matches the filter",
"items": {
"$ref": "#/components/schemas/DocumentReferenceV2"
},
"example": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 10
},
"template": {
"type": "array",
"description": "Document Template Reference that matches the filter",
"items": {
"$ref": "#/components/schemas/DocumentReferenceV2"
},
"example": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 10
},
"doc_parameters": {
"type": "array",
"description": "Document Parameter Reference that matches the filter",
"items": {
"$ref": "#/components/schemas/DocumentReferenceV2"
},
"example": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"maxItems": 10
}
},
"example": {
"ref": [
{
"cid": "bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku",
"id": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
],
"type": "7808d2ba-d511-40af-84e8-c0d1625fdfdc",
"ver": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"InternalServerError": {
"type": "object",
"description": "An internal server error occurred.\n\n*The contents of this response should be reported to the projects issue tracker.*",
"required": [
"id",
"msg"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Error Unique ID",
"description": "Unique ID of this Server Error so that it can be located easily for debugging.",
"example": "c08193f2-bb5d-4990-90ec-defd426b19c8"
},
"msg": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
},
"issue": {
"type": "string",
"format": "url",
"title": "URL String",
"description": "A URL to report an issue.",
"example": "https://example.com/"
}
},
"example": {
"id": "2a2cf09d-38e1-4d0b-9870-e5c57e784ddc",
"issue": "https://github.com/input-output-hk/catalyst-voices/issues/new?template=bug_report.yml&title=Internal+Server+Error+-+2a2cf09d-38e1-4d0b-9870-e5c57e784ddc",
"msg": "Internal Server Error. Please report the issue to the service owner."
}
},
"Network": {
"type": "string",
"description": "Cardano network type.",
"enum": [
"mainnet",
"preprod",
"preview"
]
},
"PreconditionFailed": {
"type": "object",
"description": "The client has not sent valid data in its request, headers, parameters or body.",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "array",
"description": "Details of each error in the content that was detected.\n\nNote: This may not be ALL errors in the content, as validation of content can stop\nat any point an error is detected.",
"items": {
"$ref": "#/components/schemas/ContentErrorDetail"
},
"example": [
{
"loc": [
"body"
],
"msg": "Value is not a valid dict.",
"type": "type_error.dict"
}
],
"maxItems": 1000,
"minItems": 1
}
},
"example": {
"detail": [
{
"loc": [
"body"
],
"msg": "Value is not a valid dict.",
"type": "type_error.dict"
}
]
}
},
"PutDocumentUnprocessableContent": {
"type": "object",
"description": "Put Document Validation Error.",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error messages.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
},
"report": {
"type": "object",
"description": "Error report JSON object.",
"example": {}
}
},
"example": {
"error": "Missing Document in request body",
"report": {}
}
},
"RbacRegistrationChain": {
"type": "object",
"description": "A chain of valid RBAC registrations.\n\nA unified data of multiple RBAC registrations.",
"required": [
"catalyst_id",
"purpose",
"roles"
],
"properties": {
"catalyst_id": {
"type": "string",
"format": "catalyst_id",
"title": "Catalyst ID",
"description": "A Catalyst ID.",
"example": "preprod.cardano/11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo",
"pattern": ".+\\/[A-Za-z0-9_-]{43}"
},
"last_persistent_txn": {
"type": "string",
"format": "hex:hash(32)",
"title": "Transaction Id/Hash",
"description": "An ID of the last persistent transaction.",
"example": "0x27d0350039fb3d068cccfae902bf2e72583fc553e0aafb960bd9d76d5bff777b",
"maxLength": 66,
"minLength": 66,
"pattern": "^0x[A-Fa-f0-9]{64}$"
},
"last_volatile_txn": {
"type": "string",
"format": "hex:hash(32)",
"title": "Transaction Id/Hash",
"description": "An ID of the last volatile transaction.",
"example": "0x27d0350039fb3d068cccfae902bf2e72583fc553e0aafb960bd9d76d5bff777b",
"maxLength": 66,
"minLength": 66,
"pattern": "^0x[A-Fa-f0-9]{64}$"
},
"purpose": {
"type": "array",
"description": "A list of registration purposes.",
"items": {
"type": "string",
"format": "uuid",
"title": "UUIDv4",
"description": "128 Bit UUID Version 4 - Random",
"example": "c9993e54-1ee1-41f7-ab99-3fdec865c744",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"example": [
"c9993e54-1ee1-41f7-ab99-3fdec865c744"
],
"maxItems": 10000,
"minItems": 1
},
"roles": {
"type": "object",
"format": "map",
"title": "RBAC role data map",
"description": "A map of role number to role data.",
"example": {
"0": {
"encryption_keys": [
{
"is_persistent": true,
"key_type": "x509",
"key_value": "0x56CDD154355E078A0990F9E633F9553F7D43A68B2FF9BEF78B9F5C71C808A7C8",
"time": "2024-04-09T15:28:21+00:00"
}
],
"extended_data": {
"10": [
1,
2,
3
]
},
"payment_addresses": [
{
"address": "addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3n0d3vllmyqwsx5wktcd8cc3sq835lu7drv2xwl2wywfgs68faae",
"is_persistent": true,
"time": "2024-04-09T15:28:21+00:00"
}
],
"signing_keys": [
{
"is_persistent": true,
"key_type": "x509",
"key_value": "0x56CDD154355E078A0990F9E633F9553F7D43A68B2FF9BEF78B9F5C71C808A7C8",
"time": "2024-04-09T15:28:21+00:00"
}
]
}
}
}
},
"example": {
"catalyst_id": "preprod.cardano/11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo",
"last_persistent_txn": "0x27d0350039fb3d068cccfae902bf2e72583fc553e0aafb960bd9d76d5bff777b",
"last_volatile_txn": "0x27d0350039fb3d068cccfae902bf2e72583fc553e0aafb960bd9d76d5bff777b",
"purpose": [
"c9993e54-1ee1-41f7-ab99-3fdec865c744"
],
"roles": {
"0": {
"encryption_keys": [
{
"is_persistent": true,
"key_type": "x509",
"key_value": "0x56CDD154355E078A0990F9E633F9553F7D43A68B2FF9BEF78B9F5C71C808A7C8",
"time": "2024-04-09T15:28:21+00:00"
}
],
"extended_data": {
"10": [
1,
2,
3
]
},
"payment_addresses": [
{
"address": "addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3n0d3vllmyqwsx5wktcd8cc3sq835lu7drv2xwl2wywfgs68faae",
"is_persistent": true,
"time": "2024-04-09T15:28:21+00:00"
}
],
"signing_keys": [
{
"is_persistent": true,
"key_type": "x509",
"key_value": "0x56CDD154355E078A0990F9E633F9553F7D43A68B2FF9BEF78B9F5C71C808A7C8",
"time": "2024-04-09T15:28:21+00:00"
}
]
}
}
}
},
"RbacUnprocessableContent": {
"type": "object",
"description": "Rbac Registration Validation Error.",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
}
},
"example": {
"error": "Invalid request query parameters"
}
},
"ServiceUnavailable": {
"type": "object",
"description": "The service is not available, try again later.\n\n*This is returned when the service either has not started,\nor has become unavailable.*",
"required": [
"id",
"msg"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Error Unique ID",
"description": "Unique ID of this Server Error so that it can be located easily for debugging.",
"example": "8677f5cb-4107-458c-9b57-353e61da592d"
},
"msg": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
}
},
"example": {
"id": "ba02671d-2d64-4e42-b978-d22e82decded",
"msg": "Service Unavailable. Indicates that the server is not ready to handle the request."
}
},
"StakeInfo": {
"type": "object",
"description": "User's cardano stake info.",
"required": [
"ada_amount",
"slot_number",
"assets"
],
"properties": {
"ada_amount": {
"type": "integer",
"format": "u64",
"title": "Cardano Blockchain ADA coins value",
"description": "Total stake amount.",
"example": 1234567,
"maximum": 1.8446744073709552e19,
"minimum": 0.0
},
"slot_number": {
"type": "integer",
"format": "u64",
"title": "Cardano Blockchain Slot Number",
"description": "Block's slot number which contains the latest unspent UTXO.",
"example": 1234567,
"maximum": 9.223372036854776e18,
"minimum": 0.0
},
"assets": {
"type": "array",
"description": "TXO assets infos.",
"items": {
"$ref": "#/components/schemas/StakedTxoAssetInfo"
},
"example": [
{
"amount": 1234567,
"asset_name": "My Cool\nAsset",
"policy_hash": "0x8eee77e5894c22268d5d12e6484ba713e7ddd595abba308d88d36943"
}
],
"maxItems": 1000
}
},
"example": {
"ada_amount": 1234567,
"assets": [],
"slot_number": 1234567
}
},
"StakedTxoAssetInfo": {
"type": "object",
"description": "User's staked txo asset info.",
"required": [
"policy_hash",
"asset_name",
"amount"
],
"properties": {
"policy_hash": {
"type": "string",
"format": "hex:hash(28)",
"title": "28 Byte Hash",
"description": "Asset policy hash (28 bytes).",
"example": "0x8eee77e5894c22268d5d12e6484ba713e7ddd595abba308d88d36943",
"maxLength": 58,
"minLength": 58,
"pattern": "^0x[A-Fa-f0-9]{56}$"
},
"asset_name": {
"type": "string",
"format": "cardano:asset_name",
"title": "Cardano Native Asset Name",
"description": "Token policies Asset Name.",
"example": "My Cool\nAsset",
"maxLength": 128,
"minLength": 0,
"pattern": "^[\\S\\s]{0,128}$"
},
"amount": {
"type": "integer",
"format": "i128",
"title": "Cardano native Asset Value",
"description": "Token Asset Value.",
"example": 1234567,
"maximum": 9.223372036854776e18,
"minimum": -9.223372036854776e18
}
},
"example": {
"amount": 1234567,
"asset_name": "My Cool\nAsset",
"policy_hash": "0x8eee77e5894c22268d5d12e6484ba713e7ddd595abba308d88d36943"
}
},
"TooManyRequests": {
"type": "object",
"description": "The client has sent too many requests in a given amount of time.",
"required": [
"id",
"msg"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Error Unique ID",
"description": "Unique ID of this Server Error so that it can be located easily for debugging.",
"example": "d24690f8-b6b9-4757-b1f2-3c6f44ba1759"
},
"msg": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
}
},
"example": {
"id": "6a2329ec-cf9b-453b-a342-946f9849e92f",
"msg": "Too Many Requests. You have exceeded the rate limit for this endpoint."
}
},
"Unauthorized": {
"type": "object",
"description": "The client has not sent valid authentication credentials for the requested\nresource.",
"required": [
"id",
"msg"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Error Unique ID",
"description": "Unique ID of this Server Error so that it can be located easily for debugging.",
"example": "37474aa3-c78f-4cda-ad06-44d288901bfc"
},
"msg": {
"type": "string",
"format": "error",
"title": "Error Message",
"description": "Error message.",
"example": "An error has occurred, the details of the error are ...",
"maxLength": 60000,
"minLength": 1,
"pattern": "^(.){1,60000}$"
}
},
"example": {
"id": "35e4570e-7cd5-4409-96aa-1a916c184729",
"msg": "Your request was not successful because it lacks valid authentication credentials for the requested resource."
}
},
"VerEq": {
"type": "object",
"description": "A single Document IDs.",
"required": [
"eq"
],
"properties": {
"eq": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "The exact Document ID to match against.",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"VerRange": {
"type": "object",
"description": "Version Range\n\nA Range of document versions from minimum to maximum inclusive.",
"required": [
"min",
"max"
],
"properties": {
"min": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "Minimum Document Version to find (inclusive)",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"max": {
"type": "string",
"format": "uuidv7",
"title": "Signed Document Version",
"description": "Maximum Document Version to find (inclusive)",
"externalDocs": {
"url": "https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/spec/#ver",
"description": "Specification"
},
"example": "01944e87-e68c-7f22-9df1-816863cfa5ff",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
},
"VerRefWithOptionalId": {
"type": "object",
"description": "A Reference to a Document ID/s and their version/s.",
"required": [
"ver"
],
"properties": {
"id": {
"title": "Document ID Selector",
"description": "Document ID, or range of Document IDs",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedId"
},
{
"title": "Document ID Selector",
"description": "Either a absolute single Document ID or a range of Document IDs",
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
}
],
"example": {
"eq": "01944e87-e68c-7f22-9df1-816863cfa5ff"
}
},
"ver": {
"title": "Document Version Selector",
"description": "Document Version, or Range of Document Versions",
"allOf": [
{
"$ref": "#/components/schemas/EqOrRangedVer"
},
{
"title": "Document Version Selector",
"description": "Either a absolute single Document Version or a range of Document Versions",
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
],
"example": {
"max": "01944e87-e68c-7f22-9df1-000000000000",
"min": "01944e87-e68c-7f22-9df1-ffffffffffff"
}
}
}
}
},
"securitySchemes": {
"CatalystRBACSecurityScheme": {
"type": "http",
"description": "Catalyst RBAC Access Token",
"scheme": "bearer",
"bearerFormat": "catalyst-rbac-token"
},
"NoAuthorization": {
"type": "http",
"description": "Endpoint can be used without any authorization.",
"scheme": "none"
}
}
}
}