`IAppLoadPath`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IAppLoadPath

Endpoint name, URL, supported methods and request forms.

src/lib/interfaces/orionplace/appBase/appLoadCommon/IAppLoadCommonPath.ts

TypeScript

export interface IAppLoadPath {
	// Stable endpoint name used to find a method in discovery.
	url_name: string;
	// Request URL supplied by the backend. Send it through the storefront gateway.
	target: string;
	// HTTP methods supported by this endpoint.
	methods: TMethod[];
	// Optional readiness metadata supplied by the backend.
	ready?: string;
	// Short description of the endpoint.
	summary?: string;
	// Detailed description of the endpoint.
	description?: string;
	// Request forms and filter metadata for this endpoint.
	forms: IForm[];
}