Skip to main content

valid-json-schema

Overview

This rule belongs to the api-blueprint-validation ruleset and states that:

If a JSON schema is embedded in an API Blueprint/Elements file to provide a data definition, it must be valid as per standards.

PropertyValue
EnabledYes
Maximum SeverityError
MessageProvided JSON schema is invalid.
CodeAPIBLUEPRINT_V301
TypeValidation
Rule SystemSemantic
Broad CategoryData Structures
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsapi blueprint api elements api semantic validation json schema schema

Suggested Fixes

  • Ensure that the JSON schema is valid as per the intended JSON schema specification draft.

For More Information