Merge pull request #76 from skekre98/sdk-docs

added docs for python sdk api

sdk/python/docs/AIInferencingRuntime.md

@@ -0,0 +1,10 @@
+# AIInferencingRuntime
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accelerator_device** | **str** |  | [optional] 
+**framework_type** | **str** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AIInferencingServiceProfile.md

@@ -0,0 +1,10 @@
+# AIInferencingServiceProfile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enable** | **bool** |  | [optional] 
+**runtime** | [**list[AIInferencingRuntime]**](AIInferencingRuntime.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/APIErrorPayload.md

@@ -0,0 +1,11 @@
+# APIErrorPayload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_code** | **int** | Karbon Platform Services API error code | 
+**message** | **str** | Error message | 
+**status_code** | **int** | HTTP status code for the response | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AWSCredential.md

@@ -0,0 +1,10 @@
+# AWSCredential
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_key** | **str** | Provide the AWS Access Key Id for programmatic access to the AWS services | 
+**secret** | **str** | Provide the AWS Secret Key for programmatic access to the AWS services | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AZCredential.md

@@ -0,0 +1,10 @@
+# AZCredential
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage_account_name** | **str** | Azure storage account name and access key. When you create a storage account, Azure generates 2 access keys. Provide the primary access key here. | 
+**storage_key** | **str** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AdditionalItem.md

@@ -0,0 +1,11 @@
+# AdditionalItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**icon** | **str** |  | [optional] 
+**title** | **str** |  | [optional] 
+**value** | **str** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/Address.md

@@ -0,0 +1,11 @@
+# Address
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **str** |  | [optional] 
+**kind** | **str** |  | [optional] 
+**name** | **str** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/Addresses.md

@@ -0,0 +1,8 @@
+# Addresses
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AggregateInfo.md

@@ -0,0 +1,10 @@
+# AggregateInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**doc_count** | **int** |  | 
+**key** | **str** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AggregateSpec.md

@@ -0,0 +1,10 @@
+# AggregateSpec
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **str** |  | 
+**type** | **str** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/Aggregation.md

@@ -0,0 +1,10 @@
+# Aggregation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **str** |  | [optional] 
+**label** | **str** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/App.md

@@ -0,0 +1,13 @@
+# App
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the application | 
+**namespace** | [**Namespace**](Namespace.md) |  | 
+**runtimes** | [**list[Runtime]**](Runtime.md) | Runtimes and associated dashboards | [optional] 
+**service_names** | **list[str]** | List of service names linked with an application | 
+**workloads** | [**list[WorkloadItem]**](WorkloadItem.md) | Workloads for a given application | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AppHealth.md

@@ -0,0 +1,10 @@
+# AppHealth
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**RequestHealth**](RequestHealth.md) |  | [optional] 
+**workload_statuses** | [**list[WorkloadStatus]**](WorkloadStatus.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AppList.md

@@ -0,0 +1,10 @@
+# AppList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applications** | [**list[AppListItem]**](AppListItem.md) | Applications for a given namespace | 
+**namespace** | [**Namespace**](Namespace.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AppListItem.md

@@ -0,0 +1,11 @@
+# AppListItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**istio_sidecar** | **bool** | Define if all Pods related to the Workloads of this app has an IstioSidecar deployed | 
+**labels** | **dict(str, str)** | Labels for App | [optional] 
+**name** | **str** | Name of the application | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AppOverview.md

@@ -0,0 +1,12 @@
+# AppOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | [**App**](App.md) |  | [optional] 
+**health** | [**AppHealth**](AppHealth.md) |  | [optional] 
+**inbound** | [**DashboardResponse**](DashboardResponse.md) |  | [optional] 
+**outbound** | [**DashboardResponse**](DashboardResponse.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/AppStatus.md

@@ -0,0 +1,11 @@
+# AppStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_list** | **list[str]** |  | [optional] 
+**pod_metrics_list** | [**list[PodMetrics]**](PodMetrics.md) |  | [optional] 
+**pod_status_list** | [**list[PodStatus]**](PodStatus.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

sdk/python/docs/Application.md

@@ -0,0 +1,23 @@
+# Application
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_ifc_endpoints** | [**list[DataIfcEndpoint]**](DataIfcEndpoint.md) | DataIfcEndpoints is a list of endpoints exposed to an application. | [optional] 
+**description** | **str** | A description of the application. Maximum length of 200 characters. | [optional] 
+**edge_ids** | **list[str]** | Edges listed according to ID where the application is deployed. Only relevant if the parent project EdgeSelectorType value is set to Explicit. | [optional] 
+**edge_selectors** | [**list[CategoryInfo]**](CategoryInfo.md) | Select edges according to CategoryInfo. Only relevant if the parent project EdgeSelectorType value is set to Category. | [optional] 
+**exclude_edge_ids** | **list[str]** | Edges to be excluded from the application deployment. | [optional] 
+**helm_metadata** | [**HelmAppMetadata**](HelmAppMetadata.md) |  | [optional] 
+**id** | **str** | ID of the entity Maximum character length is 64 for project, category, and runtime environment, 36 for other entity types. | [optional] 
+**name** | **str** | The application name. Maximum length of 200 characters. | 
+**only_pre_pull_on_update** | **bool** | Only pre-pull images on service domains w/o doing an actual update. Service domain which have not yet deployed the app will deploy application like usual. Update will commence once this flag is unset. | [optional] 
+**origin_selectors** | [**list[CategoryInfo]**](CategoryInfo.md) | OriginSelectors is the list of CategoryInfo used as criteria to feed data into applications. | [optional] 
+**packaging_type** | **str** | PackagingType vanilla or helm, nil = vanilla | [optional] 
+**project_id** | **str** | Parent project ID. Not required (to maintain backward compatibility). | 
+**state** | **str** | State of this entity | [optional] 
+**user_id** | **str** | Last modified user ID. Only required by edge for privilege check. | [optional] 
+**yaml_data** | **str** | The YAML content for the application. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+