spec-components-invalid-map-name.md

slug	/docs/cli/rules/oas/spec-components-invalid-map-name

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	✅
3.2	✅

flowchart TD

Root ==> Components -->  NamedExamples

Components ==> NamedResponses
Components ==> NamedSchemas
Components ==> NamedParameters
Components ==> NamedRequestBodies --> RequestBody
Components ==> NamedHeaders
Components ==> NamedSecuritySchemes
Components ==> NamedLinks
Components ==> NamedCallbacks
Components ==> NamedPathItems

Loading

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:

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

Examples

Given this configuration:

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

Example of incorrect operation response:

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

Example of correct operation response:

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

Related rules

• configurable rules
• struct

Resources

• Rule source
• Components docs