Articles
Author
vacuum
Installing
Quick Start
About vacuum
Why?
Concepts
💥 Online Demo
FAQ
Ignoring Violations
Changelog
Configuring
VSCode Plugin
CLI Commands
Lint
vacuum Report
Dashboard
HTML Report
Spectral Report
References
Version
Bundle Spec
Generate RuleSet
Language Server
Developer API
API Quick Start
Spec Index
RuleResultSet
Loading RuleSet
Custom Go Functions
Custom JS Functions
Non-OpenAPI Files
Functions
Core Functions
OpenAPI Functions
OWASP Functions
Rules
Examples
OWASP
Operations/Paths
Schemas
Spec Information
Validation
Descriptions
Tags
Security
RuleSets
What are they?
Sharing RuleSets
No Rules/Off
Recommended Rules
Custom RuleSets
OWASP Rules
  • GitHub GitHub Repo stars
  • Discord Discord Server
    • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor

    OpenAPI Functions

    All vacuum OpenAPI built-in functions, designed specifically for OpenAPI 2 & 3.

    oasRefSiblings

    Ensure $ref properties contain approved sibling nodes

    infoContact

    Ensure that the info section contains a contact object.

    infoContactProperties

    Ensure name, url and email are defined in the contact object.

    infoDescription

    Ensure that the info section contains a description

    infoLicense

    Ensure that the info section contains a valid license.

    infoLicenseUrl

    Ensure that the info section contains a valid license url

    tagDescription

    Ensure that every tag object contains a description

    infoLicenseURLSPDX

    Ensure that either a url or identifier is defined in the license object, but not both.

    postResponseSuccess

    Checks that a specification is a valid OpenAPI schema

    schemaTypeCheck

    Check a schema passes a basic type and type validation check

    oasExampleExternalCheck

    Checks examples don’t use value and externalValue together.

    oasExampleMissing

    Checks examples are defined for each type that supports them.

    oasExampleSchema

    Checks examples match the schemas of the objects they represent.

    pathsKebabCase

    Ensures that paths follow kebab-case naming conventions.

    noVerbsInPath

    Check each verb for the presence of an HTTP verb

    ambiguousPaths

    Ensures that all paths are resolvable and don’t conflict

    oasOpErrorResponse

    Checks operations contain at least one 4xx HTTP responses.

    oasSchema

    Checks that a specification is a valid OpenAPI schema

    oasDiscriminator

    Check for the correct use of discriminator properties.

    oas2OpSecurityDefined

    Ensure operation security has been correct defined.

    oasOpSecurityDefined

    Ensure operation security has been correct defined.

    duplicatedEnum

    Ensure that enum values have not been duplicated

    oasUnusedComponent

    Unsure there are no unused components or definitions in the specification

    refSiblings

    Ensure $ref properties don’t have any sibling nodes

    oasDocumentSchema

    Checks a specification is a valid OpenAPI 2/3 schema.

    oas2PolymorphicOneOf

    Ensure Swagger specification has not used ‘oneOf’

    oas2PolymorphicAnyOf

    Ensure Swagger specification has not used ‘anyOf’

    oasOperationTags

    Checks an operation contains at least a single tag.

    oasOpFormDataConsumeCheck

    Checks that parameters using formData are consumed properly

    typedEnum

    Checks enum values match specified type

    oasAPIServers

    Checks OpenAPI servers are correctly defined

    oasComponentDescriptions

    Checks descriptions in components or definitions

    oasDescriptionDuplication

    Checks descriptions for duplicated content.

    oasParamDescriptions

    Checks parameter descriptions have been set.

    oasDescriptions

    Checks operation descriptions have been set, and meet a minimum word count.

    noEvalDescription

    Checks there are no descriptions using JavaScript eval() statements.

    oasExample

    Scans a specification for missing examples.

    oasOpId

    Checks that all operations have an operationId defined

    oasOpIdUnique

    Checks that all operations have an operationId defined

    oasOpParams

    Checks that all operations unique and non-repeating parameters

    oasOpSingleTag

    Checks operations only contain a single tag

    oasOpSuccessResponse

    Checks operations contain at least one 2xx or 3xx HTTP responses.

    oasPathParam

    Checks are using path parameters correctly..

    oasTagDefined

    Checks operations are using tags that are globally defined.