Get OpenAPI document

GET/v1/openapi.json

Download the full API description (OpenAPI) to generate a client or hand to an agent.

Authentication

None · REST guide

Operation ID

getOpenApiDocument

Parameters

Headers

X-Correlation-IDCorrelationId

Optional caller correlation identifier propagated to the response.

• Minimum length 1
• Maximum length 128
• Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

If-None-MatchEntityTag

Previously returned generated-document ETag for a conditional read.

• Maximum length 130
• Pattern ^"[A-Za-z0-9][A-Za-z0-9._~:/+-]*"$

Request body

No request body.

Responses

200Generated OpenAPI 3.1 document

application/vnd.oai.openapi+jsonobject

3 response headers

ETagEntityTagRequired

Strong generated-document entity tag.

• Maximum length 130
• Pattern ^"[A-Za-z0-9][A-Za-z0-9._~:/+-]*"$

X-Correlation-IDCorrelationIdRequired

Correlation identifier shared by related operations.

• Minimum length 1
• Maximum length 128
• Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

X-Request-IDRequestIdRequired

Request identifier for this response.

• Minimum length 1
• Maximum length 128
• Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

304The generated document matches If-None-Match.

3 response headers

ETagEntityTagRequired

Strong generated-document entity tag.

• Maximum length 130
• Pattern ^"[A-Za-z0-9][A-Za-z0-9._~:/+-]*"$

X-Correlation-IDCorrelationIdRequired

Correlation identifier shared by related operations.

• Minimum length 1
• Maximum length 128
• Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

X-Request-IDRequestIdRequired

Request identifier for this response.

• Minimum length 1
• Maximum length 128
• Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

Operation contract

The operation exactly as it appears in the generated contract. References resolve within the OpenAPI document.

Show raw OpenAPI for getOpenApiDocument

{
  "operationId": "getOpenApiDocument",
  "parameters": [
    {
      "description": "Optional caller correlation identifier propagated to the response.",
      "in": "header",
      "name": "X-Correlation-ID",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/CorrelationId"
      }
    },
    {
      "description": "Previously returned generated-document ETag for a conditional read.",
      "in": "header",
      "name": "If-None-Match",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/EntityTag"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/vnd.oai.openapi+json": {
          "schema": {
            "type": "object"
          }
        }
      },
      "description": "Generated OpenAPI 3.1 document",
      "headers": {
        "ETag": {
          "description": "Strong generated-document entity tag.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/EntityTag"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "304": {
      "description": "The generated document matches If-None-Match.",
      "headers": {
        "ETag": {
          "description": "Strong generated-document entity tag.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/EntityTag"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    }
  },
  "security": [],
  "summary": "Read the generated SignalSitter V1 OpenAPI document",
  "tags": [
    "API metadata"
  ]
}