Skip to content

Commit 73ea324

Browse files
gxbengxben
committed
initial SDK 0.52.5 codebase import
1 parent 04258f9 commit 73ea324

242 files changed

Lines changed: 76916 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎API.md‎

Lines changed: 347 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Adapter.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Adapter
2+
3+
A network adapter.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**id** | **str** | The network adapter ID (auto-generated). | [optional]
10+
**name** | **str** | The network adapter name. |
11+
**description** | **str** | The network adapter description. | [optional]
12+
**mac** | **str** | The network adapter hardware address (e.g. 00:11:22:33:44:55). Auto-generated if unspecified. | [optional]
13+
**addresses** | **List[str]** | The network adapter list of associated IPv4 addresses. | [optional]
14+
**reserved** | **bool** | The network adapter is a reserved adapter (e.g. router), where the same hardware address can be reused over several subnets. | [optional] [default to False]
15+
16+
## Example
17+
18+
```python
19+
from kowabunga.models.adapter import Adapter
20+
21+
# TODO update the JSON string below
22+
json = "{}"
23+
# create an instance of Adapter from a JSON string
24+
adapter_instance = Adapter.from_json(json)
25+
# print the JSON string representation of the object
26+
print(Adapter.to_json())
27+
28+
# convert the object into a dict
29+
adapter_dict = adapter_instance.to_dict()
30+
# create an instance of Adapter from a dict
31+
adapter_from_dict = Adapter.from_dict(adapter_dict)
32+
```
33+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
34+
35+

‎docs/AdapterApi.md‎

