101 lines
7.4 KiB
Markdown
101 lines
7.4 KiB
Markdown
|
# Go API client for swagger
|
||
|
|
|
||
|
|
Backend of the oc-search project
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
|
||
|
|
|
||
|
|
- API version: 1.0.0
|
||
|
|
- Package version: 1.0.0
|
||
|
|
- Build package: io.swagger.codegen.languages.GoClientCodegen
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
Put the package under your project folder and add the following in import:
|
||
|
|
```golang
|
||
|
|
import "./swagger"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation for API Endpoints
|
||
|
|
|
||
|
|
All URIs are relative to *https://localhost/v1*
|
||
|
|
|
||
|
|
Class | Method | HTTP request | Description
|
||
|
|
------------ | ------------- | ------------- | -------------
|
||
|
|
*ComputingApi* | [**ComputingControllerAddComputing**](docs/ComputingApi.md#computingcontrolleraddcomputing) | **Post** /computing/ |
|
||
|
|
*ComputingApi* | [**ComputingControllerGetComputingByID**](docs/ComputingApi.md#computingcontrollergetcomputingbyid) | **Get** /computing/{ID} |
|
||
|
|
*ComputingApi* | [**ComputingControllerGetMultipleComputingByIDs**](docs/ComputingApi.md#computingcontrollergetmultiplecomputingbyids) | **Get** /computing/multi/{IDs} |
|
||
|
|
*DataApi* | [**DataControllerCreateData**](docs/DataApi.md#datacontrollercreatedata) | **Post** /data/ |
|
||
|
|
*DataApi* | [**DataControllerGetDataByID**](docs/DataApi.md#datacontrollergetdatabyid) | **Get** /data/{ID} |
|
||
|
|
*DataApi* | [**DataControllerGetMultipleDataByIDs**](docs/DataApi.md#datacontrollergetmultipledatabyids) | **Get** /data/multi/{IDs} |
|
||
|
|
*DatacenterApi* | [**DatacenterControllerCreateDatacenter**](docs/DatacenterApi.md#datacentercontrollercreatedatacenter) | **Post** /datacenter/ |
|
||
|
|
*DatacenterApi* | [**DatacenterControllerGetMultipleDatacentersByIDs**](docs/DatacenterApi.md#datacentercontrollergetmultipledatacentersbyids) | **Get** /datacenter/multi/{IDs} |
|
||
|
|
*DatacenterApi* | [**DatacenterControllerGetOneDatacenter**](docs/DatacenterApi.md#datacentercontrollergetonedatacenter) | **Get** /datacenter/{ID} |
|
||
|
|
*ScheduleApi* | [**ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC**](docs/ScheduleApi.md#schedulecontrollercheckifschedulecanbecreatedinthisdc) | **Post** /schedule/check |
|
||
|
|
*ScheduleApi* | [**ScheduleControllerCreateSchedule**](docs/ScheduleApi.md#schedulecontrollercreateschedule) | **Post** /schedule/book |
|
||
|
|
*ScheduleApi* | [**ScheduleControllerGetNextSchedule**](docs/ScheduleApi.md#schedulecontrollergetnextschedule) | **Get** /schedule/next |
|
||
|
|
*ScheduleApi* | [**ScheduleControllerGetPreviousSchedule**](docs/ScheduleApi.md#schedulecontrollergetpreviousschedule) | **Get** /schedule/previous |
|
||
|
|
*ScheduleApi* | [**ScheduleControllerGetSchedules**](docs/ScheduleApi.md#schedulecontrollergetschedules) | **Get** /schedule/ |
|
||
|
|
*SearchApi* | [**SearchControllerSearchByWord**](docs/SearchApi.md#searchcontrollersearchbyword) | **Get** /search/byWord |
|
||
|
|
*StorageApi* | [**StorageControllerCreateStorage**](docs/StorageApi.md#storagecontrollercreatestorage) | **Post** /storage/ |
|
||
|
|
*StorageApi* | [**StorageControllerGet**](docs/StorageApi.md#storagecontrollerget) | **Get** /storage/{ID} |
|
||
|
|
*StorageApi* | [**StorageControllerGetMultipleStoragesByIDs**](docs/StorageApi.md#storagecontrollergetmultiplestoragesbyids) | **Get** /storage/multi/{IDs} |
|
||
|
|
*UserApi* | [**UserControllerLogin**](docs/UserApi.md#usercontrollerlogin) | **Get** /user/login |
|
||
|
|
*UserApi* | [**UserControllerLogout**](docs/UserApi.md#usercontrollerlogout) | **Get** /user/logout |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerAddNewObjectToAWorkflow**](docs/WorkflowApi.md#workflowcontrolleraddnewobjecttoaworkflow) | **Post** /workflow/{workflowName}/add |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerBookSchedule**](docs/WorkflowApi.md#workflowcontrollerbookschedule) | **Post** /workflow/{workflowName}/schedule/book |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerCheckSchedule**](docs/WorkflowApi.md#workflowcontrollercheckschedule) | **Get** /workflow/{workflowName}/schedule/check |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerCreateANewWorkflow**](docs/WorkflowApi.md#workflowcontrollercreateanewworkflow) | **Post** /workflow/ |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerCreateARealtionshipBetweenTwoRobjects**](docs/WorkflowApi.md#workflowcontrollercreatearealtionshipbetweentworobjects) | **Post** /workflow/{workflowName}/link |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerGetMxGraphLastStatus**](docs/WorkflowApi.md#workflowcontrollergetmxgraphlaststatus) | **Get** /workflow/{workflowName}/mxGraphParser |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerGetSchedule**](docs/WorkflowApi.md#workflowcontrollergetschedule) | **Get** /workflow/{workflowName}/schedule |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerGetWorkflow**](docs/WorkflowApi.md#workflowcontrollergetworkflow) | **Get** /workflow/{workflowName} |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerListWorkflows**](docs/WorkflowApi.md#workflowcontrollerlistworkflows) | **Get** /workflow/ |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerParseMxGraph**](docs/WorkflowApi.md#workflowcontrollerparsemxgraph) | **Post** /workflow/{workflowName}/mxGraphParser |
|
||
|
|
*WorkflowApi* | [**WorkflowControllerSetSchedule**](docs/WorkflowApi.md#workflowcontrollersetschedule) | **Put** /workflow/{workflowName}/schedule |
|
||
|
|
*WorkspaceApi* | [**WorkspaceControllerAddModelToWorkspace**](docs/WorkspaceApi.md#workspacecontrolleraddmodeltoworkspace) | **Post** /workspace/ |
|
||
|
|
*WorkspaceApi* | [**WorkspaceControllerDeleteElementFromUserWorkspace**](docs/WorkspaceApi.md#workspacecontrollerdeleteelementfromuserworkspace) | **Delete** /workspace/ |
|
||
|
|
*WorkspaceApi* | [**WorkspaceControllerGetFullWorkspace**](docs/WorkspaceApi.md#workspacecontrollergetfullworkspace) | **Get** /workspace/list_model |
|
||
|
|
*WorkspaceApi* | [**WorkspaceControllerGetWorkspace**](docs/WorkspaceApi.md#workspacecontrollergetworkspace) | **Get** /workspace/list |
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation For Models
|
||
|
|
|
||
|
|
- [ModelsComputingModel](docs/ModelsComputingModel.md)
|
||
|
|
- [ModelsComputingNewModel](docs/ModelsComputingNewModel.md)
|
||
|
|
- [ModelsComputingObject](docs/ModelsComputingObject.md)
|
||
|
|
- [ModelsDCstatus](docs/ModelsDCstatus.md)
|
||
|
|
- [ModelsDataModel](docs/ModelsDataModel.md)
|
||
|
|
- [ModelsDataNewModel](docs/ModelsDataNewModel.md)
|
||
|
|
- [ModelsDataObject](docs/ModelsDataObject.md)
|
||
|
|
- [ModelsDatacenterCpuModel](docs/ModelsDatacenterCpuModel.md)
|
||
|
|
- [ModelsDatacenterGpuModel](docs/ModelsDatacenterGpuModel.md)
|
||
|
|
- [ModelsDatacenterMemoryModel](docs/ModelsDatacenterMemoryModel.md)
|
||
|
|
- [ModelsDatacenterModel](docs/ModelsDatacenterModel.md)
|
||
|
|
- [ModelsDatacenterNewModel](docs/ModelsDatacenterNewModel.md)
|
||
|
|
- [ModelsDatacenterObject](docs/ModelsDatacenterObject.md)
|
||
|
|
- [ModelsExecutionRequirementsModel](docs/ModelsExecutionRequirementsModel.md)
|
||
|
|
- [ModelsRepositoryModel](docs/ModelsRepositoryModel.md)
|
||
|
|
- [ModelsScheduleDb](docs/ModelsScheduleDb.md)
|
||
|
|
- [ModelsScheduleInfo](docs/ModelsScheduleInfo.md)
|
||
|
|
- [ModelsScheduleTime](docs/ModelsScheduleTime.md)
|
||
|
|
- [ModelsSearchResult](docs/ModelsSearchResult.md)
|
||
|
|
- [ModelsStorageModel](docs/ModelsStorageModel.md)
|
||
|
|
- [ModelsStorageNewModel](docs/ModelsStorageNewModel.md)
|
||
|
|
- [ModelsStorageObject](docs/ModelsStorageObject.md)
|
||
|
|
- [ModelsWorkflow](docs/ModelsWorkflow.md)
|
||
|
|
- [ModelsWorkflowSchedule](docs/ModelsWorkflowSchedule.md)
|
||
|
|
- [ModelsWorkspace](docs/ModelsWorkspace.md)
|
||
|
|
- [ModelsWorkspaceModel](docs/ModelsWorkspaceModel.md)
|
||
|
|
- [PrimitiveObjectId](docs/PrimitiveObjectId.md)
|
||
|
|
- [TimeTime](docs/TimeTime.md)
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation For Authorization
|
||
|
|
Endpoints do not require authorization.
|
||
|
|
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
valentin.kivachuk@irt-saintexupery.com
|
||
|
|
|