@squidcloud/client
    Preparing search index...

    Interface CollectionSchemaApi

    API-boundary view of CollectionSchema for use in OpenAPI-exposed controllers. Decouples the public REST surface from json-schema-typed's recursive generic, which tsoa's type resolver cannot walk.

    The on-the-wire payload is the same as CollectionSchema — this type just describes it as an opaque JSON object for the generated OpenAPI spec (which is also what tsoa 5.x emitted for CollectionSchema: a bare object with no properties).

    interface CollectionSchemaApi {
        description?: string;
        properties?: Record<string, unknown>;
        required?: string[];
        type?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Additional JSON Schema / Squid-specific fields are preserved as-is.

    Index

    Properties

    description? properties? required? type?

    Properties

    description?: string

    Human-readable description of the collection.

    properties?: Record<string, unknown>

    Map of property names to their schemas.

    required?: string[]

    Names of required properties.

    type?: string

    JSON Schema type keyword (e.g. "object").

    Settings

    Member Visibility

    On This Page

    Properties