oc-shared/swagger/swagger.json

575 lines
20 KiB
JSON
Raw Normal View History

2024-08-12 14:12:51 +02:00
{
"swagger": "2.0",
"info": {
2024-09-05 09:30:42 +02:00
"title": "oc-shared",
"description": "Manages shared workspaces and their synchronization\n",
2024-08-12 14:12:51 +02:00
"version": "1.0.0",
2024-09-05 09:30:42 +02:00
"termsOfService": "http://cloud.o-forge.io/",
2024-08-12 14:12:51 +02:00
"contact": {
2024-09-05 09:30:42 +02:00
"email": "admin@o-cloud.io"
2024-08-12 14:12:51 +02:00
},
"license": {
2024-09-05 09:30:42 +02:00
"name": "MIT",
"url": "https://opensource.org/license/mit"
2024-08-12 14:12:51 +02:00
}
},
2024-08-22 10:49:26 +02:00
"basePath": "/oc",
2024-08-12 14:12:51 +02:00
"paths": {
2024-08-22 10:49:26 +02:00
"/shared/workspace/": {
2024-08-12 14:12:51 +02:00
"get": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace"
2024-08-12 14:12:51 +02:00
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.GetAll",
"responses": {
"200": {
"description": "{shared_workspace} models.shared_workspace"
}
}
},
"post": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace"
2024-08-12 14:12:51 +02:00
],
"description": "create shared workspace\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Create",
"parameters": [
{
"in": "body",
"name": "data",
"description": "body for data content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
}
},
2024-08-22 10:49:26 +02:00
"/shared/workspace/rule/": {
2024-08-12 14:12:51 +02:00
"get": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace/rule"
2024-08-12 14:12:51 +02:00
],
"description": "find rule by id\n\u003cbr\u003e",
"operationId": "RuleController.GetAll",
"responses": {
"200": {
"description": "{rule} models.rule"
}
}
},
"post": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace/rule"
2024-08-12 14:12:51 +02:00
],
"description": "create rule\n\u003cbr\u003e",
"operationId": "RuleController.Create",
"parameters": [
{
"in": "body",
"name": "data",
"description": "body for data content (Json format)",
"required": true,
"schema": {
"$ref": "#/definitions/json"
}
}
],
"responses": {
"200": {
"description": "{rule} models.rule"
}
}
}
},
2024-08-22 10:49:26 +02:00
"/shared/workspace/rule/search/{search}": {
2024-08-12 14:12:51 +02:00
"get": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace/rule"
2024-08-12 14:12:51 +02:00
],
"description": "search rule\n\u003cbr\u003e",
"operationId": "RuleController.Search",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the word search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{rule} models.rule"
}
}
}
},
2024-08-22 10:49:26 +02:00
"/shared/workspace/rule/{id}": {
2024-08-12 14:12:51 +02:00
"get": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace/rule"
2024-08-12 14:12:51 +02:00
],
"description": "find rule by id\n\u003cbr\u003e",
"operationId": "RuleController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{rule} models.rule"
}
}
},
"put": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace/rule"
2024-08-12 14:12:51 +02:00
],
"description": "create rules\n\u003cbr\u003e",
"operationId": "RuleController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the rule id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The rule content",
"required": true,
"schema": {
"$ref": "#/definitions/models.rule"
}
}
],
"responses": {
"200": {
"description": "{rule} models.rule"
}
}
},
"delete": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace/rule"
2024-08-12 14:12:51 +02:00
],
"description": "delete the rule\n\u003cbr\u003e",
"operationId": "RuleController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{rule} delete success!"
}
}
}
},
2024-08-22 10:49:26 +02:00
"/shared/workspace/search/{search}": {
2024-08-12 14:12:51 +02:00
"get": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace"
2024-08-12 14:12:51 +02:00
],
"description": "search shared workspace\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Search",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the word search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
}
},
2024-08-22 10:49:26 +02:00
"/shared/workspace/{id}": {
2024-08-12 14:12:51 +02:00
"get": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace"
2024-08-12 14:12:51 +02:00
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Get",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
},
"put": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace"
2024-08-12 14:12:51 +02:00
],
"description": "create shared workspaces\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the shared workspace id you want to get",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The shared workspace content",
"required": true,
"schema": {
"$ref": "#/definitions/models.workspace"
}
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
},
"delete": {
"tags": [
2024-08-22 10:49:26 +02:00
"shared/workspace"
2024-08-12 14:12:51 +02:00
],
"description": "delete the shared workspace\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Delete",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The id you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} delete success!"
}
}
}
2024-08-22 10:49:26 +02:00
},
2024-08-26 13:45:50 +02:00
"/shared/workspace/{id}/peer/{id2}": {
"post": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Add Peer",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
2024-08-26 13:50:11 +02:00
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
2024-08-26 15:39:56 +02:00
},
"delete": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Remove Peer",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
2024-08-26 13:50:11 +02:00
}
},
"/shared/workspace/{id}/rule/{id2}": {
"post": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Add Rule",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
2024-08-26 13:45:50 +02:00
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
2024-08-26 15:39:56 +02:00
},
"delete": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Remove Rule",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
2024-08-26 13:45:50 +02:00
}
},
"/shared/workspace/{id}/workflow/{id2}": {
"post": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Add Workflow",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
2024-08-26 15:39:56 +02:00
},
"delete": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Remove Workflow",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
2024-08-26 13:45:50 +02:00
}
},
"/shared/workspace/{id}/workspace/{id2}": {
"post": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Add Workspace",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
2024-08-26 15:39:56 +02:00
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
},
"delete": {
"tags": [
"shared/workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.Add Workspace",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the id you want to get",
"required": true,
"type": "string"
2024-08-26 13:45:50 +02:00
},
{
"in": "path",
"name": "id2",
"description": "the id you want to add",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{shared workspace} models.shared_workspace"
}
}
}
},
2024-08-22 10:49:26 +02:00
"/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": ""
}
}
}
2024-08-12 14:12:51 +02:00
}
},
"definitions": {
"json": {
"title": "json",
"type": "object"
},
"models.rule": {
"title": "rule",
"type": "object"
},
"models.workspace": {
"title": "workspace",
"type": "object"
}
},
"tags": [
{
2024-08-22 10:49:26 +02:00
"name": "shared/workspace",
2024-08-12 14:12:51 +02:00
"description": "Operations about workspace\n"
},
{
2024-08-22 10:49:26 +02:00
"name": "shared/workspace/rule",
2024-08-12 14:12:51 +02:00
"description": "Operations about rule\n"
},
{
"name": "version",
"description": "VersionController operations for Version\n"
}
]
}