Type Alias: OpenApiViewProps
OpenApiViewProps =
ParseResourcesOptions&object
Defined in: resources/OpenApiView.tsx:29
Type Declaration
getHref?
optionalgetHref?: (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
| Parameter | Type |
|---|---|
location | OpenApiLocation |
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
| Parameter | Type |
|---|---|
location | OpenApiLocation |
Returns
void
params?
optionalparams?: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.