spec-components-invalid-map-name

Requires that specific objects inside components MUST use keys that match the regular expression: ^[a-zA-Z0-9\.\-_]+$.

OAS Compatibility
2.0
3.0
3.1
Root
Components
NamedExamples
NamedResponses
NamedSchemas
NamedParameters
NamedRequestBodies
RequestBody
NamedHeaders
NamedSecuritySchemes
NamedLinks
NamedCallbacks
NamedPathItems

API design principles

This rule is for spec correctness.

All the fixed fields declared below are objects that MUST use keys that match the regular expression: ^[a-zA-Z0-9\.\-_]+$.

  • schemas
  • responses
  • parameters
  • examples
  • requestBodies
  • headers
  • securitySchemes
  • links
  • callbacks
  • pathItems

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

Copy
Copied
rules:
  spec-components-invalid-map-name: error

Examples

Given this configuration:

Copy
Copied
rules:
  spec-components-invalid-map-name: error

Example of incorrect operation response:

Copy
Copied
components:
  examples:
    invalid identifier:
      description: invalid identifier
      value: 21     

Example of correct operation response:

Copy
Copied
components:
  examples:
    valid_identifier:
      description: valid identifier
      value: 21 

Related rules

Resources