{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"spec-components-invalid-map-name","__idx":0},"children":["spec-components-invalid-map-name"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires that specific objects inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components"]}," MUST use keys that match the regular expression: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[a-zA-Z0-9\\.\\-_]+$"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"OAS"},"children":["OAS"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Compatibility"},"children":["Compatibility"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3.1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]}]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n\nRoot ==> Components --> NamedExamples\n\nComponents ==> NamedResponses\nComponents ==> NamedSchemas\nComponents ==> NamedParameters\nComponents ==> NamedRequestBodies --> RequestBody\nComponents ==> NamedHeaders\nComponents ==> NamedSecuritySchemes\nComponents ==> NamedLinks\nComponents ==> NamedCallbacks\nComponents ==> NamedPathItems\n","diagramHtml":"

Root

Components

NamedExamples

NamedResponses

NamedSchemas

NamedParameters

NamedRequestBodies

RequestBody

NamedHeaders

NamedSecuritySchemes

NamedLinks

NamedCallbacks

NamedPathItems

","diagramHtmlDark":"

Root

Components

NamedExamples

NamedResponses

NamedSchemas

NamedParameters

NamedRequestBodies

RequestBody

NamedHeaders

NamedSecuritySchemes

NamedLinks

NamedCallbacks

NamedPathItems

"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-design-principles","__idx":1},"children":["API design principles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This rule is for spec correctness."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All the fixed fields declared below are objects that MUST use keys that match the regular expression: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["^[a-zA-Z0-9\\.\\-_]+$"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["schemas"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["responses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["parameters"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["examples"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["requestBodies"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["headers"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["securitySchemes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["links"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["callbacks"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["pathItems"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration","__idx":2},"children":["Configuration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["severity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},". Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," (in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recommended"]}," configuration)."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example configuration:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rules:\n spec-components-invalid-map-name: error\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":3},"children":["Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Given this configuration:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rules:\n spec-components-invalid-map-name: error\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["incorrect"]}," operation response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"components:\n examples:\n invalid identifier:\n description: invalid identifier\n value: 21\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["correct"]}," operation response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"components:\n examples:\n valid_identifier:\n description: valid identifier\n value: 21\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-rules","__idx":4},"children":["Related rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v1/rules/configurable-rules"},"children":["configurable rules"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v1/rules/oas/struct"},"children":["spec"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":5},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/oas3/spec-components-invalid-map-name.ts"},"children":["Rule source"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/components/"},"children":["Components docs"]}]}]}]},"frontmatter":{"slug":"/docs/cli/v1/rules/oas/spec-components-invalid-map-name"},"tagList":[],"title":"spec-components-invalid-map-name","lastModified":"2025-07-25T04:59:29.000Z"}