323 lines
7.6 KiB
YAML
323 lines
7.6 KiB
YAML
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
|
|
basePath: /oc/
|
|
paths:
|
|
/version/:
|
|
get:
|
|
tags:
|
|
- version
|
|
description: |-
|
|
get version
|
|
<br>
|
|
operationId: VersionController.GetAll
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
/workflow/:
|
|
get:
|
|
tags:
|
|
- workflow
|
|
description: |-
|
|
find workflow by workflowid
|
|
<br>
|
|
operationId: WorkflowController.GetAll
|
|
responses:
|
|
"200":
|
|
description: '{workflow} models.workflow'
|
|
post:
|
|
tags:
|
|
- workflow
|
|
description: |-
|
|
create workflows
|
|
<br>
|
|
operationId: WorkflowController.Create
|
|
parameters:
|
|
- in: body
|
|
name: data
|
|
description: body for data content (Json format)
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/json'
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/models.workflow'
|
|
/workflow/{id}:
|
|
get:
|
|
tags:
|
|
- workflow
|
|
description: |-
|
|
find workflow by workflowid
|
|
<br>
|
|
operationId: WorkflowController.Get
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the workflowid you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workflow} models.workflow'
|
|
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'
|
|
delete:
|
|
tags:
|
|
- workflow
|
|
description: |-
|
|
delete the workflow
|
|
<br>
|
|
operationId: WorkflowController.Delete
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: The workflowId you want to delete
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{string} delete success!'
|
|
/workflow/publish/{id}:
|
|
post:
|
|
tags:
|
|
- workflow
|
|
description: |-
|
|
create workflows
|
|
<br>
|
|
operationId: WorkflowController.Publish
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the workflowid you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/models.workflow'
|
|
/workflow/resource/:
|
|
get:
|
|
tags:
|
|
- workflow/resource
|
|
description: |-
|
|
find workflow by workflowid
|
|
<br>
|
|
operationId: WorkflowResourceController.GetAll
|
|
responses:
|
|
"200":
|
|
description: '{workflow} models.workflow'
|
|
post:
|
|
tags:
|
|
- workflow/resource
|
|
description: |-
|
|
create workflows
|
|
<br>
|
|
operationId: WorkflowResourceController.Create
|
|
parameters:
|
|
- in: body
|
|
name: data
|
|
description: body for data content (Json format)
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/json'
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/models.workflow'
|
|
/workflow/resource/{id}:
|
|
get:
|
|
tags:
|
|
- workflow/resource
|
|
description: |-
|
|
find workflows
|
|
<br>
|
|
operationId: WorkflowResourceController.Get
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the workflowid you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workflow} models.workflow'
|
|
put:
|
|
tags:
|
|
- workflow/resource
|
|
description: |-
|
|
create workflows
|
|
<br>
|
|
operationId: WorkflowResourceController.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'
|
|
delete:
|
|
tags:
|
|
- workflow/resource
|
|
description: |-
|
|
delete the workflow
|
|
<br>
|
|
operationId: WorkflowResourceController.Delete
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: The workflowId you want to delete
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{string} delete success!'
|
|
/workflow/resource/search/{search}:
|
|
get:
|
|
tags:
|
|
- workflow/resource
|
|
description: |-
|
|
search workspace
|
|
<br>
|
|
operationId: WorkflowResourceController.Search
|
|
parameters:
|
|
- in: path
|
|
name: search
|
|
description: the word search you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
/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'
|
|
/workflow_execution/:
|
|
get:
|
|
tags:
|
|
- workflow_execution
|
|
description: |-
|
|
find workflow by workflowid
|
|
<br>
|
|
operationId: WorkflowExecutionController.GetAll
|
|
responses:
|
|
"200":
|
|
description: '{workflow} models.workflow'
|
|
/workflow_execution/{id}:
|
|
get:
|
|
tags:
|
|
- workflow_execution
|
|
description: |-
|
|
find workflow by workflowid
|
|
<br>
|
|
operationId: WorkflowExecutionController.Get
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the workflowid you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workflow} models.workflow'
|
|
/workflow_execution/search/{start_date}/{end_date}:
|
|
get:
|
|
tags:
|
|
- workflow_execution
|
|
description: |-
|
|
search workspace
|
|
<br>
|
|
operationId: WorkflowExecutionController.Search
|
|
parameters:
|
|
- in: path
|
|
name: start_date
|
|
description: the word search you want to get
|
|
required: true
|
|
type: string
|
|
- in: path
|
|
name: end_date
|
|
description: the word search you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
definitions:
|
|
json:
|
|
title: json
|
|
type: object
|
|
models.workflow:
|
|
title: workflow
|
|
type: object
|
|
tags:
|
|
- name: workflow
|
|
description: |
|
|
Operations about workflow
|
|
- name: workflow/resource
|
|
description: |
|
|
Operations about workflow
|
|
- name: workflow_execution
|
|
description: |
|
|
Operations about workflow
|
|
- name: version
|
|
description: |
|
|
VersionController operations for Version
|