OpenAPI Functions

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


pathsKebabCase

Ensures that

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.