oc-workflow/swagger/swagger.yml

190 lines
4.3 KiB
YAML
Raw Normal View History

2024-07-11 11:40:11 +02:00
swagger: "2.0"
info:
title: beego Test API
description: |
beego has a very cool tools to autogenerate documents for your API
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
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
<br>
operationId: VersionController.GetAll
responses:
"200":
description: ""
/workflow/:
2024-07-24 10:25:08 +02:00
get:
tags:
- workflow
description: |-
find workflow by workflowid
<br>
operationId: WorkflowController.GetAll
responses:
"200":
description: '{workflow} models.workflow'
2024-07-11 11:40:11 +02:00
post:
tags:
- workflow
description: |-
create workflows
<br>
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'
/workflow/{id}:
2024-07-11 11:40:11 +02:00
get:
tags:
- workflow
description: |-
find workflow by workflowid
<br>
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
<br>
operationId: WorkflowController.Update
parameters:
- in: path
name: id
description: the workflowid 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: ""
schema:
$ref: '#/definitions/models.workflow'
2024-07-11 11:40:11 +02:00
delete:
tags:
- workflow
description: |-
delete the workflow
<br>
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!'
2024-08-13 11:36:53 +02:00
/workflow/check/{start_date}/{end_date}:
get:
2024-07-11 11:40:11 +02:00
tags:
- workflow
description: |-
2024-08-13 11:36:53 +02:00
check booking
2024-07-11 11:40:11 +02:00
<br>
2024-08-13 11:36:53 +02:00
operationId: WorkflowController.Check
2024-07-11 11:40:11 +02:00
parameters:
- in: path
2024-08-13 11:36:53 +02:00
name: start_date
description: 2006-01-02T15:04:05
type: string
default: the booking start date
- in: path
name: end_date
description: 2006-01-02T15:04:05
2024-07-11 11:40:11 +02:00
type: string
2024-08-13 11:36:53 +02:00
default: the booking end date
2024-07-11 11:40:11 +02:00
responses:
"200":
description: ""
2024-07-24 10:25:08 +02:00
schema:
2024-08-13 11:36:53 +02:00
$ref: '#/definitions/models.object'
/workflow/publish/{id}:
2024-07-24 10:25:08 +02:00
post:
tags:
2024-08-13 11:36:53 +02:00
- workflow
2024-07-24 10:25:08 +02:00
description: |-
create workflows
<br>
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-08-06 11:09:38 +02:00
/workflow/search/{search}:
get:
tags:
- workflow
description: |-
search workspace
<br>
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-11 11:40:11 +02:00
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
- name: version
description: |
VersionController operations for Version