import_documentation_parts¶
Operation¶
import_documentation_parts
¶
import_documentation_parts(request: ImportDocumentationPartsInput | ImportDocumentationPartsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ImportDocumentationPartsInputDict]) -> ImportDocumentationPartsOutput
Imports documentation parts
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ImportDocumentationPartsInput | ImportDocumentationPartsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ImportDocumentationPartsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ImportDocumentationPartsOutput
|
An instance of |
import_documentation_parts
async
¶
import_documentation_parts(request: ImportDocumentationPartsInput | ImportDocumentationPartsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ImportDocumentationPartsInputDict]) -> ImportDocumentationPartsOutput
Imports documentation parts
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ImportDocumentationPartsInput | ImportDocumentationPartsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ImportDocumentationPartsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ImportDocumentationPartsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ImportDocumentationPartsInputDict
¶
Bases: TypedDict
Dictionary form of ImportDocumentationPartsInput.
Attributes¶
body
instance-attribute
¶
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
fail_on_warnings
instance-attribute
¶
fail_on_warnings: bool | None
A query parameter to specify whether to rollback the documentation
importation (true) or not (false) when a warning is encountered. The
default value is false.
ImportDocumentationPartsInput
dataclass
¶
Bases: _SerdeShape
Import documentation parts from an external (e.g., OpenAPI) definition file.
Attributes¶
body
class-attribute
instance-attribute
¶
body: bytes | None = ...
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
fail_on_warnings
class-attribute
instance-attribute
¶
fail_on_warnings: bool = ...
A query parameter to specify whether to rollback the documentation
importation (true) or not (false) when a warning is encountered. The
default value is false.
Output¶
ImportDocumentationPartsOutput
dataclass
¶
Bases: _SerdeShape
A collection of the imported DocumentationPart identifiers.
Attributes¶
ids
class-attribute
instance-attribute
¶
A list of the returned documentation part identifiers.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.