SchemaApi class reference
All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
retrieve | GET /api/schema/ |
retrieve
retrieve( lang=None, scheme=None, **kwargs )
OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
lang | str | [optional] | |
scheme | str | [optional] |
There are also optional kwargs that control the function invocation behavior. Read more here.
Returned values
Returned type: Tuple[dict[str, typing.Union[typing.Any, none_type]], urllib3.HTTPResponse]
.
Returns a tuple with 2 values: (parsed_response, raw_response)
.
The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.
Authentication
basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | - |