Linter rulesAsyncAPIschema-format-deprecated

schema-format-deprecated

Since 0.10.0

This rule reports the formats which the OpenAPI format registry marks as deprecated from OpenAPI 3.1, and names what replaces them.

Rule Details

Format Use instead
byte contentEncoding: base64
base64url contentEncoding: base64url
binary contentMediaType, or the media type of the body or part without a schema

AsyncAPI schemas are a superset of JSON Schema draft 7, which has contentEncoding and contentMediaType, so the issues are warnings in AsyncAPI 2.x and 3.x documents. See Formats for every format.

Configuration

None.

Examples

Good.

asyncapi: 3.0.0
components:
  schemas:
    Avatar:
      type: string
      contentEncoding: base64

Bad.

asyncapi: 3.0.0
components:
  schemas:
    Avatar:
      type: string
      format: byte

When Not to Use It

When the documents must stay readable by tools that only know the older formats.

Related rules

Further reading