Lines changed: 350 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,350 @@
1+
# kowabunga.AdapterApi
2+
3+
All URIs are relative to *https://raw.githubusercontent.com/api/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**delete_adapter**](AdapterApi.md#delete_adapter) | **DELETE** /adapter/{adapterId} |
8+
[**list_adapters**](AdapterApi.md#list_adapters) | **GET** /adapter |
9+
[**read_adapter**](AdapterApi.md#read_adapter) | **GET** /adapter/{adapterId} |
10+
[**update_adapter**](AdapterApi.md#update_adapter) | **PUT** /adapter/{adapterId} |
11+
12+
13+
# **delete_adapter**
14+
> delete_adapter(adapter_id)
15+
16+
Deletes an existing network adapter.
17+
18+
### Example
19+
20+
* Api Key Authentication (ApiKeyAuth):
21+
* Bearer (JWT) Authentication (BearerAuth):
22+
23+
```python
24+
import kowabunga
25+
from kowabunga.rest import ApiException
26+
from pprint import pprint
27+
28+
# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
29+
# See configuration.py for a list of all supported configuration parameters.
30+
configuration = kowabunga.Configuration(
31+
host = "https://raw.githubusercontent.com/api/v1"
32+
)
33+
34+
# The client must configure the authentication and authorization parameters
35+
# in accordance with the API server security policy.
36+
# Examples for each auth method are provided below, use the example that
37+
# satisfies your auth use case.
38+
39+
# Configure API key authorization: ApiKeyAuth
40+
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
41+
42+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
43+
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
44+
45+
# Configure Bearer authorization (JWT): BearerAuth
46+
configuration = kowabunga.Configuration(
47+
access_token = os.environ["BEARER_TOKEN"]
48+
)
49+
50+
# Enter a context with an instance of the API client
51+
with kowabunga.ApiClient(configuration) as api_client:
52+
# Create an instance of the API class
53+
api_instance = kowabunga.AdapterApi(api_client)
54+
adapter_id = 'adapter_id_example' # str | The ID of the network adapter.
55+
56+
try:
57+
api_instance.delete_adapter(adapter_id)
58+
except Exception as e:
59+
print("Exception when calling AdapterApi->delete_adapter: %s\n" % e)
60+
```
61+
62+
63+
64+
### Parameters
65+
66+
67+
Name | Type | Description | Notes
68+
------------- | ------------- | ------------- | -------------
69+
**adapter_id** | **str**| The ID of the network adapter. |
70+
71+
### Return type
72+
73+
void (empty response body)
74+
75+
### Authorization
76+
77+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
78+
79+
### HTTP request headers
80+
81+
- **Content-Type**: Not defined
82+
- **Accept**: application/json
83+
84+
### HTTP response details
85+
86+
| Status code | Description | Response headers |
87+
|-------------|-------------|------------------|
88+
**200** | The network adapter has been successfully removed. | - |
89+
**401** | Unauthorized error: Unauthorized resource access (wrong auth/credentials). | - |
90+
**403** | Forbidden error: Forbidden resource access (restricted access control). | - |
91+
**404** | NotFound error: Specified resource does not exist. | - |
92+
**409** | Conflict error: A similar resource already exists or resource is still being referenced somewhere. | - |
93+
**422** | UnprocessableEntity error: Server can't process request. | - |
94+
95+
[[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)
96+
97+
# **list_adapters**
98+
> List[str] list_adapters()
99+
100+
Returns the IDs of network adapter objects.
101+
102+
### Example
103+
104+
* Api Key Authentication (ApiKeyAuth):
105+
* Bearer (JWT) Authentication (BearerAuth):
106+
107+
```python
108+
import kowabunga
109+
from kowabunga.rest import ApiException
110+
from pprint import pprint
111+
112+
# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
113+
# See configuration.py for a list of all supported configuration parameters.
114+
configuration = kowabunga.Configuration(
115+
host = "https://raw.githubusercontent.com/api/v1"
116+
)
117+
118+
# The client must configure the authentication and authorization parameters
119+
# in accordance with the API server security policy.
120+
# Examples for each auth method are provided below, use the example that
121+
# satisfies your auth use case.
122+
123+
# Configure API key authorization: ApiKeyAuth
124+
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
125+
126+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
127+
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
128+
129+
# Configure Bearer authorization (JWT): BearerAuth
130+
configuration = kowabunga.Configuration(
131+
access_token = os.environ["BEARER_TOKEN"]
132+
)
133+
134+
# Enter a context with an instance of the API client
135+
with kowabunga.ApiClient(configuration) as api_client:
136+
# Create an instance of the API class
137+
api_instance = kowabunga.AdapterApi(api_client)
138+
139+
try:
140+
api_response = api_instance.list_adapters()
141+
print("The response of AdapterApi->list_adapters:\n")
142+
pprint(api_response)
143+
except Exception as e:
144+
print("Exception when calling AdapterApi->list_adapters: %s\n" % e)
145+
```
146+
147+
148+
149+
### Parameters
150+
151+
This endpoint does not need any parameter.
152+
153+
### Return type
154+
155+
**List[str]**
156+
157+
### Authorization
158+
159+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
160+
161+
### HTTP request headers
162+
163+
- **Content-Type**: Not defined
164+
- **Accept**: application/json
165+
166+
### HTTP response details
167+
168+
| Status code | Description | Response headers |
169+
|-------------|-------------|------------------|
170+
**200** | Returns an array of network adapter IDs. | - |
171+
**401** | Unauthorized error: Unauthorized resource access (wrong auth/credentials). | - |
172+
**403** | Forbidden error: Forbidden resource access (restricted access control). | - |
173+
174+
[[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)
175+
176+
# **read_adapter**
177+
> Adapter read_adapter(adapter_id)
178+
179+
Returns a network adapter.
180+
181+
### Example
182+
183+
* Api Key Authentication (ApiKeyAuth):
184+
* Bearer (JWT) Authentication (BearerAuth):
185+
186+
```python
187+
import kowabunga
188+
from kowabunga.models.adapter import Adapter
189+
from kowabunga.rest import ApiException
190+
from pprint import pprint
191+
192+
# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
193+
# See configuration.py for a list of all supported configuration parameters.
194+
configuration = kowabunga.Configuration(
195+
host = "https://raw.githubusercontent.com/api/v1"
196+
)
197+
198+
# The client must configure the authentication and authorization parameters
199+
# in accordance with the API server security policy.
200+
# Examples for each auth method are provided below, use the example that
201+
# satisfies your auth use case.
202+
203+
# Configure API key authorization: ApiKeyAuth
204+
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
205+
206+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
207+
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
208+
209+
# Configure Bearer authorization (JWT): BearerAuth
210+
configuration = kowabunga.Configuration(
211+
access_token = os.environ["BEARER_TOKEN"]
212+
)
213+
214+
# Enter a context with an instance of the API client
215+
with kowabunga.ApiClient(configuration) as api_client:
216+
# Create an instance of the API class
217+
api_instance = kowabunga.AdapterApi(api_client)
218+
adapter_id = 'adapter_id_example' # str | The ID of the network adapter.
219+
220+
try:
221+
api_response = api_instance.read_adapter(adapter_id)
222+
print("The response of AdapterApi->read_adapter:\n")
223+
pprint(api_response)
224+
except Exception as e:
225+
print("Exception when calling AdapterApi->read_adapter: %s\n" % e)
226+
```
227+
228+
229+
230+
### Parameters
231+
232+
233+
Name | Type | Description | Notes
234+
------------- | ------------- | ------------- | -------------
235+
**adapter_id** | **str**| The ID of the network adapter. |
236+
237+
### Return type
238+
239+
[**Adapter**](Adapter.md)
240+
241+
### Authorization
242+
243+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
244+
245+
### HTTP request headers
246+
247+
- **Content-Type**: Not defined
248+
- **Accept**: application/json
249+
250+
### HTTP response details
251+
252+
| Status code | Description | Response headers |
253+
|-------------|-------------|------------------|
254+
**200** | Returns the network adapter object. | - |
255+
**401** | Unauthorized error: Unauthorized resource access (wrong auth/credentials). | - |
256+
**403** | Forbidden error: Forbidden resource access (restricted access control). | - |
257+
**404** | NotFound error: Specified resource does not exist. | - |
258+
259+
[[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)
260+
261+
# **update_adapter**
262+
> Adapter update_adapter(adapter_id, adapter)
263+
264+
Updates a network adapter configuration.
265+
266+
### Example
267+
268+
* Api Key Authentication (ApiKeyAuth):
269+
* Bearer (JWT) Authentication (BearerAuth):
270+
271+
```python
272+
import kowabunga
273+
from kowabunga.models.adapter import Adapter
274+
from kowabunga.rest import ApiException
275+
from pprint import pprint
276+
277+
# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
278+
# See configuration.py for a list of all supported configuration parameters.
279+
configuration = kowabunga.Configuration(
280+
host = "https://raw.githubusercontent.com/api/v1"
281+
)
282+
283+
# The client must configure the authentication and authorization parameters
284+
# in accordance with the API server security policy.
285+
# Examples for each auth method are provided below, use the example that
286+
# satisfies your auth use case.
287+
288+
# Configure API key authorization: ApiKeyAuth
289+
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
290+
291+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
292+
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
293+
294+
# Configure Bearer authorization (JWT): BearerAuth
295+
configuration = kowabunga.Configuration(
296+
access_token = os.environ["BEARER_TOKEN"]
297+
)
298+
299+
# Enter a context with an instance of the API client
300+
with kowabunga.ApiClient(configuration) as api_client:
301+
# Create an instance of the API class
302+
api_instance = kowabunga.AdapterApi(api_client)
303+
adapter_id = 'adapter_id_example' # str | The ID of the network adapter.
304+
adapter = kowabunga.Adapter() # Adapter | Adapter payload.
305+
306+
try:
307+
api_response = api_instance.update_adapter(adapter_id, adapter)
308+
print("The response of AdapterApi->update_adapter:\n")
309+
pprint(api_response)
310+
except Exception as e:
311+
print("Exception when calling AdapterApi->update_adapter: %s\n" % e)
312+
```
313+
314+
315+
316+
### Parameters
317+
318+
319+
Name | Type | Description | Notes
320+
------------- | ------------- | ------------- | -------------
321+
**adapter_id** | **str**| The ID of the network adapter. |
322+
**adapter** | [**Adapter**](Adapter.md)| Adapter payload. |
323+
324+
### Return type
325+
326+
[**Adapter**](Adapter.md)
327+
328+
### Authorization
329+
330+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
331+
332+
### HTTP request headers
333+
334+
- **Content-Type**: application/json
335+
- **Accept**: application/json
336+
337+
### HTTP response details
338+
339+
| Status code | Description | Response headers |
340+
|-------------|-------------|------------------|
341+
**200** | Returns the network adapter object. | - |
342+
**400** | BadRequest error: Bad request (wrong input parameters). | - |
343+
**401** | Unauthorized error: Unauthorized resource access (wrong auth/credentials). | - |
344+
**403** | Forbidden error: Forbidden resource access (restricted access control). | - |
345+
**404** | NotFound error: Specified resource does not exist. | - |
346+
**422** | UnprocessableEntity error: Server can't process request. | - |
347+
**507** | InsufficientResource error: Server can't allocate resources (logical quotas or physical limits hit). | - |
348+
349+
[[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)
350+

0 commit comments

Comments
 (0)