LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
redocly-cli/docs/rules/spec-components-invalid-map-name.md
Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334)
2023-11-17 09:45:03 +00:00

2.2 KiB
Raw Permalink Blame History

slug
slug
/docs/cli/rules/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 ✅ 
flowchart TD

Root ==> Components -->  NamedExamples

Components ==> NamedResponses
Components ==> NamedSchemas
Components ==> NamedParameters
Components ==> NamedRequestBodies --> RequestBody
Components ==> NamedHeaders
Components ==> NamedSecuritySchemes
Components ==> NamedLinks
Components ==> NamedCallbacks
Components ==> 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:

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

Resources