Skip to content

spec-no-invalid-encoding-combinations.md

Latest commit

 

History

History
120 lines (96 loc) · 2.94 KB

spec-no-invalid-encoding-combinations.md

File metadata and controls

120 lines (96 loc) · 2.94 KB
slug /docs/cli/rules/oas/spec-no-invalid-encoding-combinations

spec-no-invalid-encoding-combinations

Ensures that MediaType objects have valid combinations of encoding fields according to the OpenAPI 3.2.0 specification.

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

Root ==> Paths --> PathItem --> Operation --> Parameter --> MediaType
PathItem --> Parameter
Operation --> RequestBody --> MediaType
Operation --> Responses --> MediaType

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

API design principles

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

Configuration

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

An example configuration:

rules:
  spec-no-invalid-encoding-combinations: error

Examples

Given this configuration:

rules:
  spec-no-invalid-encoding-combinations: error

Example of incorrect MediaType objects:

requestBody:
  content:
    'multipart/form-data':
      schema:
        type: object
        properties:
          id:
            type: integer
      encoding:
        id:
          style: form
      prefixEncoding:
        - style: form
    'application/x-www-form-urlencoded':
      schema:
        type: object
        properties:
          name:
            type: string
      encoding:
        name:
          style: form
      itemEncoding:
        style: form

Example of correct MediaType objects:

requestBody:
  content:
    'multipart/form-data':
      schema:
        type: object
        properties:
          id:
            type: integer
      encoding:
        id:
          style: form
    'multipart/form-data-positional':
      schema:
        type: object
        properties:
          items:
            type: array
      prefixEncoding:
        - style: form
      itemEncoding:
        style: form

Related rules

Resources