Skip to main content

valid-schema-content-encoding

Overview​

This rule belongs to the openapi-v3-standards-validation ruleset and states that:

Information about how a string value is encoded is provided using the Schema Object contentEncoding property which must be a valid encoding value from RFC 4648 or RFC 2045: base64url, base64, base32, base32hex, base16, hex, 7bit, 8bit, binary, quoted-printable, ietf-token, x-token. These values are compared in a case-insensitive manner.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageThe value provided for contentEncoding in the Schema Object is invalid/unrecognized.
CodeOPENAPI3STANDARDS_V342
TypeValidation
Rule SystemSemantic
Broad CategorySchemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation encoding content schema base64 base32 base16 quoted printable json schema

Suggested Fixes​

  • Ensure that the value of the contentEncoding property is one of the following: base64url, base64, base32, base32hex, base16, hex, 7bit, 8bit, binary, quoted-printable, ietf-token, x-token
  • Encoding values are compared in a case-insensitive manner.

For More Information​