initial commit

selfapi/docs/StorageApi.md

@@ -0,0 +1,95 @@
+# \StorageApi
+
+All URIs are relative to *https://localhost:49618/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)
+