@squidcloud/client
    Preparing search index...

    Interface ApiEndpoint

    Represents the structure of an API endpoint, including its path, method, schemas, and metadata.

    interface ApiEndpoint {
        bodyMimeType?: string;
        description?: string;
        injectionSchema?: ApiInjectionSchema;
        isRequestBodyRequired?: boolean;
        method: HttpMethod;
        relativePath: string;
        requestSchema?: Record<string, ApiRequestField>;
        responseSchema?: Record<string, ApiResponseField>;
        tags?: string[];
    }
    Index

    Properties

    bodyMimeType? description? injectionSchema? isRequestBodyRequired? method relativePath requestSchema? responseSchema? tags?

    Properties

    bodyMimeType?: string

    The MIME type of the request body, if applicable (e.g., 'application/json').

    description?: string

    An optional description of the endpoint's purpose or behavior.

    injectionSchema?: ApiInjectionSchema

    A schema defining fields to inject into the request, if any.

    isRequestBodyRequired?: boolean

    Indicates whether the request body is mandatory for the endpoint.

    method: HttpMethod

    The HTTP method used by the endpoint (e.g., 'get', 'post').

    relativePath: string

    The relative path of the endpoint (e.g., '/users').

    requestSchema?: Record<string, ApiRequestField>

    A schema defining the fields expected in the request, if any.

    responseSchema?: Record<string, ApiResponseField>

    A schema defining the fields returned in the response, if any.

    tags?: string[]

    An optional array of tags categorizing the endpoint.

    Settings

    Member Visibility

    On This Page

    Properties