{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"no-invalid-media-type-examples","__idx":0},"children":["no-invalid-media-type-examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Disallow invalid media type examples by ensuring they comply with the corresponding schema definitions."]},{"$$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":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n\nRoot ==> Paths --> PathItem --> Operation --> MediaType --> Example\n MediaType --> Examples --> Example\n\nRoot ==> components\n\nsubgraph components\nNamedExamples\nend\n\nNamedExamples --> Example\n\nstyle Example fill:#codaf9,stroke:#0044d4,stroke-width:5px\n","diagramHtml":"

components

Root

Paths

PathItem

Operation

MediaType

Example

Examples

NamedExamples

","diagramHtmlDark":"

components

Root

Paths

PathItem

Operation

MediaType

Example

Examples

NamedExamples

"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-design-principles","__idx":1},"children":["API design principles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\"Got examples?\" (One of the great advertising campaigns of the 1990s... or was that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["got milk?"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In any case, those examples should be valid if someone tries them out."," ","However, what are the odds they are valid if they clash with the schema defined? Very little."," ","Most likely there is either a mistake with the example or the schema (or both)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Trust us."," ","It's much nicer to get this alert from Redocly before you ship than from your biggest customer three months later."]},{"$$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":["warn"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["allowAdditionalProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines if additional properties are allowed in examples. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example configuration:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rules:\n no-invalid-media-type-examples:\n severity: error\n allowAdditionalProperties: false\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 no-invalid-media-type-examples:\n severity: error\n allowAdditionalProperties: false\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["incorrect"]}," media type example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"post:\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n make:\n type: string\n model:\n type: string\n year:\n type: integer\n examples:\n tesla:\n summary: Red Tesla\n value:\n make: Tesla\n model: Y\n year: '2022'\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example produces an error because the year is a string instead of an integer."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["correct"]}," media type example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"post:\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n make:\n type: string\n model:\n type: string\n year:\n type: integer\n examples:\n tesla:\n summary: Red Tesla\n value:\n make: Tesla\n model: Y\n year: 2022\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["incorrect"]}," media type example due to additional property:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"post:\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n make:\n type: string\n model:\n type: string\n year:\n type: integer\n examples:\n tesla:\n summary: Red Tesla\n value:\n make: Tesla\n model: Y\n year: 2022\n color: red\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"openapi-32-datavalue","__idx":4},"children":["OpenAPI 3.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataValue"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In OpenAPI 3.2, provide the structured example in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataValue"]},", which is validated against the schema the same way ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}," is."," ","When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataValue"]}," is present, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}," must be absent (see ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/spec-example-values"},"children":["spec-example-values"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["incorrect"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataValue"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"post:\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n make:\n type: string\n year:\n type: integer\n examples:\n tesla:\n summary: Red Tesla\n dataValue:\n make: Tesla\n year: '2022'\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example produces an error because the year is a string instead of an integer."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["correct"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataValue"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"post:\n requestBody:\n content:\n application/json:\n schema:\n type: object\n properties:\n make:\n type: string\n year:\n type: integer\n examples:\n tesla:\n summary: Red Tesla\n dataValue:\n make: Tesla\n year: 2022\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-rules","__idx":5},"children":["Related rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$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":"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":"Heading","attributes":{"level":2,"id":"resources","__idx":6},"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/no-invalid-media-type-examples.ts"},"children":["Rule source"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/example/"},"children":["Example docs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/media-type/"},"children":["Media type object docs"]}]}]}]},"frontmatter":{"slug":"/docs/cli/rules/oas/no-invalid-media-type-examples"},"tagList":[],"title":"no-invalid-media-type-examples","lastModified":"2026-07-16T10:18:52.000Z"}