Skip to main content

byte-schema-format-with-string-type

Overview

This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:

The byte format is only applicable to schemas with the type set to string. It seems that the byte format has been used with an incompatible schema type.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageThe format byte is not applicable to the given schema type.
CodeOPENAPI3APIMATIC_L670
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Schemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi apimatic semantic linting byte schema type format string

Suggested Fixes

  • Ensure that the schema type is set to string for compatibility with the byte format.
  • If the schema represents a different data type, consider using a compatible format or removing the byte format.
  • Ensure that the format used aligns with the schema's type and represents the desired data representation (e.g., binary for any sequence of octets).

For More Information