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
1e9e58fd2ec290eddf1fc646d37794f4c01d9065
redocly-cli/docs/rules/no-invalid-parameter-examples.md
Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334)
2023-11-17 09:45:03 +00:00

2.7 KiB
Raw Blame History

slug
slug
/docs/cli/rules/no-invalid-parameter-examples

no-invalid-parameter-examples

Disallow invalid parameter examples.

OAS Compatibility
2.0 ✅
3.0 ✅
3.1 ✅ 
flowchart TD

Root ==> Paths --> PathItem --> Operation --> Parameter --> Example
PathItem --> Parameter
Parameter --> Schema
Root ==> components

NamedParameter --> Parameter

Schema -.compares schema\nto example.- Example

subgraph components
NamedParameter
end


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

API design principles

If your parameter schema and example conflict, there is a problem in the definition of the schema or the example. Solve it before you ship it.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default warn.
allowAdditionalProperties boolean Determines if additional properties are allowed in examples. Default false. 
rules:
  no-invalid-parameter-examples:
    severity: error
    allowAdditionalProperties: false

Examples

Given the following configuration:

rules:
  no-invalid-parameter-examples:
    severity: error
    allowAdditionalProperties: false

Example of incorrect parameter example:

paths:
  /results:
    get:
      summary: Search Chess Results
      operationId: searchChessResult
      parameters:
        - name: username
          in: query
          schema:
            type: string
            maxLength: 15
          description: Value to query the chess results against usernames
          example: ThisUsernameIsTooLong

Example of correct parameter example:

paths:
  /results:
    get:
      summary: Search Chess Results
      operationId: searchChessResult
      parameters:
        - name: username
          in: query
          schema:
            type: string
            maxLength: 10
          description: Value to query the chess results against usernames
          example: ella

Related rules

Resources