Skip to main content

OpenAPI document

note

Returns the full OpenAPI specification for this service as a JSON object. Useful for programmatic discovery of the API schema. No authentication is required.

Getting started​

URL REQUEST (GET)
https://engines.api.telmar.com/omg/prd/v1/docs

docs takes no parameters and no body. It does not require a Telmar-Engine-Authorizer header, and it is not billed.

Main parameters​

None.

Response — 200 OK​

FieldTypeDescription
(body)objectThe OpenAPI specification document in application/json format

Why call it​

  • Generate clients. Point your OpenAPI generator at this URL instead of a checked-in snapshot so you pick up contract changes automatically.
  • Confirm the live contract. Compare info.version and the listed operationId values against what your integration expects before a batch run.
  • Health probe. A 200 with a parseable OpenAPI body is a cheap liveness check that does not consume entitlements.

Let's go to examples​

OpenAPI specification as JSON​

GET/docs200 OKExample

Call this when you need the machine-readable OpenAPI document for this service — for example to feed a client generator or to confirm the live contract matches what you integrated against.

note

The response body is this service's OpenAPI document in JSON. No authorizer header is required. The payload below is abridged for readability.

URL REQUEST (GET)
GET https://engines.api.telmar.com/omg/prd/v1/docs
The same call as curl
curl -X GET 'https://engines.api.telmar.com/omg/prd/v1/docs' \
  -H 'Accept: application/json'
We will receive a json like this — 200 OK
{
  "openapi": "3.0.1",
  "info": {
    "title": "Explore API",
    "description": "TelmarHelixa Explore / Crosstab API.",
    "version": "1.0.0"
  },
  "paths": {
    "/docs": {
      "get": {
        "operationId": "docs"
      }
    },
    "/crosstab": {
      "post": {
        "operationId": "crosstab"
      },
      "options": {
        "operationId": "crosstabOptions"
      }
    }
  }
}