Skip to content

incident_io_client.api.utilities_v1.utilities_v1_open_api

asyncio async 

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

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[UtilitiesV1OpenAPIResponse200]

UtilitiesV1OpenAPIResponse200
Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[UtilitiesV1OpenAPIResponse200]:
    """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:
        UtilitiesV1OpenAPIResponse200
    """

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

asyncio_detailed async 

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

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[UtilitiesV1OpenAPIResponse200]

Response[UtilitiesV1OpenAPIResponse200]
Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[UtilitiesV1OpenAPIResponse200]:
    """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[UtilitiesV1OpenAPIResponse200]
    """

    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[UtilitiesV1OpenAPIResponse200]

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[UtilitiesV1OpenAPIResponse200]

UtilitiesV1OpenAPIResponse200
Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[UtilitiesV1OpenAPIResponse200]:
    """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:
        UtilitiesV1OpenAPIResponse200
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed 

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

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[UtilitiesV1OpenAPIResponse200]

Response[UtilitiesV1OpenAPIResponse200]
Source code in incident_io_client/api/utilities_v1/utilities_v1_open_api.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[UtilitiesV1OpenAPIResponse200]:
    """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[UtilitiesV1OpenAPIResponse200]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)