Zum Inhalt
HALOWERK

Modellwerk

openapi validate

Reads an OpenAPI 3.x document and reports what would stop a machine consumer. Errors: missing openapi, info or paths; a path that declares no method; an internal $ref that resolves to nothing; a parameter without a name, location or schema; a request body without content.

POST https://modell.halowerk.com/v1/openapi-validate

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
documentobjectJaThe OpenAPI document as JSON.
require_examplesbooleanNeinReport operations with no example as a warning.
require_operation_idsbooleanNeinReport operations without operationId as a warning.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "document"
  ],
  "additionalProperties": false,
  "properties": {
    "document": {
      "type": "object",
      "description": "The OpenAPI document as JSON."
    },
    "require_examples": {
      "type": "boolean",
      "default": true,
      "description": "Report operations with no example as a warning."
    },
    "require_operation_ids": {
      "type": "boolean",
      "default": true,
      "description": "Report operations without operationId as a warning."
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "document": {},
  "require_examples": true,
  "require_operation_ids": true
}

Ergebnis & Dokumentation

Veröffentlichtes Ergebnisschema anzeigen
{
  "$ref": "https://modell.halowerk.com/v1/openapi-validate/schema#/outputSchema"
}

Veröffentlichtes Ergebnisbeispiel öffnen

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →