oc-workflow/swagger/swagger.json

275 lines
8.8 KiB
JSON
Raw Normal View History

2024-07-11 11:40:11 +02:00
{
"swagger": "2.0",
"info": {
2024-09-05 09:27:26 +02:00
"title": "oc-workflow",
"description": "Workflows management api\n",
2024-07-11 11:40:11 +02:00
"version": "1.0.0",
2024-09-05 09:27:26 +02:00
"termsOfService": "http://cloud.o-forge.io/",
2024-07-11 11:40:11 +02:00
"contact": {
2024-09-05 09:27:26 +02:00
"email": "admin@o-cloud.io"
2024-07-11 11:40:11 +02:00
},
"license": {
2024-09-05 09:27:26 +02:00
"name": "MIT",
"url": "https://opensource.org/license/mit"
2024-07-11 11:40:11 +02:00
}
},
2024-07-24 10:25:08 +02:00
"basePath": "/oc/",
2024-07-11 11:40:11 +02:00
"paths": {
"/version/": {
"get": {
"tags": [
"version"
],
"description": "get version\n\u003cbr\u003e",
"operationId": "VersionController.GetAll",
"responses": {
"200": {
"description": ""
}
}
}
},
2024-08-21 12:35:06 +02:00
"/version/status": {
"get": {
"tags": [
"version"
],
"description": "get status\n\u003cbr\u003e",
"operationId": "VersionController.Status",
"responses": {
"200": {
"description": ""
}
}
}
},
2024-07-11 11:40:11 +02:00
"/workflow/": {
2024-07-24 10:25:08 +02:00
"get": {
"tags": [
"workflow"
],
"description": "find workflow by workflowid\n\u003cbr\u003e",
"operationId": "WorkflowController.GetAll",
"responses": {
"200": {
"description": "{workflow} models.workflow"
}
}
},
2024-07-11 11:40:11 +02:00
"post": {
"tags": [
"workflow"
],
"description": "create workflows\n\u003cbr\u003e",
"operationId": "WorkflowController.Create",
"parameters": [
{
"in": "body",
2024-07-24 10:25:08 +02:00
"name": "data",
"description": "body for data content (Json format)",
2024-07-11 11:40:11 +02:00
"required": true,
"schema": {
2024-07-24 10:25:08 +02:00
"$ref": "#/definitions/json"
2024-07-11 11:40:11 +02:00
}
}
],
"responses": {
"200": {
2024-07-24 10:25:08 +02:00
"description": "",
"schema": {
"$ref": "#/definitions/models.workflow"
}
2024-07-11 11:40:11 +02:00
}
}
}
},
2024-08-26 11:18:26 +02:00
"/workflow/check/{id}/{start_date}/{end_date}": {
2024-08-13 11:36:53 +02:00
"get": {
2024-07-11 11:40:11 +02:00
"tags": [
"workflow"
],
2024-08-13 11:36:53 +02:00
"description": "check booking\n\u003cbr\u003e",
"operationId": "WorkflowController.Check",
2024-07-11 11:40:11 +02:00
"parameters": [
2024-08-26 11:18:26 +02:00
{
"in": "path",
"name": "id",
"description": "the booking workflow id",
"type": "string"
},
2024-07-11 11:40:11 +02:00
{
"in": "path",
2024-08-13 11:36:53 +02:00
"name": "start_date",
2024-08-26 11:18:26 +02:00
"description": "the booking start date format 2006-01-02T15:04:05",
"type": "string"
2024-08-13 11:36:53 +02:00
},
2024-07-24 10:25:08 +02:00
{
2024-08-13 11:36:53 +02:00
"in": "path",
"name": "end_date",
"description": "2006-01-02T15:04:05",
"type": "string",
"default": "the booking end date"
2024-07-24 10:25:08 +02:00
}
],
"responses": {
"200": {
"description": "",
"schema": {
2024-08-13 11:36:53 +02:00
"$ref": "#/definitions/models.object"
2024-07-24 10:25:08 +02:00
}
}
}
}
},
2024-08-13 11:36:53 +02:00
"/workflow/publish/{id}": {
"post": {
2024-07-24 10:25:08 +02:00
"tags": [
2024-08-13 11:36:53 +02:00
"workflow"
2024-07-24 10:25:08 +02:00
],
"description": "create workflows\n\u003cbr\u003e",
2024-08-13 11:36:53 +02:00
"operationId": "WorkflowController.Publish",
2024-07-24 10:25:08 +02:00
"parameters": [
{
"in": "path",
"name": "id",
"description": "the workflowid you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/models.workflow"
}
}
}
2024-07-11 11:40:11 +02:00
}
},
2024-08-06 11:09:38 +02:00
"/workflow/search/{search}": {
"get": {
"tags": [
"workflow"
],
"description": "search workspace\n\u003cbr\u003e",
"operationId": "WorkflowController.Search",
"parameters": [
{
"in": "path",
"name": "search",
"description": "the word search you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workspace} models.workspace"
}
}
}
},
2024-07-24 10:25:08 +02:00
"/workflow/{id}": {
2024-07-11 11:40:11 +02:00
"get": {
"tags": [
"workflow"
],
"description": "find workflow by workflowid\n\u003cbr\u003e",
"operationId": "WorkflowController.Get",
"parameters": [
{
"in": "path",
2024-07-24 10:25:08 +02:00
"name": "id",
2024-07-11 11:40:11 +02:00
"description": "the workflowid you want to get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{workflow} models.workflow"
2024-07-24 10:25:08 +02:00
}
}
},
"put": {
"tags": [
"workflow"
],
"description": "create workflows\n\u003cbr\u003e",
"operationId": "WorkflowController.Update",
"parameters": [
{
"in": "path",
"name": "id",
"description": "the workflowid you want to get",
"required": true,
"type": "string"
2024-07-11 11:40:11 +02:00
},
2024-07-24 10:25:08 +02:00
{
"in": "body",
"name": "body",
"description": "The workflow content",
"required": true,
"schema": {
"$ref": "#/definitions/models.workflow"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/models.workflow"
}
2024-07-11 11:40:11 +02:00
}
}
},
"delete": {
"tags": [
"workflow"
],
"description": "delete the workflow\n\u003cbr\u003e",
"operationId": "WorkflowController.Delete",
"parameters": [
{
"in": "path",
2024-07-24 10:25:08 +02:00
"name": "id",
2024-07-11 11:40:11 +02:00
"description": "The workflowId you want to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "{string} delete success!"
}
}
}
}
},
"definitions": {
2024-07-24 10:25:08 +02:00
"json": {
"title": "json",
"type": "object"
},
2024-08-13 11:36:53 +02:00
"models.object": {
"title": "object",
"type": "object"
},
2024-07-11 11:40:11 +02:00
"models.workflow": {
"title": "workflow",
"type": "object"
}
},
"tags": [
{
"name": "workflow",
"description": "Operations about workflow\n"
},
{
"name": "version",
"description": "VersionController operations for Version\n"
}
]
}