Skip to content
This repository has been archived by the owner on Dec 23, 2024. It is now read-only.

Commit

Permalink
regenerate with updated templates
Browse files Browse the repository at this point in the history
  • Loading branch information
@ctreatma
ctreatma committed Mar 13, 2024
1 parent 8e068a1 commit 21683b1
Show file tree
Hide file tree
Showing 120 changed files with 56,354 additions and 25,304 deletions.
18 changes: 12 additions & 6 deletions equinix_metal/docs/AuthenticationApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**auth_token_input** | [**AuthTokenInput**](AuthTokenInput.md)| API key to create |
Expand All @@ -86,6 +87,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | created | - |
Expand All @@ -94,7 +96,6 @@ Name | Type | Description | Notes
**422** | unprocessable entity | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_project_api_key**
> AuthToken create_project_api_key(id, auth_token_input, include=include)
Expand Down Expand Up @@ -151,6 +152,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -171,6 +173,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | created | - |
Expand All @@ -179,7 +182,6 @@ Name | Type | Description | Notes
**422** | unprocessable entity | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_api_key**
> delete_api_key(id)
Expand Down Expand Up @@ -230,6 +232,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| API Key UUID |
Expand All @@ -248,14 +251,14 @@ void (empty response body)
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | no content | - |
**401** | unauthorized | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_user_api_key**
> delete_user_api_key(id)
Expand Down Expand Up @@ -306,6 +309,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| API Key UUID |
Expand All @@ -324,14 +328,14 @@ void (empty response body)
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | no content | - |
**401** | unauthorized | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_api_keys**
> AuthTokenList find_api_keys(search=search, include=include)
Expand Down Expand Up @@ -386,6 +390,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search** | **str**| Search by description | [optional]
Expand All @@ -405,14 +410,14 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
**401** | unauthorized | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_project_api_keys**
> AuthTokenList find_project_api_keys(id, include=include)
Expand Down Expand Up @@ -467,6 +472,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -486,11 +492,11 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
**401** | unauthorized | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

21 changes: 14 additions & 7 deletions equinix_metal/docs/BGPApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| BGP session UUID |
Expand All @@ -81,6 +82,7 @@ void (empty response body)
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | no content | - |
Expand All @@ -89,7 +91,6 @@ void (empty response body)
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_bgp_config_by_project**
> BgpConfig find_bgp_config_by_project(id, include=include)
Expand Down Expand Up @@ -144,6 +145,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -163,6 +165,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok When BGP configuration is not enabled empty structure is returned. When BGP configuration is disabled after being enabled BGP configuration data is returned with status disabled. | - |
Expand All @@ -171,7 +174,6 @@ Name | Type | Description | Notes
**404** | not found The project was not found. | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_bgp_session_by_id**
> BgpSession find_bgp_session_by_id(id, include=include)
Expand Down Expand Up @@ -226,6 +228,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| BGP session UUID |
Expand All @@ -245,6 +248,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
Expand All @@ -253,7 +257,6 @@ Name | Type | Description | Notes
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_global_bgp_ranges**
> GlobalBgpRangeList find_global_bgp_ranges(id)
Expand Down Expand Up @@ -307,6 +310,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -325,6 +329,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
Expand All @@ -333,7 +338,6 @@ Name | Type | Description | Notes
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_project_bgp_sessions**
> BgpSessionList find_project_bgp_sessions(id)
Expand Down Expand Up @@ -387,6 +391,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -405,14 +410,14 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
**401** | unauthorized | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **request_bgp_config**
> request_bgp_config(id, bgp_config_request_input, include=include)
Expand Down Expand Up @@ -466,6 +471,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -486,6 +492,7 @@ void (empty response body)
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | no content | - |
Expand All @@ -495,7 +502,6 @@ void (empty response body)
**422** | unprocessable entity | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_bgp_session**
> update_bgp_session(id, body)
Expand Down Expand Up @@ -547,6 +553,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| BGP session UUID |
Expand All @@ -566,6 +573,7 @@ void (empty response body)
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
Expand All @@ -575,4 +583,3 @@ void (empty response body)
**422** | unprocessable entity | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

12 changes: 8 additions & 4 deletions equinix_metal/docs/BatchesApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -84,6 +85,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | created | - |
Expand All @@ -93,7 +95,6 @@ Name | Type | Description | Notes
**422** | unprocessable entity | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_batch**
> delete_batch(id, remove_associated_instances=remove_associated_instances)
Expand Down Expand Up @@ -145,6 +146,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Batch UUID |
Expand All @@ -164,14 +166,14 @@ void (empty response body)
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | no content | - |
**403** | forbidden | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_batch_by_id**
> Batch find_batch_by_id(id, include=include)
Expand Down Expand Up @@ -226,6 +228,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Batch UUID |
Expand All @@ -245,14 +248,14 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
**401** | unauthorized | - |
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **find_batches_by_project**
> BatchesList find_batches_by_project(id, include=include)
Expand Down Expand Up @@ -307,6 +310,7 @@ with equinix_metal.ApiClient(configuration) as api_client:

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Project UUID |
Expand All @@ -326,6 +330,7 @@ Name | Type | Description | Notes
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | ok | - |
Expand All @@ -334,4 +339,3 @@ Name | Type | Description | Notes
**404** | not found | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Loading

0 comments on commit 21683b1

Please sign in to comment.