oc-shared/swagger/swagger.json
2024-08-12 14:12:51 +02:00

329 lines
11 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "beego Test API",
"description": "beego has a very cool tools to autogenerate documents for your API\n",
"version": "1.0.0",
"termsOfService": "http://beego.me/",
"contact": {
"email": "astaxie@gmail.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"basePath": "/oc/shared/",
"paths": {
"/version/": {
"get": {
"tags": [
"version"
],
"description": "get version\n\u003cbr\u003e",
"operationId": "VersionController.GetAll",
"responses": {
"200": {
"description": ""
}
}
}
},
"/workspace/": {
"get": {
"tags": [
"workspace"
],
"description": "find shared workspace by id\n\u003cbr\u003e",
"operationId": "SharedWorkspaceController.GetAll",
"responses": {
"200": {
"description": "{shared_workspace} models.shared_workspace"
}
}
},
"post": {
"tags": [
"workspace"
],
"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"
}
}
}
},
"/workspace/rule/": {
"get": {
"tags": [
"workspace/rule"
],
"description": "find rule by id\n\u003cbr\u003e",
"operationId": "RuleController.GetAll",
"responses": {
"200": {
"description": "{rule} models.rule"
}
}
},
"post": {
"tags": [
"workspace/rule"
],
"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"
}
}
}
},
"/workspace/rule/search/{search}": {
"get": {
"tags": [
"workspace/rule"
],
"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"
}
}
}
},
"/workspace/rule/{id}": {
"get": {
"tags": [
"workspace/rule"
],
"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": [
"workspace/rule"
],
"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": [
"workspace/rule"
],
"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!"
}
}
}
},
"/workspace/search/{search}": {
"get": {
"tags": [
"workspace"
],
"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"
}
}
}
},
"/workspace/{id}": {
"get": {
"tags": [
"workspace"
],
"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": [
"workspace"
],
"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": [
"workspace"
],
"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!"
}
}
}
}
},
"definitions": {
"json": {
"title": "json",
"type": "object"
},
"models.rule": {
"title": "rule",
"type": "object"
},
"models.workspace": {
"title": "workspace",
"type": "object"
}
},
"tags": [
{
"name": "workspace",
"description": "Operations about workspace\n"
},
{
"name": "workspace/rule",
"description": "Operations about rule\n"
},
{
"name": "version",
"description": "VersionController operations for Version\n"
}
]
}