Interface ProfileRoute

A route describing a profile screen, derived from an x-profile operation.

interface ProfileRoute {
    method: string;
    operationId: string;
    path: string;
    summary?: string;
}

Properties

method: string

HTTP method in upper case, e.g. "GET".

operationId: string

operationId from the spec.

path: string

Spec path template, e.g. "/users/me".

summary?: string

Human-readable summary, when present.