oc-catalog/swagger/swagger.json

854 lines
28 KiB
JSON
Raw Normal View History

2024-07-26 13:07:25 +02:00
{
"swagger": "2.0",
"info": {
"title": "oc-catalog",
"description": "OpenCloud catalog\n",
2024-07-26 13:07:25 +02:00
"version": "1.0.0",
"termsOfService": "http://cloud.o-forge.io/",
2024-07-26 13:07:25 +02:00
"contact": {
"email": "admin@o-cloud.io"
2024-07-26 13:07:25 +02:00
},
"license": {
"name": "MIT",
"url": "https://opensource.org/license/mit"
2024-07-26 13:07:25 +02:00
}
},
"basePath": "/oc/",
"paths": {
"/data/": {
"get": {
"tags": [
"data"
],
"description": "find data by id\n\u003cbr\u003e",
"operationId": "DataController.GetAll",
"responses": {
"200": {
"description": "{data} models.data"
}
}
},
"post": {
"tags": [
"data"
],
"description": "create data\n\u003cbr\u003e",
"operationId": "DataController.Create",
"parameters": [
{
"in": "body",
"name": "data",
"description": "body for data content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{data} models.data"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/data/search/{search}": {
"get": {
"tags": [
"data"
],
"description": "find data by key word\n\u003cbr\u003e",
"operationId": "DataController.Get",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{data} models.data"
}
}
}
},
2024-07-26 13:07:25 +02:00
"/data/{id}": {
"get": {
"tags": [
"data"
],
"description": "find data by id\n\u003cbr\u003e",
2024-07-26 13:07:25 +02:00
"operationId": "DataController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{data} models.data"
}
}
},
"put": {
"tags": [
"data"
],
"description": "create datas\n\u003cbr\u003e",
"operationId": "DataController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the data id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The data content",
"required": true,
"schema": {
"$ref": "#/definitions/models.data"
}
}
],
"responses": {
"200": {
"description": "{data} models.data"
}
}
},
"delete": {
"tags": [
"data"
],
"description": "delete the data\n\u003cbr\u003e",
"operationId": "DataController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{data} delete success!"
}
}
}
},
"/datacenter/": {
"get": {
"tags": [
"datacenter"
],
"description": "find datacenter by id\n\u003cbr\u003e",
"operationId": "DatacenterController.GetAll",
"responses": {
"200": {
"description": "{datacenter} models.datacenter"
}
}
},
"post": {
"tags": [
"datacenter"
],
"description": "create datacenter\n\u003cbr\u003e",
"operationId": "DatacenterController.Create",
"parameters": [
{
"in": "body",
"name": "datacenter",
"description": "body for datacenter content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{datacenter} models.datacenter"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/datacenter/search/{search}": {
"get": {
"tags": [
"datacenter"
],
"description": "find datacenter by key word\n\u003cbr\u003e",
"operationId": "DatacenterController.Get",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{datacenter} models.datacenter"
}
}
}
},
2024-07-26 13:07:25 +02:00
"/datacenter/{id}": {
"get": {
"tags": [
"datacenter"
],
"description": "find datacenter by id\n\u003cbr\u003e",
"operationId": "DatacenterController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{datacenter} models.datacenter"
}
}
},
"put": {
"tags": [
"datacenter"
],
"description": "create datacenters\n\u003cbr\u003e",
"operationId": "DatacenterController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the datacenter id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The datacenter content",
"required": true,
"schema": {
"$ref": "#/definitions/models.datacenter"
}
}
],
"responses": {
"200": {
"description": "{datacenter} models.datacenter"
}
}
},
"delete": {
"tags": [
"datacenter"
],
"description": "delete the datacenter\n\u003cbr\u003e",
"operationId": "DatacenterController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{datacenter} delete success!"
}
}
}
},
"/processing/": {
"get": {
"tags": [
"processing"
],
"description": "find processing by id\n\u003cbr\u003e",
"operationId": "ProcessingController.GetAll",
"responses": {
"200": {
"description": "{processing} models.processing"
}
}
},
"post": {
"tags": [
"processing"
],
"description": "create processing\n\u003cbr\u003e",
"operationId": "ProcessingController.Create",
"parameters": [
{
"in": "body",
"name": "processing",
"description": "body for processing content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{processing} models.processing"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/processing/search/{search}": {
"get": {
"tags": [
"processing"
],
"description": "find processing by key word\n\u003cbr\u003e",
"operationId": "ProcessingController.Get",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{processing} models.processing"
}
}
}
},
2024-07-26 13:07:25 +02:00
"/processing/{id}": {
"get": {
"tags": [
"processing"
],
"description": "find processing by id\n\u003cbr\u003e",
"operationId": "ProcessingController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{processing} models.processing"
}
}
},
"put": {
"tags": [
"processing"
],
"description": "create processings\n\u003cbr\u003e",
"operationId": "ProcessingController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the processing id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The processing content",
"required": true,
"schema": {
"$ref": "#/definitions/models.processing"
}
}
],
"responses": {
"200": {
"description": "{processing} models.processing"
}
}
},
"delete": {
"tags": [
"processing"
],
"description": "delete the processing\n\u003cbr\u003e",
"operationId": "ProcessingController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{processing} delete success!"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/resource/": {
"get": {
"tags": [
2024-07-30 10:07:34 +02:00
"resource"
],
2024-07-30 10:07:34 +02:00
"description": "find resource by id\n\u003cbr\u003e",
"operationId": "ResourceController.GetAll",
"responses": {
"200": {
2024-07-30 10:07:34 +02:00
"description": "{resource} models.resource"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/resource/search/{search}": {
"get": {
"tags": [
"resource"
],
2024-07-30 10:07:34 +02:00
"description": "find resource by key word\n\u003cbr\u003e",
"operationId": "ResourceController.Get",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{resource} models.resource"
}
}
}
},
"/resource/{id}": {
"get": {
"tags": [
"resource"
],
"description": "find resource by id\n\u003cbr\u003e",
"operationId": "ResourceController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{resource} models.resource"
}
}
},
"delete": {
"tags": [
"resource"
],
"description": "delete the resource\n\u003cbr\u003e",
"operationId": "ResourceController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to deleteDeleteOne",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{resource} delete success!"
}
}
}
},
2024-07-26 13:07:25 +02:00
"/storage/": {
"get": {
"tags": [
"storage"
],
"description": "find storage by id\n\u003cbr\u003e",
"operationId": "StorageController.GetAll",
"responses": {
"200": {
"description": "{storage} models.storage"
}
}
},
"post": {
"tags": [
"storage"
],
"description": "create storage\n\u003cbr\u003e",
"operationId": "StorageController.Create",
"parameters": [
{
"in": "body",
"name": "storage",
"description": "body for storage content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{storage} models.storage"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/storage/search/{search}": {
"get": {
"tags": [
"storage"
],
"description": "find storage by key word\n\u003cbr\u003e",
"operationId": "StorageController.Get",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{storage} models.storage"
}
}
}
},
2024-07-26 13:07:25 +02:00
"/storage/{id}": {
"get": {
"tags": [
"storage"
],
"description": "find storage by id\n\u003cbr\u003e",
"operationId": "StorageController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{storage} models.storage"
}
}
},
"put": {
"tags": [
"storage"
],
"description": "create storages\n\u003cbr\u003e",
"operationId": "StorageController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the storage id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The storage content",
"required": true,
"schema": {
"$ref": "#/definitions/models.storage"
}
}
],
"responses": {
"200": {
"description": "{storage} models.storage"
}
}
},
"delete": {
"tags": [
"storage"
],
"description": "delete the storage\n\u003cbr\u003e",
"operationId": "StorageController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{storage} delete success!"
}
}
}
},
"/version/": {
"get": {
"tags": [
"version"
],
"description": "get version\n\u003cbr\u003e",
"operationId": "VersionController.GetAll",
"responses": {
"200": {
"description": ""
}
2024-08-21 11:57:45 +02:00
}
}
},
"/version/status": {
"get": {
"tags": [
"version"
],
"description": "get status\n\u003cbr\u003e",
"operationId": "VersionController.Status",
"responses": {
"200": {
"description": ""
}
2024-07-26 13:07:25 +02:00
}
}
},
"/workflow/": {
"get": {
"tags": [
"workflow"
],
"description": "find workflow by id\n\u003cbr\u003e",
"operationId": "WorkflowController.GetAll",
"responses": {
"200": {
"description": "{workflow} models.workflow"
}
}
},
"post": {
"tags": [
"workflow"
],
"description": "create workflow\n\u003cbr\u003e",
"operationId": "WorkflowController.Create",
"parameters": [
{
"in": "body",
"name": "workflow",
"description": "body for workflow content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{workflow} models.workflow"
}
}
}
},
2024-07-30 10:07:34 +02:00
"/workflow/search/{search}": {
"get": {
"tags": [
"workflow"
],
"description": "find workflow by key word\n\u003cbr\u003e",
"operationId": "WorkflowController.Get",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workflow} models.workflow"
}
}
}
},
2024-07-26 13:07:25 +02:00
"/workflow/{id}": {
"get": {
"tags": [
"workflow"
],
"description": "find workflow by id\n\u003cbr\u003e",
"operationId": "WorkflowController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workflow} models.workflow"
}
}
},
"put": {
"tags": [
"workflow"
],
"description": "create workflows\n\u003cbr\u003e",
"operationId": "WorkflowController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the workflow id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The workflow content",
"required": true,
"schema": {
"$ref": "#/definitions/models.workflow"
}
}
],
"responses": {
"200": {
"description": "{workflow} models.workflow"
}
}
},
"delete": {
"tags": [
"workflow"
],
"description": "delete the workflow\n\u003cbr\u003e",
"operationId": "WorkflowController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workflow} delete success!"
}
}
}
}
},
"definitions": {
"json": {
"title": "json",
"type": "object"
},
"models.data": {
"title": "data",
"type": "object"
},
"models.datacenter": {
"title": "datacenter",
"type": "object"
},
"models.processing": {
"title": "processing",
"type": "object"
},
"models.storage": {
"title": "storage",
"type": "object"
},
"models.workflow": {
"title": "workflow",
"type": "object"
}
},
"tags": [
{
"name": "resource",
"description": "Operations about resource\n"
},
2024-07-26 13:07:25 +02:00
{
"name": "data",
"description": "Operations about data\n"
},
{
"name": "datacenter",
"description": "Operations about datacenter\n"
2024-07-26 13:07:25 +02:00
},
{
"name": "storage",
"description": "Operations about storage\n"
2024-07-26 13:07:25 +02:00
},
{
"name": "processing",
"description": "Operations about processing\n"
2024-07-26 13:07:25 +02:00
},
{
"name": "workflow",
"description": "Operations about workflow\n"
2024-07-26 13:07:25 +02:00
},
{
"name": "version",
"description": "VersionController operations for Version\n"
}
]
}