oc-workspace/swagger/swagger.json
2024-09-05 09:25:21 +02:00

201 lines
6.3 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "oc-workspace",
"description": "Manage user's named resource sets, kind of shopping carts\n",
"version": "1.0.0",
"termsOfService": "http://cloud.o-forge.io/",
"contact": {
"email": "admin@o-cloud.io"
},
"license": {
"name": "MIT",
"url": "https://opensource.org/license/mit"
}
},
"basePath": "/oc/",
"paths": {
"/version/": {
"get": {
"tags": [
"version"
],
"description": "get version\n\u003cbr\u003e",
"operationId": "VersionController.GetAll",
"responses": {
"200": {
"description": ""
}
}
}
},
"/version/status": {
"get": {
"tags": [
"version"
],
"description": "get status\n\u003cbr\u003e",
"operationId": "VersionController.Status",
"responses": {
"200": {
"description": ""
}
}
}
},
"/workspace/": {
"get": {
"tags": [
"workspace"
],
"description": "find workspace by id\n\u003cbr\u003e",
"operationId": "WorkspaceController.GetAll",
"responses": {
"200": {
"description": "{workspace} models.workspace"
}
}
},
"post": {
"tags": [
"workspace"
],
"description": "create workspace\n\u003cbr\u003e",
"operationId": "WorkspaceController.Create",
"parameters": [
{
"in": "body",
"name": "data",
"description": "body for data content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{workspace} models.workspace"
}
}
}
},
"/workspace/search/{search}": {
"get": {
"tags": [
"workspace"
],
"description": "search workspace\n\u003cbr\u003e",
"operationId": "WorkspaceController.Search",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the word search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workspace} models.workspace"
}
}
}
},
"/workspace/{id}": {
"get": {
"tags": [
"workspace"
],
"description": "find workflow by id\n\u003cbr\u003e",
"operationId": "WorkspaceController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workspace} models.workspace"
}
}
},
"put": {
"tags": [
"workspace"
],
"description": "create workspaces\n\u003cbr\u003e",
"operationId": "WorkspaceController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the workspace id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The workspace content",
"required": true,
"schema": {
"$ref": "#/definitions/models.workspace"
}
}
],
"responses": {
"200": {
"description": "{workspace} models.workspace"
}
}
},
"delete": {
"tags": [
"workspace"
],
"description": "delete the workspace\n\u003cbr\u003e",
"operationId": "WorkspaceController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workspace} delete success!"
}
}
}
}
},
"definitions": {
"json": {
"title": "json",
"type": "object"
},
"models.workspace": {
"title": "workspace",
"type": "object"
}
},
"tags": [
{
"name": "workspace",
"description": "Operations about workspace\n"
},
{
"name": "version",
"description": "VersionController operations for Version\n"
}
]
}