Skip to content

spec-example-values.md

Latest commit

 

History

History
104 lines (79 loc) · 2.68 KB

spec-example-values.md

File metadata and controls

104 lines (79 loc) · 2.68 KB
slug
/docs/cli/rules/oas/spec-example-values

spec-example-values

Ensures that example objects have valid field combinations according to the OpenAPI 3.2.0 specification.

OAS Compatibility
2.0 ❌
3.0 ✅
3.1 ✅
3.2 ✅ 
flowchart TD

Root ==> Paths --> PathItem --> Operation --> MediaType --> Example
                                              MediaType --> Examples --> Example
Root ==> components

subgraph components
NamedExamples
end

NamedExamples --> Example

style Example fill:#codaf9,stroke:#0044d4,stroke-width:5px
Loading

API design principles

According to the OpenAPI 3.2.0 specification, example objects have strict rules about which fields can be used together. This rule ensures that only valid field combinations are used in example objects.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  spec-example-values: error

Examples

Given this configuration:

rules:
  spec-example-values: error

Example of incorrect example objects:

components:
  examples:
    InvalidDataValueAndValue:
      dataValue:
        name: John Doe
      value:
        name: Jane Doe
    InvalidSerializedValueAndValue:
      serializedValue: '{"name":"John Doe"}'
      value:
        name: Jane Doe
    InvalidExternalValueAndValue:
      externalValue: https://example.com/user-example.json
      value:
        name: Jane Doe

Example of correct example objects:

components:
  examples:
    ValidDataValue:
      dataValue:
        name: John Doe
    ValidSerializedValue:
      serializedValue: '{"name":"John Doe"}'
    ValidExternalValue:
      externalValue: https://example.com/user-example.json

Related rules

Resources