deprecated-oc-catalog/selfapi/docs/ComputingApi.md

96 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

2023-03-03 14:43:11 +01:00
# \ComputingApi
All URIs are relative to *https://localhost:49618/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)