Endpoints / openapi

openapi

Liefert die OpenAPI-3-Spec der gesamten E-PAT-API

Single-Source-of-Truth fuer die API-Doku. Cache 1h via Redis, ETag-Header fuer Polling-Clients. format=yaml (default) oder json.

HTTP Request

POST https://dev.vitabyte.ch/v1/system/openapi

Auth basicAuth apiKey

Request Parameters

Parameter	Pflicht	Typ	Beispiel / Default
`format`	optional	string enum: yaml \| json	default: `yaml`

Response Parameters

Dieser Endpoint liefert das Spec-Dokument direkt — ohne Envelope: bei format=yaml als YAML, bei format=json als JSON. Die Antwort trägt einen ETag-Header; Polling-Clients senden If-None-Match und erhalten HTTP 304, solange sich die Spec nicht geändert hat. Serverseitig wird die Spec 1 Stunde gecacht.

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/system/openapi

Payload

{
    "format": "yaml"
}

Response

openapi: 3.0.0
info:
  title: 'E-PAT API'
  version: 1.0.0
servers:
  -
    url: 'https://{tenant}.vitabyte.ch/v1'
paths:
  /sales/getLeads:
    post:
      tags:
        - Sales
      summary: 'Liste der Leads mit Filter, Sortierung und Pagination'
      # … weitere Endpoints