APIGen · Schema

APIGen Endpoint

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

CodeDocumentationGenerationOpen SourcePHP

Properties

Name Type Description
id string Unique identifier for the endpoint.
apiId string ID of the parent API.
path string URL path for the endpoint, starting with a forward slash.
method string HTTP method for the endpoint.
summary string Short summary of what the endpoint does.
description string Detailed description of the endpoint behavior.
parameters array Path, query, and header parameters.
requestSchema object JSON Schema defining the request body.
responseSchema object JSON Schema defining the success response body.
authentication boolean Whether this endpoint requires authentication.
connectorId stringnull ID of the connector used as the data source for this endpoint.
createdAt string Timestamp when the endpoint was created.
updatedAt string Timestamp when the endpoint was last updated.
View JSON Schema on GitHub