Skip to content

incident_io_client.api.utilities_v1.utilities_v1_open_api

asyncio async

asyncio(
    *, client: Union[AuthenticatedClient, Client]
) -> Optional[File]

OpenAPI Utilities V1

Get the OpenAPI (v2) definition.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[File]

File

Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[File]:
    """OpenAPI Utilities V1

     Get the OpenAPI (v2) definition.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        File
    """

    return (
        await asyncio_detailed(
            client=client,
        )
    ).parsed

asyncio_detailed async

asyncio_detailed(
    *, client: Union[AuthenticatedClient, Client]
) -> Response[File]

OpenAPI Utilities V1

Get the OpenAPI (v2) definition.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[File]

Response[File]

Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[File]:
    """OpenAPI Utilities V1

     Get the OpenAPI (v2) definition.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[File]
    """

    kwargs = _get_kwargs()

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync

sync(
    *, client: Union[AuthenticatedClient, Client]
) -> Optional[File]

OpenAPI Utilities V1

Get the OpenAPI (v2) definition.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[File]

File

Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[File]:
    """OpenAPI Utilities V1

     Get the OpenAPI (v2) definition.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        File
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed

sync_detailed(
    *, client: Union[AuthenticatedClient, Client]
) -> Response[File]

OpenAPI Utilities V1

Get the OpenAPI (v2) definition.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[File]

Response[File]

Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[File]:
    """OpenAPI Utilities V1

     Get the OpenAPI (v2) definition.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[File]
    """

    kwargs = _get_kwargs()

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)