Skip to main content

Type Alias: OpenApiProviderProps

OpenApiProviderProps = object

Defined in: OpenApiProvider.tsx:18

Properties​

children?​

optional children?: React.ReactNode

Defined in: OpenApiProvider.tsx:29


fetcher​

fetcher: Fetcher

Defined in: OpenApiProvider.tsx:28

Performs every HTTP request the components make. See createFetcher.


spec?​

optional spec?: OpenApiSpec

Defined in: OpenApiProvider.tsx:20

The OpenAPI document, when the app already has it in memory.


specUrl?​

optional specUrl?: string

Defined in: OpenApiProvider.tsx:26

Where to fetch the OpenAPI document from (e.g. /api/v1/openapi.json). Fetched through fetcher, so it gets the same base URL and auth as the API calls. Ignored when spec is given.