345 lines
8.3 KiB
YAML
345 lines
8.3 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:
|
|
/shared/workspace/:
|
|
get:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
find shared workspace by id
|
|
<br>
|
|
operationId: SharedWorkspaceController.GetAll
|
|
responses:
|
|
"200":
|
|
description: '{shared_workspace} models.shared_workspace'
|
|
post:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
create shared workspace
|
|
<br>
|
|
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'
|
|
/shared/workspace/{id}:
|
|
get:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
find shared workspace by id
|
|
<br>
|
|
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:
|
|
- shared/workspace
|
|
description: |-
|
|
create shared workspaces
|
|
<br>
|
|
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:
|
|
- shared/workspace
|
|
description: |-
|
|
delete the shared workspace
|
|
<br>
|
|
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!'
|
|
/shared/workspace/{id}/peer/{id2}:
|
|
post:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
find shared workspace by id
|
|
<br>
|
|
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
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{shared workspace} models.shared_workspace'
|
|
/shared/workspace/{id}/rule/{id2}:
|
|
post:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
find shared workspace by id
|
|
<br>
|
|
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
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{shared workspace} models.shared_workspace'
|
|
/shared/workspace/{id}/workflow/{id2}:
|
|
post:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
find shared workspace by id
|
|
<br>
|
|
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'
|
|
/shared/workspace/{id}/workspace/{id2}:
|
|
post:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
find shared workspace by id
|
|
<br>
|
|
operationId: SharedWorkspaceController.Add Workspace
|
|
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'
|
|
/shared/workspace/rule/:
|
|
get:
|
|
tags:
|
|
- shared/workspace/rule
|
|
description: |-
|
|
find rule by id
|
|
<br>
|
|
operationId: RuleController.GetAll
|
|
responses:
|
|
"200":
|
|
description: '{rule} models.rule'
|
|
post:
|
|
tags:
|
|
- shared/workspace/rule
|
|
description: |-
|
|
create rule
|
|
<br>
|
|
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'
|
|
/shared/workspace/rule/{id}:
|
|
get:
|
|
tags:
|
|
- shared/workspace/rule
|
|
description: |-
|
|
find rule by id
|
|
<br>
|
|
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:
|
|
- shared/workspace/rule
|
|
description: |-
|
|
create rules
|
|
<br>
|
|
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:
|
|
- shared/workspace/rule
|
|
description: |-
|
|
delete the rule
|
|
<br>
|
|
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!'
|
|
/shared/workspace/rule/search/{search}:
|
|
get:
|
|
tags:
|
|
- shared/workspace/rule
|
|
description: |-
|
|
search rule
|
|
<br>
|
|
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'
|
|
/shared/workspace/search/{search}:
|
|
get:
|
|
tags:
|
|
- shared/workspace
|
|
description: |-
|
|
search shared workspace
|
|
<br>
|
|
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'
|
|
/version/:
|
|
get:
|
|
tags:
|
|
- version
|
|
description: |-
|
|
get version
|
|
<br>
|
|
operationId: VersionController.GetAll
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
/version/status:
|
|
get:
|
|
tags:
|
|
- version
|
|
description: |-
|
|
get status
|
|
<br>
|
|
operationId: VersionController.Status
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
definitions:
|
|
json:
|
|
title: json
|
|
type: object
|
|
models.rule:
|
|
title: rule
|
|
type: object
|
|
models.workspace:
|
|
title: workspace
|
|
type: object
|
|
tags:
|
|
- name: shared/workspace
|
|
description: |
|
|
Operations about workspace
|
|
- name: shared/workspace/rule
|
|
description: |
|
|
Operations about rule
|
|
- name: version
|
|
description: |
|
|
VersionController operations for Version
|