Skip to main content

Type Alias: OpenApiViewProps

OpenApiViewProps = ParseResourcesOptions & object

Defined in: resources/OpenApiView.tsx:29

Type Declaration​

getHref?​

optional getHref?: (location) => string

The URL of a location in the app (e.g. formatLocation under a base path). When given, navigation renders real links, so they open in a new tab with a modified click.

Parameters​

ParameterType
locationOpenApiLocation

Returns​

string

location​

location: OpenApiLocation

The screen to show: a resource and one of its views.

onNavigate​

onNavigate: (location) => void

Called with the next location when the user navigates.

Parameters​

ParameterType
locationOpenApiLocation

Returns​

void

params?​

optional params?: OperationParams

Params every request receives, e.g. { project_id } for an API whose paths are nested under a parent. Params an operation does not declare are ignored.