ApiNotes · JSON Structure

Apinotes Documentation Structure

Structure representing an API documentation portal generated by ApiNotes

Type: object Properties: 9
API ReferenceDeveloper PortalDocumentationInteractiveOpenAPI

Apinotes Documentation Structure is a JSON Structure definition published by ApiNotes, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description specificationUrl portalUrl version languages liveTestingEnabled createdAt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

apinotes-documentation-structure.json Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apinotes/main/json-structure/apinotes-documentation-structure.json",
  "title": "ApiNotes Documentation",
  "description": "Structure representing an API documentation portal generated by ApiNotes",
  "type": "object",
  "properties": {
    "id": { "type": "string", "description": "Unique identifier" },
    "name": { "type": "string", "description": "Name of the documentation portal" },
    "description": { "type": "string", "description": "Description of the API" },
    "specificationUrl": { "type": "string", "description": "URL of the OpenAPI specification" },
    "portalUrl": { "type": "string", "description": "Public URL of the documentation portal" },
    "version": { "type": "string", "description": "API version" },
    "languages": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Languages for code examples"
    },
    "liveTestingEnabled": { "type": "boolean", "description": "Live testing enabled flag" },
    "createdAt": { "type": "datetime", "description": "Generation timestamp" }
  }
}