APIGen · JSON Structure

Apigen Endpoint Structure

An API endpoint defining a single operation with its path, method, and request/response schemas.

Type: object Properties: 13 Required: 6

CodeDocumentationGenerationOpen SourcePHP

APIGen Endpoint is a JSON Structure definition published by APIGen, describing 13 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id apiId path method summary description parameters requestSchema responseSchema authentication connectorId createdAt updatedAt

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://api.apigen.com/schemas/endpoint.json",
  "description": "An API endpoint defining a single operation with its path, method, and request/response schemas.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the endpoint."
    },
    "apiId": {
      "type": "string",
      "description": "ID of the parent API."
    },
    "path": {
      "type": "string",
      "pattern": "^/",
      "description": "URL path for the endpoint, starting with a forward slash."
    },
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
      ],
      "description": "HTTP method for the endpoint."
    },
    "summary": {
      "type": "string",
      "maxLength": 255,
      "description": "Short summary of what the endpoint does."
    },
    "description": {
      "type": "string",
      "description": "Detailed description of the endpoint behavior."
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "in": {
            "type": "string",
            "enum": [
              "path",
              "query",
              "header"
            ]
          },
          "required": {
            "type": "boolean"
          },
          "schema": {
            "type": "object"
          },
          "description": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "in"
        ]
      },
      "description": "Path, query, and header parameters."
    },
    "requestSchema": {
      "type": "object",
      "description": "JSON Schema defining the request body."
    },
    "responseSchema": {
      "type": "object",
      "description": "JSON Schema defining the success response body."
    },
    "authentication": {
      "type": "boolean",
      "default": true,
      "description": "Whether this endpoint requires authentication."
    },
    "connectorId": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the connector used as the data source for this endpoint."
    },
    "createdAt": {
      "type": "datetime",
      "description": "Timestamp when the endpoint was created."
    },
    "updatedAt": {
      "type": "datetime",
      "description": "Timestamp when the endpoint was last updated."
    }
  },
  "required": [
    "id",
    "apiId",
    "path",
    "method",
    "createdAt",
    "updatedAt"
  ],
  "additionalProperties": false,
  "name": "APIGen Endpoint"
}