Read the executable OpenAPI contract

Overview

Read the executable OpenAPI contract. The executable OpenAPI document is the machine-readable contract for every shipped HTTP operation.

When to use it

• Use it when an application needs to read the executable OpenAPI contract.
• Use it when a developer needs authoritative schemas for inspection, validation, or client generation.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/openapi.json" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "openapi": "string",
  "info": {
    "title": "string",
    "version": "string"
  },
  "paths": {}
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read the executable OpenAPI contract. The documented 200 response is openAPI 3.1 document generated from the executable route inventory.

How it works

Reference

Required capability

read

Authorization scope

held anywhere

{
  "openapi": "string",
  "info": {
    "title": "string",
    "version": "string"
  },
  "paths": {}
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/openapi.json`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);