ApiNotes Documentation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apinotes/main/json-schema/apinotes-documentation-schema.json",
  "title": "ApiNotes Documentation",
  "description": "Schema representing an API documentation portal generated by ApiNotes from an OpenAPI specification",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the documentation portal"
    },
    "name": {
      "type": "string",
      "description": "Name of the API documentation portal"
    },
    "description": {
      "type": "string",
      "description": "Description of the API being documented"
    },
    "specificationUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the OpenAPI or Swagger specification used to generate documentation"
    },
    "portalUrl": {
      "type": "string",
      "format": "uri",
      "description": "Public URL of the generated documentation portal"
    },
    "version": {
      "type": "string",
      "description": "API version being documented"
    },
    "languages": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Programming languages for which code examples are generated"
    },
    "liveTestingEnabled": {
      "type": "boolean",
      "description": "Whether live endpoint testing is enabled in the portal"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the documentation was generated"
    }
  },
  "required": ["id", "name", "specificationUrl"]
}