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

ptctools/portainer_client/openapi_client/test/test_kubernetes_api.py

@@ -0,0 +1,480 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from openapi_client.api.kubernetes_api import KubernetesApi
+
+
+class TestKubernetesApi(unittest.TestCase):
+    """KubernetesApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = KubernetesApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_create_kubernetes_ingress(self) -> None:
+        """Test case for create_kubernetes_ingress
+
+        Create an Ingress
+        """
+        pass
+
+    def test_create_kubernetes_namespace(self) -> None:
+        """Test case for create_kubernetes_namespace
+
+        Create a namespace
+        """
+        pass
+
+    def test_create_kubernetes_service(self) -> None:
+        """Test case for create_kubernetes_service
+
+        Create a service
+        """
+        pass
+
+    def test_delete_cluster_role_bindings(self) -> None:
+        """Test case for delete_cluster_role_bindings
+
+        Delete cluster role bindings
+        """
+        pass
+
+    def test_delete_cluster_roles(self) -> None:
+        """Test case for delete_cluster_roles
+
+        Delete cluster roles
+        """
+        pass
+
+    def test_delete_cron_jobs(self) -> None:
+        """Test case for delete_cron_jobs
+
+        Delete Cron Jobs
+        """
+        pass
+
+    def test_delete_jobs(self) -> None:
+        """Test case for delete_jobs
+
+        Delete Jobs
+        """
+        pass
+
+    def test_delete_kubernetes_ingresses(self) -> None:
+        """Test case for delete_kubernetes_ingresses
+
+        Delete one or more Ingresses
+        """
+        pass
+
+    def test_delete_kubernetes_namespace(self) -> None:
+        """Test case for delete_kubernetes_namespace
+
+        Delete a kubernetes namespace
+        """
+        pass
+
+    def test_delete_kubernetes_services(self) -> None:
+        """Test case for delete_kubernetes_services
+
+        Delete services
+        """
+        pass
+
+    def test_delete_role_bindings(self) -> None:
+        """Test case for delete_role_bindings
+
+        Delete role bindings
+        """
+        pass
+
+    def test_delete_roles(self) -> None:
+        """Test case for delete_roles
+
+        Delete roles
+        """
+        pass
+
+    def test_delete_service_accounts(self) -> None:
+        """Test case for delete_service_accounts
+
+        Delete service accounts
+        """
+        pass
+
+    def test_describe_resource(self) -> None:
+        """Test case for describe_resource
+
+        Get a description of a kubernetes resource
+        """
+        pass
+
+    def test_get_all_kubernetes_applications(self) -> None:
+        """Test case for get_all_kubernetes_applications
+
+        Get a list of applications across all namespaces in the cluster. If the nodeName is provided, it will return the applications running on that node.
+        """
+        pass
+
+    def test_get_all_kubernetes_applications_count(self) -> None:
+        """Test case for get_all_kubernetes_applications_count
+
+        Get Applications count
+        """
+        pass
+
+    def test_get_all_kubernetes_cluster_ingresses(self) -> None:
+        """Test case for get_all_kubernetes_cluster_ingresses
+
+        Get kubernetes ingresses at the cluster level
+        """
+        pass
+
+    def test_get_all_kubernetes_cluster_ingresses_count(self) -> None:
+        """Test case for get_all_kubernetes_cluster_ingresses_count
+
+        Get Ingresses count
+        """
+        pass
+
+    def test_get_all_kubernetes_cluster_role_bindings(self) -> None:
+        """Test case for get_all_kubernetes_cluster_role_bindings
+
+        Get a list of kubernetes cluster role bindings
+        """
+        pass
+
+    def test_get_all_kubernetes_cluster_roles(self) -> None:
+        """Test case for get_all_kubernetes_cluster_roles
+
+        Get a list of kubernetes cluster roles
+        """
+        pass
+
+    def test_get_all_kubernetes_config_maps(self) -> None:
+        """Test case for get_all_kubernetes_config_maps
+
+        Get a list of ConfigMaps
+        """
+        pass
+
+    def test_get_all_kubernetes_config_maps_count(self) -> None:
+        """Test case for get_all_kubernetes_config_maps_count
+
+        Get ConfigMaps count
+        """
+        pass
+
+    def test_get_all_kubernetes_events(self) -> None:
+        """Test case for get_all_kubernetes_events
+
+        Gets kubernetes events
+        """
+        pass
+
+    def test_get_all_kubernetes_ingress_controllers(self) -> None:
+        """Test case for get_all_kubernetes_ingress_controllers
+
+        Get a list of ingress controllers
+        """
+        pass
+
+    def test_get_all_kubernetes_ingresses(self) -> None:
+        """Test case for get_all_kubernetes_ingresses
+
+        Get a list of Ingresses
+        """
+        pass
+
+    def test_get_all_kubernetes_services_count(self) -> None:
+        """Test case for get_all_kubernetes_services_count
+
+        Get services count
+        """
+        pass
+
+    def test_get_all_kubernetes_volumes(self) -> None:
+        """Test case for get_all_kubernetes_volumes
+
+        Get Kubernetes volumes within the given Portainer environment
+        """
+        pass
+
+    def test_get_all_kubernetes_volumes_count(self) -> None:
+        """Test case for get_all_kubernetes_volumes_count
+
+        Get the total number of kubernetes volumes within the given Portainer environment.
+        """
+        pass
+
+    def test_get_applications_resources(self) -> None:
+        """Test case for get_applications_resources
+
+        Get the total resource requests and limits of all applications
+        """
+        pass
+
+    def test_get_kubernetes_config(self) -> None:
+        """Test case for get_kubernetes_config
+
+        Generate a kubeconfig file
+        """
+        pass
+
+    def test_get_kubernetes_config_map(self) -> None:
+        """Test case for get_kubernetes_config_map
+
+        Get a ConfigMap
+        """
+        pass
+
+    def test_get_kubernetes_cron_jobs(self) -> None:
+        """Test case for get_kubernetes_cron_jobs
+
+        Get a list of kubernetes Cron Jobs
+        """
+        pass
+
+    def test_get_kubernetes_dashboard(self) -> None:
+        """Test case for get_kubernetes_dashboard
+
+        Get the dashboard summary data
+        """
+        pass
+
+    def test_get_kubernetes_events_for_namespace(self) -> None:
+        """Test case for get_kubernetes_events_for_namespace
+
+        Gets kubernetes events for namespace
+        """
+        pass
+
+    def test_get_kubernetes_ingress(self) -> None:
+        """Test case for get_kubernetes_ingress
+
+        Get an Ingress by name
+        """
+        pass
+
+    def test_get_kubernetes_ingress_controllers_by_namespace(self) -> None:
+        """Test case for get_kubernetes_ingress_controllers_by_namespace
+
+        Get a list ingress controllers by namespace
+        """
+        pass
+
+    def test_get_kubernetes_jobs(self) -> None:
+        """Test case for get_kubernetes_jobs
+
+        Get a list of kubernetes Jobs
+        """
+        pass
+
+    def test_get_kubernetes_max_resource_limits(self) -> None:
+        """Test case for get_kubernetes_max_resource_limits
+
+        Get max CPU and memory limits of all nodes within k8s cluster
+        """
+        pass
+
+    def test_get_kubernetes_metrics_for_all_nodes(self) -> None:
+        """Test case for get_kubernetes_metrics_for_all_nodes
+
+        Get a list of nodes with their live metrics
+        """
+        pass
+
+    def test_get_kubernetes_metrics_for_all_pods(self) -> None:
+        """Test case for get_kubernetes_metrics_for_all_pods
+
+        Get a list of pods with their live metrics
+        """
+        pass
+
+    def test_get_kubernetes_metrics_for_node(self) -> None:
+        """Test case for get_kubernetes_metrics_for_node
+
+        Get live metrics for a node
+        """
+        pass
+
+    def test_get_kubernetes_metrics_for_pod(self) -> None:
+        """Test case for get_kubernetes_metrics_for_pod
+
+        Get live metrics for a pod
+        """
+        pass
+
+    def test_get_kubernetes_namespace(self) -> None:
+        """Test case for get_kubernetes_namespace
+
+        Get namespace details
+        """
+        pass
+
+    def test_get_kubernetes_namespaces(self) -> None:
+        """Test case for get_kubernetes_namespaces
+
+        Get a list of namespaces
+        """
+        pass
+
+    def test_get_kubernetes_namespaces_count(self) -> None:
+        """Test case for get_kubernetes_namespaces_count
+
+        Get the total number of kubernetes namespaces within the given Portainer environment.
+        """
+        pass
+
+    def test_get_kubernetes_nodes_limits(self) -> None:
+        """Test case for get_kubernetes_nodes_limits
+
+        Get CPU and memory limits of all nodes within k8s cluster
+        """
+        pass
+
+    def test_get_kubernetes_rbac_status(self) -> None:
+        """Test case for get_kubernetes_rbac_status
+
+        Check if RBAC is enabled
+        """
+        pass
+
+    def test_get_kubernetes_role_bindings(self) -> None:
+        """Test case for get_kubernetes_role_bindings
+
+        Get a list of kubernetes role bindings
+        """
+        pass
+
+    def test_get_kubernetes_roles(self) -> None:
+        """Test case for get_kubernetes_roles
+
+        Get a list of kubernetes roles
+        """
+        pass
+
+    def test_get_kubernetes_secret(self) -> None:
+        """Test case for get_kubernetes_secret
+
+        Get a Secret
+        """
+        pass
+
+    def test_get_kubernetes_secrets(self) -> None:
+        """Test case for get_kubernetes_secrets
+
+        Get a list of Secrets
+        """
+        pass
+
+    def test_get_kubernetes_secrets_count(self) -> None:
+        """Test case for get_kubernetes_secrets_count
+
+        Get Secrets count
+        """
+        pass
+
+    def test_get_kubernetes_service_accounts(self) -> None:
+        """Test case for get_kubernetes_service_accounts
+
+        Get a list of kubernetes service accounts
+        """
+        pass
+
+    def test_get_kubernetes_services(self) -> None:
+        """Test case for get_kubernetes_services
+
+        Get a list of services
+        """
+        pass
+
+    def test_get_kubernetes_services_by_namespace(self) -> None:
+        """Test case for get_kubernetes_services_by_namespace
+
+        Get a list of services for a given namespace
+        """
+        pass
+
+    def test_get_kubernetes_volume(self) -> None:
+        """Test case for get_kubernetes_volume
+
+        Get a Kubernetes volume within the given Portainer environment
+        """
+        pass
+
+    def test_get_kubernetes_volumes_in_namespace(self) -> None:
+        """Test case for get_kubernetes_volumes_in_namespace
+
+        Get Kubernetes volumes within a namespace in the given Portainer environment
+        """
+        pass
+
+    def test_kubernetes_namespaces_toggle_system(self) -> None:
+        """Test case for kubernetes_namespaces_toggle_system
+
+        Toggle the system state for a namespace
+        """
+        pass
+
+    def test_update_kubernetes_ingress(self) -> None:
+        """Test case for update_kubernetes_ingress
+
+        Update an Ingress
+        """
+        pass
+
+    def test_update_kubernetes_ingress_controllers(self) -> None:
+        """Test case for update_kubernetes_ingress_controllers
+
+        Update (block/unblock) ingress controllers
+        """
+        pass
+
+    def test_update_kubernetes_ingress_controllers_by_namespace(self) -> None:
+        """Test case for update_kubernetes_ingress_controllers_by_namespace
+
+        Update (block/unblock) ingress controllers by namespace
+        """
+        pass
+
+    def test_update_kubernetes_namespace(self) -> None:
+        """Test case for update_kubernetes_namespace
+
+        Update a namespace
+        """
+        pass
+
+    def test_update_kubernetes_namespace_deprecated(self) -> None:
+        """Test case for update_kubernetes_namespace_deprecated
+
+        Update a namespace
+        """
+        pass
+
+    def test_update_kubernetes_service(self) -> None:
+        """Test case for update_kubernetes_service
+
+        Update a service
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_kubernetes_configuration.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from openapi_client.models.kubernetes_configuration import KubernetesConfiguration
+
+class TestKubernetesConfiguration(unittest.TestCase):
+    """KubernetesConfiguration unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> KubernetesConfiguration:
+        """Test KubernetesConfiguration
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `KubernetesConfiguration`
+        """
+        model = KubernetesConfiguration()
+        if include_optional:
+            return KubernetesConfiguration(
+                configuration_owner = '',
+                data = { },
+                kind = ''
+            )
+        else:
+            return KubernetesConfiguration(
+        )
+        """
+
+    def testKubernetesConfiguration(self):
+        """Test KubernetesConfiguration"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_kubernetes_custom_resource_metadata.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from openapi_client.models.kubernetes_custom_resource_metadata import KubernetesCustomResourceMetadata
+
+class TestKubernetesCustomResourceMetadata(unittest.TestCase):
+    """KubernetesCustomResourceMetadata unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> KubernetesCustomResourceMetadata:
+        """Test KubernetesCustomResourceMetadata
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `KubernetesCustomResourceMetadata`
+        """
+        model = KubernetesCustomResourceMetadata()
+        if include_optional:
+            return KubernetesCustomResourceMetadata(
+                api_version = '',
+                kind = '',
+                plural = ''
+            )
+        else:
+            return KubernetesCustomResourceMetadata(
+        )
+        """
+
+    def testKubernetesCustomResourceMetadata(self):
+        """Test KubernetesCustomResourceMetadata"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

