Vacuum · Example Payload

Vacuum Ruleset Example

Example Vacuum/Spectral ruleset for enforcing API design standards

API DesignDocumentationLintingOpenAPISpectralDeveloper ToolsGo

Vacuum Ruleset Example is an example object payload from Vacuum, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionexample

Example Payload

{
  "description": "Example Vacuum/Spectral ruleset for enforcing API design standards",
  "example": {
    "extends": ["spectral:oas"],
    "rules": {
      "operation-must-have-summary": {
        "description": "All operations must have a summary",
        "message": "Operation must have a summary field",
        "severity": "error",
        "given": "$.paths[*][get,post,put,delete,patch]",
        "then": {
          "function": "truthy",
          "field": "summary"
        }
      },
      "operation-tags-required": {
        "description": "All operations must have at least one tag",
        "message": "Operations should be tagged",
        "severity": "warn",
        "given": "$.paths[*][get,post,put,delete,patch]",
        "then": {
          "function": "truthy",
          "field": "tags"
        }
      },
      "path-kebab-case": {
        "description": "Path segments should use kebab-case",
        "message": "Path segments should be kebab-case",
        "severity": "warn",
        "given": "$.paths[*]~",
        "then": {
          "function": "pattern",
          "functionOptions": {
            "match": "^(/[a-z0-9-{}/]+)*$"
          }
        }
      }
    }
  }
}