Skip to main content

schema-valid-against-meta-schema

Overview​

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

The Schema Object or the JSON schema resource must be valid against the meta-schema identified by the URI in its $schema property.

PropertyValue
EnabledYes
Maximum SeverityError
MessageSchema is not valid against the meta-schema.
CodeOPENAPI3STANDARDS_V339
TypeValidation
Rule SystemSemantic
Broad CategorySchemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation uri meta schema json schema $schema schema

Suggested Fixes​

  • Ensure that the $schema value is a not empty or null.
  • Ensure that the $schema value is a valid URI and points to a JSON schema resource.
  • Ensure that the current JSON schema object is valid against the JSON schema referenced via the $schema URI.
  • You can use any JSON schema/JSON data validator tool to verify the validity of the current schema (JSON data) against the meta-schema (JSON schema).
  • Meta-schema is also a JSON schema but unlike JSON schemas that help validate JSON data, a meta-schema helps validate JSON schemas.
  • $schema is a meta-schema resource identifier as well as the schema dialect identifier.

For More Information​