{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"no-schema-type-mismatch","__idx":0},"children":["no-schema-type-mismatch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ensures that a schema's structural properties match its declared ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},". In particular:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A schema of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must not"]}," include an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A schema of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["array"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must not"]}," include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," field."]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3.2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]}]}]}]},{"$$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":"AsyncAPI"},"children":["AsyncAPI"]},{"$$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.6"]},{"$$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":"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":"Arazzo"},"children":["Arazzo"]},{"$$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":["1.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]}]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n Schema -->|if type is object| CheckItems[\"'items' field exists?\"]\n Schema -->|if type is array| CheckProps[\"'properties' field exists?\"]\n","diagramHtml":"

if type is object

if type is array

Schema

'items' field exists?

'properties' field exists?

","diagramHtmlDark":"

if type is object

if type is array

Schema

'items' field exists?

'properties' field exists?

"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-design-principles","__idx":1},"children":["API design principles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When designing an API schema, the defined ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," should be consistent with its structure:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Objects"]}," are collections of key/value pairs. They should be defined using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," (or additionalProperties) and must not use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Arrays"]}," are ordered lists of items and must use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," to define their content. Including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," is invalid."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This rule helps catch typos and misconfigurations early in your API definition."]},{"$$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 is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," in the recommended configuration."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example configuration:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rules:\n no-schema-type-mismatch: error\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":3},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"incorrect-examples","__idx":4},"children":["Incorrect Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"object-type-with-an-items-field","__idx":5},"children":["Object type with an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," field"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"properties:\n user:\n type: object\n properties:\n id:\n type: string\n items:\n type: number\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Error:"]}," An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]}," type should not include an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," field."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"array-type-with-a-properties-field","__idx":6},"children":["Array type with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," field"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"properties:\n tags:\n type: array\n properties:\n name:\n type: string\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Error:"]}," An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["array"]}," type should not include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," field."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"correct-examples","__idx":7},"children":["Correct Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"object-type-with-proper-properties","__idx":8},"children":["Object type with proper ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"properties:\n user:\n type: object\n properties:\n id:\n type: string\n name:\n type: string\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"array-type-with-proper-items","__idx":9},"children":["Array type with proper ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"properties:\n tags:\n type: array\n items:\n type: string\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-rules","__idx":10},"children":["Related rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/common/no-enum-type-mismatch"},"children":["no-enum-type-mismatch"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/common/no-mixed-number-range-constraints"},"children":["no-mixed-number-range-constraints"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/common/no-required-schema-properties-undefined"},"children":["no-required-schema-properties-undefined"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/configurable-rules"},"children":["configurable rules"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/no-invalid-media-type-examples"},"children":["no-invalid-media-type-examples"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/no-invalid-parameter-examples"},"children":["no-invalid-parameter-examples"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/no-invalid-schema-examples"},"children":["no-invalid-schema-examples"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":11},"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/common/no-schema-type-mismatch.ts"},"children":["Rule source"]}]}]}]},"frontmatter":{"slug":"/docs/cli/rules/common/no-schema-type-mismatch"},"tagList":[],"title":"no-schema-type-mismatch","lastModified":"2026-03-23T12:28:34.000Z"}