last demo import - cleaned
This commit is contained in:
95
api-client/oc-catalog/docs/ComputingApi.md
Normal file
95
api-client/oc-catalog/docs/ComputingApi.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# \ComputingApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**ComputingControllerAddComputing**](ComputingApi.md#ComputingControllerAddComputing) | **Post** /computing/ |
|
||||
[**ComputingControllerGetComputingByID**](ComputingApi.md#ComputingControllerGetComputingByID) | **Get** /computing/{ID} |
|
||||
[**ComputingControllerGetMultipleComputingByIDs**](ComputingApi.md#ComputingControllerGetMultipleComputingByIDs) | **Get** /computing/multi/{IDs} |
|
||||
|
||||
|
||||
# **ComputingControllerAddComputing**
|
||||
> ComputingControllerAddComputing(ctx, body)
|
||||
|
||||
|
||||
Submit a computing object
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**ModelsComputingNewModel**](ModelsComputingNewModel.md)| The object content |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **ComputingControllerGetComputingByID**
|
||||
> ModelsComputingModel ComputingControllerGetComputingByID(ctx, iD)
|
||||
|
||||
|
||||
Find a computing resource based on ID
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iD** | **string**| The ID of the resource |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsComputingModel**](models.ComputingModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **ComputingControllerGetMultipleComputingByIDs**
|
||||
> []ModelsComputingModel ComputingControllerGetMultipleComputingByIDs(ctx, iDs)
|
||||
|
||||
|
||||
Return Computing objects if found in the DB. Not found IDs will be ignored
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iDs** | [**[]string**](string.md)| List of computing IDs |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsComputingModel**](models.ComputingModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
95
api-client/oc-catalog/docs/DataApi.md
Normal file
95
api-client/oc-catalog/docs/DataApi.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# \DataApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DataControllerCreateData**](DataApi.md#DataControllerCreateData) | **Post** /data/ |
|
||||
[**DataControllerGetDataByID**](DataApi.md#DataControllerGetDataByID) | **Get** /data/{ID} |
|
||||
[**DataControllerGetMultipleDataByIDs**](DataApi.md#DataControllerGetMultipleDataByIDs) | **Get** /data/multi/{IDs} |
|
||||
|
||||
|
||||
# **DataControllerCreateData**
|
||||
> DataControllerCreateData(ctx, body)
|
||||
|
||||
|
||||
Submit data object
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**ModelsDataNewModel**](ModelsDataNewModel.md)| The object content |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **DataControllerGetDataByID**
|
||||
> ModelsDataModel DataControllerGetDataByID(ctx, iD)
|
||||
|
||||
|
||||
Find rType data based on ID
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iD** | **string**| The ID of the data resource |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsDataModel**](models.DataModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **DataControllerGetMultipleDataByIDs**
|
||||
> []ModelsDataModel DataControllerGetMultipleDataByIDs(ctx, iDs)
|
||||
|
||||
|
||||
Return Data object if found in the DB. Not found IDs will be ignored
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iDs** | [**[]string**](string.md)| List of data IDs |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsDataModel**](models.DataModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
95
api-client/oc-catalog/docs/DatacenterApi.md
Normal file
95
api-client/oc-catalog/docs/DatacenterApi.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# \DatacenterApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**DatacenterControllerCreateDatacenter**](DatacenterApi.md#DatacenterControllerCreateDatacenter) | **Post** /datacenter/ |
|
||||
[**DatacenterControllerGetMultipleDatacentersByIDs**](DatacenterApi.md#DatacenterControllerGetMultipleDatacentersByIDs) | **Get** /datacenter/multi/{IDs} |
|
||||
[**DatacenterControllerGetOneDatacenter**](DatacenterApi.md#DatacenterControllerGetOneDatacenter) | **Get** /datacenter/{ID} |
|
||||
|
||||
|
||||
# **DatacenterControllerCreateDatacenter**
|
||||
> DatacenterControllerCreateDatacenter(ctx, body)
|
||||
|
||||
|
||||
submit Datacenter object
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**ModelsDatacenterNewModel**](ModelsDatacenterNewModel.md)| The object content |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **DatacenterControllerGetMultipleDatacentersByIDs**
|
||||
> []ModelsComputingModel DatacenterControllerGetMultipleDatacentersByIDs(ctx, iDs)
|
||||
|
||||
|
||||
Return Datacenter objects if found in the DB. Not found IDs will be ignored
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iDs** | [**[]string**](string.md)| List of datacenter IDs |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsComputingModel**](models.ComputingModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **DatacenterControllerGetOneDatacenter**
|
||||
> ModelsDatacenterModel DatacenterControllerGetOneDatacenter(ctx, iD)
|
||||
|
||||
|
||||
find datacenter by ID
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iD** | **string**| the ID you want to get |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsDatacenterModel**](models.DatacenterModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
22
api-client/oc-catalog/docs/ModelsComputingModel.md
Normal file
22
api-client/oc-catalog/docs/ModelsComputingModel.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ModelsComputingModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Dinputs** | **[]string** | | [optional] [default to null]
|
||||
**Doutputs** | **[]string** | | [optional] [default to null]
|
||||
**ID** | **string** | | [default to null]
|
||||
**Description** | **string** | | [optional] [default to null]
|
||||
**ExecutionRequirements** | [***ModelsExecutionRequirementsModel**](models.ExecutionRequirementsModel.md) | | [optional] [default to null]
|
||||
**License** | **string** | | [optional] [default to null]
|
||||
**Logo** | **string** | | [optional] [default to null]
|
||||
**Name** | **string** | Name of the computing | [optional] [default to null]
|
||||
**Owner** | **string** | | [optional] [default to null]
|
||||
**Price** | **int32** | | [optional] [default to null]
|
||||
**Repository** | [***ModelsRepositoryModel**](models.RepositoryModel.md) | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [optional] [default to null]
|
||||
**Type_** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
21
api-client/oc-catalog/docs/ModelsComputingNewModel.md
Normal file
21
api-client/oc-catalog/docs/ModelsComputingNewModel.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# ModelsComputingNewModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Dinputs** | **[]string** | | [optional] [default to null]
|
||||
**Doutputs** | **[]string** | | [optional] [default to null]
|
||||
**Description** | **string** | | [default to null]
|
||||
**ExecutionRequirements** | [***ModelsExecutionRequirementsModel**](models.ExecutionRequirementsModel.md) | | [optional] [default to null]
|
||||
**License** | **string** | | [optional] [default to null]
|
||||
**Logo** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the computing | [default to null]
|
||||
**Owner** | **string** | | [optional] [default to null]
|
||||
**Price** | **int32** | | [optional] [default to null]
|
||||
**Repository** | [***ModelsRepositoryModel**](models.RepositoryModel.md) | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [default to null]
|
||||
**Type_** | **string** | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
api-client/oc-catalog/docs/ModelsComputingObject.md
Normal file
13
api-client/oc-catalog/docs/ModelsComputingObject.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ModelsComputingObject
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DatacenterID** | **string** | Datacenter where the computing will be executed | [optional] [default to null]
|
||||
**Inputs** | **[]string** | | [optional] [default to null]
|
||||
**Outputs** | **[]string** | | [optional] [default to null]
|
||||
**ReferenceID** | [***PrimitiveObjectId**](primitive.ObjectID.md) | Computing model ID | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
api-client/oc-catalog/docs/ModelsDCstatus.md
Normal file
15
api-client/oc-catalog/docs/ModelsDCstatus.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# ModelsDCstatus
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Booked** | [***ModelsScheduleInfo**](models.ScheduleInfo.md) | | [optional] [default to null]
|
||||
**DCname** | **string** | | [optional] [default to null]
|
||||
**DCobjID** | **string** | | [optional] [default to null]
|
||||
**ErrorMessage** | **string** | | [optional] [default to null]
|
||||
**IsAvailable** | **bool** | | [optional] [default to null]
|
||||
**IsReachable** | **bool** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
19
api-client/oc-catalog/docs/ModelsDataModel.md
Normal file
19
api-client/oc-catalog/docs/ModelsDataModel.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# ModelsDataModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ID** | **string** | | [default to null]
|
||||
**Description** | **string** | | [optional] [default to null]
|
||||
**Dtype** | **string** | | [optional] [default to null]
|
||||
**Example** | **string** | base64 encoded data | [optional] [default to null]
|
||||
**Location** | **string** | | [optional] [default to null]
|
||||
**Logo** | **string** | | [optional] [default to null]
|
||||
**Name** | **string** | Name of the data | [optional] [default to null]
|
||||
**Protocol** | **[]string** | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [optional] [default to null]
|
||||
**Type_** | **string** | Define type of data | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
18
api-client/oc-catalog/docs/ModelsDataNewModel.md
Normal file
18
api-client/oc-catalog/docs/ModelsDataNewModel.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# ModelsDataNewModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Description** | **string** | | [default to null]
|
||||
**Dtype** | **string** | | [optional] [default to null]
|
||||
**Example** | **string** | base64 encoded data | [default to null]
|
||||
**Location** | **string** | | [default to null]
|
||||
**Logo** | **string** | | [default to null]
|
||||
**Name** | **string** | Name of the data | [default to null]
|
||||
**Protocol** | **[]string** | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [default to null]
|
||||
**Type_** | **string** | Define type of data | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
10
api-client/oc-catalog/docs/ModelsDataObject.md
Normal file
10
api-client/oc-catalog/docs/ModelsDataObject.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ModelsDataObject
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ReferenceID** | [***PrimitiveObjectId**](primitive.ObjectID.md) | Data model ID | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
api-client/oc-catalog/docs/ModelsDatacenterCpuModel.md
Normal file
14
api-client/oc-catalog/docs/ModelsDatacenterCpuModel.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# ModelsDatacenterCpuModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Architecture** | **string** | | [optional] [default to null]
|
||||
**Cores** | **int32** | | [default to null]
|
||||
**MinimumMemory** | **int32** | | [optional] [default to null]
|
||||
**Platform** | **string** | | [optional] [default to null]
|
||||
**Shared** | **bool** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
api-client/oc-catalog/docs/ModelsDatacenterGpuModel.md
Normal file
13
api-client/oc-catalog/docs/ModelsDatacenterGpuModel.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ModelsDatacenterGpuModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CudaCores** | **int32** | | [optional] [default to null]
|
||||
**Memory** | **int32** | Units in MB | [optional] [default to null]
|
||||
**Model** | **string** | | [optional] [default to null]
|
||||
**TensorCores** | **int32** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
11
api-client/oc-catalog/docs/ModelsDatacenterMemoryModel.md
Normal file
11
api-client/oc-catalog/docs/ModelsDatacenterMemoryModel.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ModelsDatacenterMemoryModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Ecc** | **bool** | | [optional] [default to null]
|
||||
**Size** | **int32** | Units in MB | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
22
api-client/oc-catalog/docs/ModelsDatacenterModel.md
Normal file
22
api-client/oc-catalog/docs/ModelsDatacenterModel.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# ModelsDatacenterModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ID** | **string** | | [default to null]
|
||||
**Acronym** | **string** | id of the DC | [optional] [default to null]
|
||||
**BookingPrice** | **int64** | | [optional] [default to null]
|
||||
**Cpu** | [***ModelsDatacenterCpuModel**](models.DatacenterCpuModel.md) | | [optional] [default to null]
|
||||
**Description** | **string** | | [optional] [default to null]
|
||||
**Gpu** | [**[]ModelsDatacenterGpuModel**](models.DatacenterGpuModel.md) | | [optional] [default to null]
|
||||
**Hosts** | **[]string** | list of host:port | [optional] [default to null]
|
||||
**Logo** | **string** | | [optional] [default to null]
|
||||
**Name** | **string** | | [optional] [default to null]
|
||||
**Owner** | **string** | | [optional] [default to null]
|
||||
**Ram** | [***ModelsDatacenterMemoryModel**](models.DatacenterMemoryModel.md) | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [optional] [default to null]
|
||||
**Type_** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
21
api-client/oc-catalog/docs/ModelsDatacenterNewModel.md
Normal file
21
api-client/oc-catalog/docs/ModelsDatacenterNewModel.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# ModelsDatacenterNewModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Acronym** | **string** | id of the DC | [default to null]
|
||||
**BookingPrice** | **int64** | | [optional] [default to null]
|
||||
**Cpu** | [***ModelsDatacenterCpuModel**](models.DatacenterCpuModel.md) | | [default to null]
|
||||
**Description** | **string** | | [default to null]
|
||||
**Gpu** | [**[]ModelsDatacenterGpuModel**](models.DatacenterGpuModel.md) | | [default to null]
|
||||
**Hosts** | **[]string** | list of host:port | [default to null]
|
||||
**Logo** | **string** | | [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**Owner** | **string** | | [optional] [default to null]
|
||||
**Ram** | [***ModelsDatacenterMemoryModel**](models.DatacenterMemoryModel.md) | | [default to null]
|
||||
**ShortDescription** | **string** | | [default to null]
|
||||
**Type_** | **string** | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
10
api-client/oc-catalog/docs/ModelsDatacenterObject.md
Normal file
10
api-client/oc-catalog/docs/ModelsDatacenterObject.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ModelsDatacenterObject
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ReferenceID** | [***PrimitiveObjectId**](primitive.ObjectID.md) | Data model ID | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# ModelsExecutionRequirementsModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Cpus** | **int32** | | [default to null]
|
||||
**DiskIo** | **string** | | [optional] [default to null]
|
||||
**Gpus** | **int32** | Amount of GPUs needed | [optional] [default to null]
|
||||
**Parallel** | **bool** | | [optional] [default to null]
|
||||
**Ram** | **int32** | Units in MB | [default to null]
|
||||
**ScalingModel** | **int32** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
11
api-client/oc-catalog/docs/ModelsRepositoryModel.md
Normal file
11
api-client/oc-catalog/docs/ModelsRepositoryModel.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ModelsRepositoryModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Credentials** | **string** | | [optional] [default to null]
|
||||
**Url** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
api-client/oc-catalog/docs/ModelsScheduleDb.md
Normal file
13
api-client/oc-catalog/docs/ModelsScheduleDb.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ModelsScheduleDb
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ResourceQty** | [***ModelsExecutionRequirementsModel**](models.ExecutionRequirementsModel.md) | | [optional] [default to null]
|
||||
**StartDate** | **string** | | [optional] [default to null]
|
||||
**StopDate** | **string** | | [optional] [default to null]
|
||||
**Workflow** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
11
api-client/oc-catalog/docs/ModelsScheduleInfo.md
Normal file
11
api-client/oc-catalog/docs/ModelsScheduleInfo.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ModelsScheduleInfo
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**NextExecutions** | **[]string** | | [optional] [default to null]
|
||||
**Total** | **int64** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
9
api-client/oc-catalog/docs/ModelsScheduleTime.md
Normal file
9
api-client/oc-catalog/docs/ModelsScheduleTime.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# ModelsScheduleTime
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
13
api-client/oc-catalog/docs/ModelsSearchResult.md
Normal file
13
api-client/oc-catalog/docs/ModelsSearchResult.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ModelsSearchResult
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Computing** | [**[]ModelsComputingModel**](models.ComputingModel.md) | | [default to null]
|
||||
**Data** | [**[]ModelsDataModel**](models.DataModel.md) | | [optional] [default to null]
|
||||
**Datacenter** | [**[]ModelsDatacenterModel**](models.DatacenterModel.md) | | [optional] [default to null]
|
||||
**Storage** | [**[]ModelsStorageModel**](models.StorageModel.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
21
api-client/oc-catalog/docs/ModelsStorageModel.md
Normal file
21
api-client/oc-catalog/docs/ModelsStorageModel.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# ModelsStorageModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DCacronym** | **string** | Unique ID of the DC where it is the storage | [optional] [default to null]
|
||||
**ID** | **string** | | [default to null]
|
||||
**BookingPrice** | **int32** | | [optional] [default to null]
|
||||
**Description** | **string** | | [optional] [default to null]
|
||||
**Encryption** | **bool** | | [optional] [default to null]
|
||||
**Logo** | **string** | | [optional] [default to null]
|
||||
**Name** | **string** | | [optional] [default to null]
|
||||
**Redundancy** | **string** | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [optional] [default to null]
|
||||
**Size** | **int32** | | [optional] [default to null]
|
||||
**Throughput** | **string** | | [optional] [default to null]
|
||||
**Type_** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
api-client/oc-catalog/docs/ModelsStorageNewModel.md
Normal file
20
api-client/oc-catalog/docs/ModelsStorageNewModel.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# ModelsStorageNewModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DCacronym** | **string** | Unique ID of the DC where it is the storage | [default to null]
|
||||
**BookingPrice** | **int32** | | [optional] [default to null]
|
||||
**Description** | **string** | | [default to null]
|
||||
**Encryption** | **bool** | | [optional] [default to null]
|
||||
**Logo** | **string** | | [default to null]
|
||||
**Name** | **string** | | [default to null]
|
||||
**Redundancy** | **string** | | [optional] [default to null]
|
||||
**ShortDescription** | **string** | | [default to null]
|
||||
**Size** | **int32** | | [default to null]
|
||||
**Throughput** | **string** | | [optional] [default to null]
|
||||
**Type_** | **string** | | [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
api-client/oc-catalog/docs/ModelsStorageObject.md
Normal file
12
api-client/oc-catalog/docs/ModelsStorageObject.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# ModelsStorageObject
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Inputs** | **[]string** | | [optional] [default to null]
|
||||
**Outputs** | **[]string** | | [optional] [default to null]
|
||||
**ReferenceID** | [***PrimitiveObjectId**](primitive.ObjectID.md) | Storage model ID | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
api-client/oc-catalog/docs/ModelsWorkflow.md
Normal file
15
api-client/oc-catalog/docs/ModelsWorkflow.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# ModelsWorkflow
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**MxgraphXML** | **string** | State of the mxgraph | [optional] [default to null]
|
||||
**Computing** | [***ModelsComputingObject**](models.ComputingObject.md) | | [optional] [default to null]
|
||||
**Data** | [***ModelsDataObject**](models.DataObject.md) | | [optional] [default to null]
|
||||
**Datacenter** | [***ModelsDatacenterObject**](models.DatacenterObject.md) | | [optional] [default to null]
|
||||
**Schedules** | [***ModelsWorkflowSchedule**](models.WorkflowSchedule.md) | | [optional] [default to null]
|
||||
**Storage** | [***ModelsStorageObject**](models.StorageObject.md) | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
16
api-client/oc-catalog/docs/ModelsWorkflowSchedule.md
Normal file
16
api-client/oc-catalog/docs/ModelsWorkflowSchedule.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# ModelsWorkflowSchedule
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IsService** | **bool** | Service: true, Task: false | [optional] [default to null]
|
||||
**StartDate** | **string** | | [optional] [default to null]
|
||||
**StopDate** | **string** | | [optional] [default to null]
|
||||
**Cron** | **string** | | [optional] [default to null]
|
||||
**Duration** | **int32** | Durantion in seconds | [optional] [default to null]
|
||||
**Events** | **string** | | [optional] [default to null]
|
||||
**IsBooked** | **bool** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
api-client/oc-catalog/docs/ModelsWorkspace.md
Normal file
15
api-client/oc-catalog/docs/ModelsWorkspace.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# ModelsWorkspace
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Workflows** | [***ModelsWorkflow**](models.Workflow.md) | | [optional] [default to null]
|
||||
**Computing** | **[]string** | | [optional] [default to null]
|
||||
**Data** | **[]string** | | [optional] [default to null]
|
||||
**Datacenter** | **[]string** | | [optional] [default to null]
|
||||
**Storage** | **[]string** | | [optional] [default to null]
|
||||
**UserId** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
api-client/oc-catalog/docs/ModelsWorkspaceModel.md
Normal file
14
api-client/oc-catalog/docs/ModelsWorkspaceModel.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# ModelsWorkspaceModel
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Computing** | [**[]ModelsComputingModel**](models.ComputingModel.md) | | [optional] [default to null]
|
||||
**Data** | [**[]ModelsDataModel**](models.DataModel.md) | | [optional] [default to null]
|
||||
**Datacenter** | [**[]ModelsDatacenterModel**](models.DatacenterModel.md) | | [optional] [default to null]
|
||||
**Storage** | [**[]ModelsStorageModel**](models.StorageModel.md) | | [optional] [default to null]
|
||||
**UserId** | **string** | | [optional] [default to null]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
9
api-client/oc-catalog/docs/PrimitiveObjectId.md
Normal file
9
api-client/oc-catalog/docs/PrimitiveObjectId.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# PrimitiveObjectId
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
164
api-client/oc-catalog/docs/ScheduleApi.md
Normal file
164
api-client/oc-catalog/docs/ScheduleApi.md
Normal file
@@ -0,0 +1,164 @@
|
||||
# \ScheduleApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC**](ScheduleApi.md#ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC) | **Post** /schedule/check |
|
||||
[**ScheduleControllerCreateSchedule**](ScheduleApi.md#ScheduleControllerCreateSchedule) | **Post** /schedule/book |
|
||||
[**ScheduleControllerGetNextSchedule**](ScheduleApi.md#ScheduleControllerGetNextSchedule) | **Get** /schedule/next |
|
||||
[**ScheduleControllerGetPreviousSchedule**](ScheduleApi.md#ScheduleControllerGetPreviousSchedule) | **Get** /schedule/previous |
|
||||
[**ScheduleControllerGetSchedules**](ScheduleApi.md#ScheduleControllerGetSchedules) | **Get** /schedule/ |
|
||||
|
||||
|
||||
# **ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC**
|
||||
> ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC(ctx, cron, duration, startDate, stopDate, requirements)
|
||||
|
||||
|
||||
Check for availability of this DC
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**cron** | **string**| Cron syntax |
|
||||
**duration** | **int32**| Duration in seconds |
|
||||
**startDate** | [**interface{}**](.md)| RFC3339 time for startDate |
|
||||
**stopDate** | [**interface{}**](.md)| RFC3339 time for stopDate |
|
||||
**requirements** | [**ModelsExecutionRequirementsModel**](ModelsExecutionRequirementsModel.md)| The object content |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **ScheduleControllerCreateSchedule**
|
||||
> ModelsScheduleInfo ScheduleControllerCreateSchedule(ctx, dcName, workflowName, cron, duration, startDate, stopDate, requirements)
|
||||
|
||||
|
||||
Create schedule for a workflow. It will return some future executions just as information
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**dcName** | **string**| Name of the node (oc-catalog) from where the workflow comes. |
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
**cron** | **string**| Cron syntax with year. If no year is specified, will use the current |
|
||||
**duration** | **int32**| Duration in seconds |
|
||||
**startDate** | [**interface{}**](.md)| RFC3339 time for startDate |
|
||||
**stopDate** | [**interface{}**](.md)| RFC3339 time for stopDate |
|
||||
**requirements** | [**ModelsExecutionRequirementsModel**](ModelsExecutionRequirementsModel.md)| The object content |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsScheduleInfo**](models.ScheduleInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **ScheduleControllerGetNextSchedule**
|
||||
> TimeTime ScheduleControllerGetNextSchedule(ctx, baseDate)
|
||||
|
||||
|
||||
Give a date, get the next date where there are at least on schedule. If no hours specified, will assume 00:00
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**baseDate** | [**interface{}**](.md)| Base date |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TimeTime**](*time.Time.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **ScheduleControllerGetPreviousSchedule**
|
||||
> TimeTime ScheduleControllerGetPreviousSchedule(ctx, baseDate)
|
||||
|
||||
|
||||
Give a date, get the previous date where there are at least on schedule. If no hours specified, will assume 00:00
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**baseDate** | [**interface{}**](.md)| Base date |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TimeTime**](*time.Time.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **ScheduleControllerGetSchedules**
|
||||
> []ModelsScheduleDb ScheduleControllerGetSchedules(ctx, startDate, stopDate)
|
||||
|
||||
|
||||
Get a list of next startDates schedules (inclusive). If timezone is not specified, will assume UTC
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**startDate** | [**interface{}**](.md)| Start date |
|
||||
**stopDate** | [**interface{}**](.md)| End date |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsScheduleDb**](models.ScheduleDB.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
37
api-client/oc-catalog/docs/SearchApi.md
Normal file
37
api-client/oc-catalog/docs/SearchApi.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# \SearchApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**SearchControllerSearchByWord**](SearchApi.md#SearchControllerSearchByWord) | **Get** /search/byWord |
|
||||
|
||||
|
||||
# **SearchControllerSearchByWord**
|
||||
> ModelsSearchResult SearchControllerSearchByWord(ctx, word)
|
||||
|
||||
|
||||
find resources by word
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**word** | **string**| Word to search across all resources |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsSearchResult**](models.SearchResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
95
api-client/oc-catalog/docs/StorageApi.md
Normal file
95
api-client/oc-catalog/docs/StorageApi.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# \StorageApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**StorageControllerCreateStorage**](StorageApi.md#StorageControllerCreateStorage) | **Post** /storage/ |
|
||||
[**StorageControllerGet**](StorageApi.md#StorageControllerGet) | **Get** /storage/{ID} |
|
||||
[**StorageControllerGetMultipleStoragesByIDs**](StorageApi.md#StorageControllerGetMultipleStoragesByIDs) | **Get** /storage/multi/{IDs} |
|
||||
|
||||
|
||||
# **StorageControllerCreateStorage**
|
||||
> StorageControllerCreateStorage(ctx, body)
|
||||
|
||||
|
||||
submit storage object
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**body** | [**ModelsStorageNewModel**](ModelsStorageNewModel.md)| The object content |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **StorageControllerGet**
|
||||
> ModelsStorageModel StorageControllerGet(ctx, iD)
|
||||
|
||||
|
||||
find storage by ID
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iD** | **string**| the ID you want to get |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsStorageModel**](models.StorageModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **StorageControllerGetMultipleStoragesByIDs**
|
||||
> []ModelsComputingModel StorageControllerGetMultipleStoragesByIDs(ctx, iDs)
|
||||
|
||||
|
||||
Return Storage objects if found in the DB. Not found IDs will be ignored
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**iDs** | [**[]string**](string.md)| List of storage IDs |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsComputingModel**](models.ComputingModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
9
api-client/oc-catalog/docs/TimeTime.md
Normal file
9
api-client/oc-catalog/docs/TimeTime.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# TimeTime
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
63
api-client/oc-catalog/docs/UserApi.md
Normal file
63
api-client/oc-catalog/docs/UserApi.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# \UserApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**UserControllerLogin**](UserApi.md#UserControllerLogin) | **Get** /user/login |
|
||||
[**UserControllerLogout**](UserApi.md#UserControllerLogout) | **Get** /user/logout |
|
||||
|
||||
|
||||
# **UserControllerLogin**
|
||||
> UserControllerLogin(ctx, username, password)
|
||||
|
||||
|
||||
Logs user into the system
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**username** | **string**| The username for login |
|
||||
**password** | **string**| The password for login |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **UserControllerLogout**
|
||||
> UserControllerLogout(ctx, )
|
||||
|
||||
|
||||
Logs out current logged in user session
|
||||
|
||||
### Required Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
345
api-client/oc-catalog/docs/WorkflowApi.md
Normal file
345
api-client/oc-catalog/docs/WorkflowApi.md
Normal file
@@ -0,0 +1,345 @@
|
||||
# \WorkflowApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**WorkflowControllerAddNewObjectToAWorkflow**](WorkflowApi.md#WorkflowControllerAddNewObjectToAWorkflow) | **Post** /workflow/{workflowName}/add |
|
||||
[**WorkflowControllerBookSchedule**](WorkflowApi.md#WorkflowControllerBookSchedule) | **Post** /workflow/{workflowName}/schedule/book |
|
||||
[**WorkflowControllerCheckSchedule**](WorkflowApi.md#WorkflowControllerCheckSchedule) | **Get** /workflow/{workflowName}/schedule/check |
|
||||
[**WorkflowControllerCreateANewWorkflow**](WorkflowApi.md#WorkflowControllerCreateANewWorkflow) | **Post** /workflow/ |
|
||||
[**WorkflowControllerCreateARealtionshipBetweenTwoRobjects**](WorkflowApi.md#WorkflowControllerCreateARealtionshipBetweenTwoRobjects) | **Post** /workflow/{workflowName}/link |
|
||||
[**WorkflowControllerGetMxGraphLastStatus**](WorkflowApi.md#WorkflowControllerGetMxGraphLastStatus) | **Get** /workflow/{workflowName}/mxGraphParser |
|
||||
[**WorkflowControllerGetSchedule**](WorkflowApi.md#WorkflowControllerGetSchedule) | **Get** /workflow/{workflowName}/schedule |
|
||||
[**WorkflowControllerGetWorkflow**](WorkflowApi.md#WorkflowControllerGetWorkflow) | **Get** /workflow/{workflowName} |
|
||||
[**WorkflowControllerListWorkflows**](WorkflowApi.md#WorkflowControllerListWorkflows) | **Get** /workflow/ |
|
||||
[**WorkflowControllerParseMxGraph**](WorkflowApi.md#WorkflowControllerParseMxGraph) | **Post** /workflow/{workflowName}/mxGraphParser |
|
||||
[**WorkflowControllerSetSchedule**](WorkflowApi.md#WorkflowControllerSetSchedule) | **Put** /workflow/{workflowName}/schedule |
|
||||
|
||||
|
||||
# **WorkflowControllerAddNewObjectToAWorkflow**
|
||||
> WorkflowControllerAddNewObjectToAWorkflow(ctx, workflowName, rID)
|
||||
|
||||
|
||||
Create a Rtype object from already added resources to the workspace
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| workflow Name |
|
||||
**rID** | **string**| rID of already existing item in Workspace |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerBookSchedule**
|
||||
> []ModelsDCstatus WorkflowControllerBookSchedule(ctx, workflowName)
|
||||
|
||||
|
||||
Book a schedule in all DCs of the workflow. Must set a desired schedule first!
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsDCstatus**](models.DCstatus.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerCheckSchedule**
|
||||
> []ModelsDCstatus WorkflowControllerCheckSchedule(ctx, workflowName)
|
||||
|
||||
|
||||
Check if we can schedule the project in other DCs. Must set a desired schedule first!
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]ModelsDCstatus**](models.DCstatus.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerCreateANewWorkflow**
|
||||
> WorkflowControllerCreateANewWorkflow(ctx, workflowName)
|
||||
|
||||
|
||||
Create a name for the new workflow
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Name of the workflow |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerCreateARealtionshipBetweenTwoRobjects**
|
||||
> WorkflowControllerCreateARealtionshipBetweenTwoRobjects(ctx, workflowName, rObjIDsource, isInput, rObjIDtarger)
|
||||
|
||||
|
||||
Create a Rtype object from already added resources to the workspace
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
**rObjIDsource** | **string**| Robject source. Usually Data |
|
||||
**isInput** | **bool**| If the operation is for input (true) linkage or output (false) |
|
||||
**rObjIDtarger** | **string**| Robject where will be written the association |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerGetMxGraphLastStatus**
|
||||
> WorkflowControllerGetMxGraphLastStatus(ctx, workflowName)
|
||||
|
||||
|
||||
Obtain the last mxgraph XML status from the workflow
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerGetSchedule**
|
||||
> ModelsScheduleTime WorkflowControllerGetSchedule(ctx, workflowName)
|
||||
|
||||
|
||||
Obtain the desired schedule of this workflow
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsScheduleTime**](models.ScheduleTime.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerGetWorkflow**
|
||||
> ModelsWorkflow WorkflowControllerGetWorkflow(ctx, workflowName)
|
||||
|
||||
|
||||
Get a workflow by name
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsWorkflow**](models.Workflow.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerListWorkflows**
|
||||
> WorkflowControllerListWorkflows(ctx, )
|
||||
|
||||
|
||||
List available workflows
|
||||
|
||||
### Required Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerParseMxGraph**
|
||||
> WorkflowControllerParseMxGraph(ctx, workflowName, xmlData)
|
||||
|
||||
|
||||
If we use this aproach to transofrm mxgraph representation in our representation, we should not use other API calls for modify the project structure or we'll have inconsistencies.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
**xmlData** | **string**| Xml representation of the workflow |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkflowControllerSetSchedule**
|
||||
> ModelsScheduleInfo WorkflowControllerSetSchedule(ctx, workflowName, isService, startDate, stopDate, optional)
|
||||
|
||||
|
||||
Set desired schedule by the user. No other effects a part of saving the user input
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**workflowName** | **string**| Workflow Name |
|
||||
**isService** | **bool**| True: Service, False: Task |
|
||||
**startDate** | [**interface{}**](.md)| RFC3339 time for startDate |
|
||||
**stopDate** | [**interface{}**](.md)| RFC3339 time for stopDate |
|
||||
**optional** | ***WorkflowApiWorkflowControllerSetScheduleOpts** | optional parameters | nil if no parameters
|
||||
|
||||
### Optional Parameters
|
||||
Optional parameters are passed through a pointer to a WorkflowApiWorkflowControllerSetScheduleOpts struct
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
|
||||
|
||||
**events** | **optional.String**| List of events separated by comma |
|
||||
**cronString** | **optional.String**| Cron string |
|
||||
**duration** | **optional.Int32**| Duration in seconds |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsScheduleInfo**](models.ScheduleInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
118
api-client/oc-catalog/docs/WorkspaceApi.md
Normal file
118
api-client/oc-catalog/docs/WorkspaceApi.md
Normal file
@@ -0,0 +1,118 @@
|
||||
# \WorkspaceApi
|
||||
|
||||
All URIs are relative to *https://localhost/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**WorkspaceControllerAddModelToWorkspace**](WorkspaceApi.md#WorkspaceControllerAddModelToWorkspace) | **Post** /workspace/ |
|
||||
[**WorkspaceControllerDeleteElementFromUserWorkspace**](WorkspaceApi.md#WorkspaceControllerDeleteElementFromUserWorkspace) | **Delete** /workspace/ |
|
||||
[**WorkspaceControllerGetFullWorkspace**](WorkspaceApi.md#WorkspaceControllerGetFullWorkspace) | **Get** /workspace/list_model |
|
||||
[**WorkspaceControllerGetWorkspace**](WorkspaceApi.md#WorkspaceControllerGetWorkspace) | **Get** /workspace/list |
|
||||
|
||||
|
||||
# **WorkspaceControllerAddModelToWorkspace**
|
||||
> WorkspaceControllerAddModelToWorkspace(ctx, id, rtype)
|
||||
|
||||
|
||||
Insert a resource in the workspace
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| ID of a resource |
|
||||
**rtype** | **string**| Type of resource |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkspaceControllerDeleteElementFromUserWorkspace**
|
||||
> WorkspaceControllerDeleteElementFromUserWorkspace(ctx, id, rtype)
|
||||
|
||||
|
||||
Remove a resource from the workspace
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string**| ID of a resource |
|
||||
**rtype** | **string**| Type of resource |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkspaceControllerGetFullWorkspace**
|
||||
> ModelsWorkspaceModel WorkspaceControllerGetFullWorkspace(ctx, )
|
||||
|
||||
|
||||
Get full workspace elements based on user_id token
|
||||
|
||||
### Required Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsWorkspaceModel**](models.WorkspaceModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
# **WorkspaceControllerGetWorkspace**
|
||||
> ModelsWorkspace WorkspaceControllerGetWorkspace(ctx, )
|
||||
|
||||
|
||||
Get workspace elements based on user_id token
|
||||
|
||||
### Required Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsWorkspace**](models.Workspace.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[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)
|
||||
|
||||
Reference in New Issue
Block a user