OpenAPI Validator

Overview

You send an OpenAPI 3.0.x or 3.1.x document as JSON or YAML, inline or as a file reference, and we tell you whether it holds together structurally. Every complaint the parser raises comes back as a message, split into errors and warnings, alongside the detected specification version, the API title, and how many operations the document declares. We read the document as written and never follow a $ref off to the network. To turn a good document into a list of operations, use schema.extract_openapi_operations. Accepts file input via file_ref — no need to extract file content first.

A structurally broken document breaks gateways, generators and docs quietly and far downstream. You find out here instead, in one call, before anyone builds on it.

When to use it

Scope

Non-goals

• We never list the operations for you — that is schema.extract_openapi_operations
• We never generate client or server code from the document
• We never follow a $ref off to another document or to the network

Properties

Capabilities

Cost & billing

Flat rate per invocation

File handling

File limits

Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.

How we handle your data

Input schema

Output schema

API contract

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"schema.validate_openapi","input":{"document":"openapi: 3.0.3\ninfo:\n  title: Billing API\n  version: 2.1.0\npaths: {}","maxErrors":50}}'

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("schema.validate_openapi", {"document":"openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths: {}"});

Errors

Other limits

Limitations

• We never list the operations for you — that is schema.extract_openapi_operations
• We never generate client or server code from the document
• We never follow a $ref off to another document or to the network
• Listing the operations a document declares (schema.extract_openapi_operations)
• Generating client libraries or server stubs
• Validating a plain JSON Schema, a CSV file, or any non-OpenAPI document

How to call

POST /v1/execute (requires authentication)

{
  "skillKey": "schema.validate_openapi",
  "input": {
    "document": "openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths: {}"
  }
}

Examples

{
  "document": "openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths: {}"
}

{
  "version": "3.0.3",
  "title": "Pet Store",
  "operationCount": 0,
  "errors": [],
  "valid": true,
  "warnings": [],
  "warningCount": 0,
  "errorCount": 0
}

{
  "document": "openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'",
  "maxErrors": 25
}

{
  "title": "Pet Store",
  "warningCount": 0,
  "valid": false,
  "version": "3.0.3",
  "errors": [
    {
      "message": "attribute paths is missing"
    }
  ],
  "errorCount": 1,
  "warnings": []
}

Recommended use cases

• Catch a broken API document before you publish it to a gateway or a catalog
• Gate a pipeline on the document staying structurally sound
• Sanity-check a document a partner sent you before you build anything on it

Avoid for

• Listing the operations a document declares (schema.extract_openapi_operations)
• Generating client libraries or server stubs
• Validating a plain JSON Schema, a CSV file, or any non-OpenAPI document

Related skills

Composable with

Safety & privacy

• Runs without calling any external service.
• Your payloads are never stored permanently.
• Telemetry captures metadata only — never your payload contents.
• We never train models on your payloads.
• No human reviews your payloads.

Tags