Skip to content
HALOWERK

Codewerk

openapi style lint

Lints an OpenAPI document with @stoplight/spectral-core 1.24.0 and the built-in spectral:oas ruleset of @stoplight/spectral-rulesets 1.23.0. Findings carry rule, severity (error, warn, info, hint), JSON path and line/column. Rules can be switched off by name and findings filtered by minimum severity. External $refs are rejected before linting, so nothing is fetched; no custom rulesets are loaded.

POST https://code.halowerk.com/v1/openapi-style-lint

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
specSee schemaYesThe OpenAPI document as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.
disable_rulesarrayNoRule names to ignore, e.g. ["info-contact"].
min_severitystringNoReport findings of this severity or higher.
max_findingsintegerNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "spec"
  ],
  "properties": {
    "spec": {
      "description": "The OpenAPI document as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 2000000
        }
      ]
    },
    "disable_rules": {
      "type": "array",
      "maxItems": 60,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "maxLength": 80
      },
      "description": "Rule names to ignore, e.g. [\"info-contact\"]."
    },
    "min_severity": {
      "type": "string",
      "enum": [
        "error",
        "warn",
        "info",
        "hint"
      ],
      "default": "hint",
      "description": "Report findings of this severity or higher."
    },
    "max_findings": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "default": 300
    }
  }
}

Open original schema

Published input example

{
  "spec": "openapi: 3.0.3\ninfo: {title: Pets, version: \"1.0\"}\npaths:\n  /pets/:\n    get:\n      responses:\n        \"200\": {description: ok}\n",
  "min_severity": "warn"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’