Skip to content
HALOWERK

Codewerk

yamllint

Runs yamllint 1.38.0 (GPL-3.0) from a hash-pinned private Python environment in an isolated child process without network, with a configuration built only from the documented rules (anchors, braces, brackets, colons, commas, comments, document-start/end, empty-lines, empty-values, float-values, hyphens, indentation, key-duplicates, key-ordering, line-length, new-lines, octal-values, quoted-strings, trailing-spaces, truthy). Rules can be disabled, enabled or given options; file-reading.

POST https://code.halowerk.com/v1/yamllint

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
yamlstringYesYAML text (max. 1 MB).
presetstringNoyamllint built-in configuration to extend.
rulesobjectNoPer-rule overrides, e.g. {"line-length": {"max": 120}, "document-start": "disable"}.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "yaml"
  ],
  "properties": {
    "yaml": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000000,
      "description": "YAML text (max. 1 MB)."
    },
    "preset": {
      "type": "string",
      "enum": [
        "default",
        "relaxed"
      ],
      "default": "default",
      "description": "yamllint built-in configuration to extend."
    },
    "rules": {
      "type": "object",
      "maxProperties": 23,
      "propertyNames": {
        "enum": [
          "anchors",
          "braces",
          "brackets",
          "colons",
          "commas",
          "comments",
          "comments-indentation",
          "document-end",
          "document-start",
          "empty-lines",
          "empty-values",
          "float-values",
          "hyphens",
          "indentation",
          "key-duplicates",
          "key-ordering",
          "line-length",
          "new-line-at-end-of-file",
          "new-lines",
          "octal-values",
          "quoted-strings",
          "trailing-spaces",
          "truthy"
        ]
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "enable",
              "disable"
            ]
          },
          {
            "type": "object",
            "maxProperties": 12,
            "propertyNames": {
              "pattern": "^[a-z][a-z-]{0,40}$",
              "not": {
                "enum": [
                  "ignore",
                  "ignore-from-file"
                ]
              }
            },
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 200
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "array",
                  "maxItems": 50,
                  "items": {
                    "type": [
                      "string",
                      "number",
                      "boolean"
                    ]
                  }
                }
              ]
            }
          }
        ]
      },
      "description": "Per-rule overrides, e.g. {\"line-length\": {\"max\": 120}, \"document-start\": \"disable\"}."
    }
  }
}

Open original schema

Published input example

{
  "yaml": "a: 1\nb:   yes\nc: [1,2]  \nkey: 1\nkey: 2\n",
  "rules": {
    "document-start": "disable"
  }
}

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 โ†’