Interface IComponents

Reusable named DTO schemas and security schemes.

interface IComponents {
authorizations: IAuthorization[];
schemas: Record<string, IJsonSchemaDescriptive>;
}

Index

Properties

authorizations schemas

Properties

authorizations

authorizations: IAuthorization[]

Authorization schemes for authenticated actors.

schemas

schemas: Record<string, IJsonSchemaDescriptive>

Named DTO schemas.

Type naming conventions:

IEntityName: Full detailed entity
IEntityName.ICreate: POST request body
IEntityName.IUpdate: PUT request body
IEntityName.ISummary: Simplified list view
IEntityName.IRequest: Search/filter parameters
IEntityName.IInvert: Alternative perspective
IPageIEntityName: Paginated results (pagination + data)