{
  "product": "Specification (reference)",
  "title": "OpenAPI Description",
  "summary": "Describe an HTTP API precisely enough to generate clients and tests from it.",
  "category": "formats",
  "entries": [
    {
      "path": [
        "Structure",
        "Version, info block and servers"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Structure",
        "Paths with operations per method"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Structure",
        "Reusable components and $ref"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Operations",
        "Parameters by location"
      ],
      "value": "path, query, header, cookie",
      "status": "yes",
      "note": "with required flags"
    },
    {
      "path": [
        "Operations",
        "Request bodies per media type"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Operations",
        "Responses per status code, with schemas"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Operations",
        "operationId unique and stable"
      ],
      "value": "",
      "status": "yes",
      "note": "generated client method names depend on it"
    },
    {
      "path": [
        "Schemas",
        "JSON Schema types, formats and constraints"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Schemas",
        "Composition"
      ],
      "value": "allOf, oneOf, anyOf, discriminator",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Schemas",
        "Examples that actually validate against the schema"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Security",
        "Schemes declared and applied per operation"
      ],
      "value": "bearer, apiKey, oauth2",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Security",
        "Scopes documented where they apply"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Quality",
        "Descriptions on every operation and field"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Quality",
        "Errors described, not only the happy path"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Tooling",
        "Validates against the specification"
      ],
      "value": "",
      "status": "yes",
      "note": ""
    },
    {
      "path": [
        "Tooling",
        "Generates a usable client and a mock server"
      ],
      "value": "",
      "status": "yes",
      "note": "the real test of a description"
    }
  ]
}