schema-format-deprecated

Since 0.10.0 · In the rulesets: Recommended at warning, Strict at warning, All at warning

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

Swagger 2.0 has no replacement for these formats, so the issues are always hints: they mark what needs a change when the document is converted to OpenAPI 3.1, and never count as warnings. See Formats for every format.

Turn the rule off when the documents must stay readable by tools that only know the older formats.

Examples

Good.

swagger: '2.0'
definitions:
  Avatar:
    type: string

Bad.

swagger: '2.0'
definitions:
  Avatar:
    type: string
    format: byte

Turn it off or change its severity

In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.swagger has the details.

commands:
  lint:
    swagger:
      rules:
        schema-format-deprecated: off

Related rules

Further reading

Last updated on View as Markdown
Was this helpful?