FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor
    Recommended

    json-schema-title-description-type


    Formats: Severity:

    This is a quality rule for readable, useful JSON Schema documents.

    It warns when schemas are missing useful annotations such as title or description, when schemas omit an explicit type, or when object and array schemas are too loose to be useful.

    Bad example

    {
      "type": "object"
    }
    

    Good example

    {
      "title": "GiftBox",
      "description": "A gift box sold in the shop.",
      "type": "object",
      "properties": {
        "color": {
          "type": "string"
        }
      }
    }
    

    How do I fix this violation?

    Add clear annotations and enough structure for downstream tools to understand the schema.