151 lines
3.3 KiB
YAML
151 lines
3.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:
|
|
/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: ""
|
|
/workspace/:
|
|
get:
|
|
tags:
|
|
- workspace
|
|
description: |-
|
|
find workspace by id
|
|
<br>
|
|
operationId: WorkspaceController.GetAll
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
post:
|
|
tags:
|
|
- workspace
|
|
description: |-
|
|
create workspace
|
|
<br>
|
|
operationId: WorkspaceController.Create
|
|
parameters:
|
|
- in: body
|
|
name: data
|
|
description: body for data content (Json format)
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/json'
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
/workspace/{id}:
|
|
get:
|
|
tags:
|
|
- workspace
|
|
description: |-
|
|
find workflow by id
|
|
<br>
|
|
operationId: WorkspaceController.Get
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the id you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
put:
|
|
tags:
|
|
- workspace
|
|
description: |-
|
|
create workspaces
|
|
<br>
|
|
operationId: WorkspaceController.Update
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the workspace id you want to get
|
|
required: true
|
|
type: string
|
|
- in: body
|
|
name: body
|
|
description: The workspace content
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.workspace'
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
delete:
|
|
tags:
|
|
- workspace
|
|
description: |-
|
|
delete the workspace
|
|
<br>
|
|
operationId: WorkspaceController.Delete
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: The id you want to delete
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workspace} delete success!'
|
|
/workspace/search/{search}:
|
|
get:
|
|
tags:
|
|
- workspace
|
|
description: |-
|
|
search workspace
|
|
<br>
|
|
operationId: WorkspaceController.Search
|
|
parameters:
|
|
- in: path
|
|
name: search
|
|
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.workspace:
|
|
title: workspace
|
|
type: object
|
|
tags:
|
|
- name: workspace
|
|
description: |
|
|
Operations about workspace
|
|
- name: version
|
|
description: |
|
|
VersionController operations for Version
|