ptctools/portainer_client/openapi_client/test/test_kubernetes_describe_resource_response.py

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+"""
+    PortainerCE API
+
+    Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).  # Authentication  Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request with the **Bearer** authentication mechanism.  Example:  ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ```  # Security  Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).  Different access policies are available:  - Public access - Authenticated access - Restricted access - Administrator access  ### Public access  No authentication is required to access the environments(endpoints) with this access policy.  ### Authenticated access  Authentication is required to access the environments(endpoints) with this access policy.  ### Restricted access  Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.  ### Administrator access  Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.  # Execute Docker requests  Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).  Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.  To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).  # Private Registry  Using private registry, you will need to pass a based64 encoded JSON string ‘{\"registryId\":\\<registryID value\\>}’ inside the Request Header. The parameter name is \"X-Registry-Auth\". \\<registryID value\\> - The registry ID where the repository was created.  Example:  ``` eyJyZWdpc3RyeUlkIjoxfQ== ```  **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/). 
+
+    The version of the OpenAPI document: 2.33.6
+    Contact: info@portainer.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from openapi_client.models.kubernetes_describe_resource_response import KubernetesDescribeResourceResponse
+
+class TestKubernetesDescribeResourceResponse(unittest.TestCase):
+    """KubernetesDescribeResourceResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> KubernetesDescribeResourceResponse:
+        """Test KubernetesDescribeResourceResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `KubernetesDescribeResourceResponse`
+        """
+        model = KubernetesDescribeResourceResponse()
+        if include_optional:
+            return KubernetesDescribeResourceResponse(
+                describe = ''
+            )
+        else:
+            return KubernetesDescribeResourceResponse(
+        )
+        """
+
+    def testKubernetesDescribeResourceResponse(self):
+        """Test KubernetesDescribeResourceResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()