{"uid":"cap_NQ_KDA3_PjxjxcMQXm9VA","slug":"openapi-3-x-document-validator-78c92fa2","name":"OpenAPI 3.x Document Validator","description":"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.","url":"https://modell.halowerk.com/v1/openapi-validate","method":"POST","headers":{},"bodySchema":{"type":"object","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."}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.002","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.002/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.002","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.002","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_NdGS9uZQhwnWNlu-YyAAr","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.002","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Validates an OpenAPI 3.x document and reports structural errors that would prevent a machine consumer from parsing or using it correctly.","exampleAgentPrompt":"Can you validate this OpenAPI 3.x spec and tell me exactly what would prevent a machine from consuming it — like missing openapi or info fields, paths with no methods, unresolved $refs, parameters without names or schemas, and request bodies without content?","exampleUseCases":[{"title":"Pre-publish API spec sanity check","prompt":"Before I publish this OpenAPI spec to our developer portal, can you run it through the validator and tell me every structural error that would stop a client from generating an SDK from it?"},{"title":"CI pipeline spec linting","prompt":"I want to add a step to my CI pipeline that rejects any OpenAPI 3.x document with broken internal $refs or parameters missing their name, location, or schema — can you validate this spec and show me all the issues?"},{"title":"Debugging a broken MCP tool conversion","prompt":"I'm trying to convert my OpenAPI spec into MCP tools but the conversion keeps failing — can you validate the spec and pinpoint whether there are paths with no methods or request bodies missing content definitions?"}],"resultDescription":"A structured report listing each validation error found in the submitted OpenAPI 3.x document. Errors include: missing top-level fields (openapi, info, paths), paths declaring no HTTP method, internal $ref values that resolve to nothing, parameters missing name, location, or schema, and request bodies missing a content definition. A clean document returns no errors.","failureModes":["Submitting a non-OpenAPI document (e.g. JSON Schema or Swagger 2.x) may produce unexpected or misleading errors","Malformed JSON/YAML that cannot be parsed will fail before validation begins","Very large specifications may exceed request size limits","External $refs (URLs or file paths) are not resolved — only internal $refs are checked","Partial or truncated documents may produce incomplete error reports"],"whenToPreferThis":"Choose this endpoint when you need fast, machine-focused validation of an OpenAPI 3.x document — specifically to catch the structural errors that break API client generators, MCP converters, or other automated consumers. It is purpose-built to flag the exact issues (missing fields, broken $refs, incomplete parameters, empty request bodies) that cause downstream tooling failures, making it ideal as a pre-processing step before passing a spec to OpenAPI-to-MCP converters or schema comparison tools.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-14T18:43:38.350Z","isFirstParty":false}