extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-08-09 00:04:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

more spec lint; frontendId (#834)

Browse Source
This commit is contained in:
Michael Quigley
2025-02-04 16:37:45 -05:00
parent a71f9eb3b1
commit f7cf5430d7
19 changed files with 92 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
sdk/python/sdk/zrok/README.md
View File

@ -175,7 +175,7 @@ Class | Method | HTTP request | Description
*MetadataApi* | [**get_account_metrics**](docs/MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
*MetadataApi* | [**get_environment_detail**](docs/MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
*MetadataApi* | [**get_environment_metrics**](docs/MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
*MetadataApi* | [**get_frontend_detail**](docs/MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{feId} |
*MetadataApi* | [**get_frontend_detail**](docs/MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
*MetadataApi* | [**get_share_detail**](docs/MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
*MetadataApi* | [**get_share_metrics**](docs/MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
*MetadataApi* | [**get_sparklines**](docs/MetadataApi.md#get_sparklines) | **POST** /sparklines |

10
sdk/python/sdk/zrok/docs/MetadataApi.md
View File

@ -9,7 +9,7 @@ Method | HTTP request | Description
[**get_account_metrics**](MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
[**get_environment_detail**](MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
[**get_environment_metrics**](MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
[**get_frontend_detail**](MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{feId} |
[**get_frontend_detail**](MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
[**get_share_detail**](MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
[**get_share_metrics**](MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
[**get_sparklines**](MetadataApi.md#get_sparklines) | **POST** /sparklines |
@ -263,7 +263,7 @@ Name | Type | Description | Notes
[[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)
# **get_frontend_detail**
> Frontend get_frontend_detail(fe_id)
> Frontend get_frontend_detail(frontend_id)
@ -283,10 +283,10 @@ configuration.api_key['x-token'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = zrok_api.MetadataApi(zrok_api.ApiClient(configuration))
fe_id = 56 # int |
frontend_id = 56 # int |
try:
api_response = api_instance.get_frontend_detail(fe_id)
api_response = api_instance.get_frontend_detail(frontend_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling MetadataApi->get_frontend_detail: %s\n" % e)
@ -296,7 +296,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fe_id** | **int**| |
**frontend_id** | **int**| |
### Return type

32
sdk/python/sdk/zrok/zrok_api/api/metadata_api.py
View File

@ -481,43 +481,43 @@ class MetadataApi(object):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_frontend_detail(self, fe_id, **kwargs): # noqa: E501
def get_frontend_detail(self, frontend_id, **kwargs): # noqa: E501
"""get_frontend_detail # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_frontend_detail(fe_id, async_req=True)
>>> thread = api.get_frontend_detail(frontend_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int fe_id: (required)
:param int frontend_id: (required)
:return: Frontend
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_frontend_detail_with_http_info(fe_id, **kwargs) # noqa: E501
return self.get_frontend_detail_with_http_info(frontend_id, **kwargs) # noqa: E501
else:
(data) = self.get_frontend_detail_with_http_info(fe_id, **kwargs) # noqa: E501
(data) = self.get_frontend_detail_with_http_info(frontend_id, **kwargs) # noqa: E501
return data
def get_frontend_detail_with_http_info(self, fe_id, **kwargs): # noqa: E501
def get_frontend_detail_with_http_info(self, frontend_id, **kwargs): # noqa: E501
"""get_frontend_detail # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_frontend_detail_with_http_info(fe_id, async_req=True)
>>> thread = api.get_frontend_detail_with_http_info(frontend_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int fe_id: (required)
:param int frontend_id: (required)
:return: Frontend
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fe_id'] # noqa: E501
all_params = ['frontend_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@ -532,16 +532,16 @@ class MetadataApi(object):
)
params[key] = val
del params['kwargs']
# verify the required parameter 'fe_id' is set
if ('fe_id' not in params or
params['fe_id'] is None):
raise ValueError("Missing the required parameter `fe_id` when calling `get_frontend_detail`") # noqa: E501
# verify the required parameter 'frontend_id' is set
if ('frontend_id' not in params or
params['frontend_id'] is None):
raise ValueError("Missing the required parameter `frontend_id` when calling `get_frontend_detail`") # noqa: E501
collection_formats = {}
path_params = {}
if 'fe_id' in params:
path_params['feId'] = params['fe_id'] # noqa: E501
if 'frontend_id' in params:
path_params['frontendId'] = params['frontend_id'] # noqa: E501
query_params = []
@ -559,7 +559,7 @@ class MetadataApi(object):
auth_settings = ['key'] # noqa: E501
return self.api_client.call_api(
'/detail/frontend/{feId}', 'GET',
'/detail/frontend/{frontendId}', 'GET',
path_params,
query_params,
header_params,