ptctools 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

ptctools/portainer_client/openapi_client/docs/TagsApi.md

@@ -0,0 +1,273 @@
+# openapi_client.TagsApi
+
+All URIs are relative to */api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**tag_create**](TagsApi.md#tag_create) | **POST** /tags | Create a new tag
+[**tag_delete**](TagsApi.md#tag_delete) | **DELETE** /tags/{id} | Remove a tag
+[**tag_list**](TagsApi.md#tag_list) | **GET** /tags | List tags
+
+
+# **tag_create**
+> PortainerTag tag_create(body)
+
+Create a new tag
+
+Create a new tag.
+**Access policy**: administrator
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_tag import PortainerTag
+from openapi_client.models.tags_tag_create_payload import TagsTagCreatePayload
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.TagsApi(api_client)
+    body = openapi_client.TagsTagCreatePayload() # TagsTagCreatePayload | Tag details
+
+    try:
+        # Create a new tag
+        api_response = api_instance.tag_create(body)
+        print("The response of TagsApi->tag_create:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling TagsApi->tag_create: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**TagsTagCreatePayload**](TagsTagCreatePayload.md)| Tag details | 
+
+### Return type
+
+[**PortainerTag**](PortainerTag.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**409** | This name is already associated to a tag |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **tag_delete**
+> tag_delete(id)
+
+Remove a tag
+
+Remove a tag.
+**Access policy**: administrator
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.TagsApi(api_client)
+    id = 56 # int | Tag identifier
+
+    try:
+        # Remove a tag
+        api_instance.tag_delete(id)
+    except Exception as e:
+        print("Exception when calling TagsApi->tag_delete: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| Tag identifier | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | Tag not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **tag_list**
+> List[PortainerTag] tag_list()
+
+List tags
+
+List tags.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_tag import PortainerTag
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.TagsApi(api_client)
+
+    try:
+        # List tags
+        api_response = api_instance.tag_list()
+        print("The response of TagsApi->tag_list:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling TagsApi->tag_list: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**List[PortainerTag]**](PortainerTag.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**500** | Server error |  -  |
+
+[[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)
+

ptctools/portainer_client/openapi_client/docs/TagsTagCreatePayload.md

@@ -0,0 +1,29 @@
+# TagsTagCreatePayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+
+## Example
+
+```python
+from openapi_client.models.tags_tag_create_payload import TagsTagCreatePayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of TagsTagCreatePayload from a JSON string
+tags_tag_create_payload_instance = TagsTagCreatePayload.from_json(json)
+# print the JSON string representation of the object
+print(TagsTagCreatePayload.to_json())
+
+# convert the object into a dict
+tags_tag_create_payload_dict = tags_tag_create_payload_instance.to_dict()
+# create an instance of TagsTagCreatePayload from a dict
+tags_tag_create_payload_from_dict = TagsTagCreatePayload.from_dict(tags_tag_create_payload_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+