oc-catalog/swagger/swagger.yml

628 lines
14 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:
/data/:
get:
tags:
- data
description: |-
find data by id
<br>
operationId: DataController.GetAll
responses:
"200":
description: '{data} models.data'
post:
tags:
- data
description: |-
create data
<br>
operationId: DataController.Create
parameters:
- in: body
name: data
description: body for data content (Json format)
required: true
schema:
$ref: '#/definitions/json'
responses:
"200":
description: '{data} models.data'
/data/{id}:
get:
tags:
- data
description: |-
find data by id
<br>
operationId: DataController.Get
parameters:
- in: path
name: id
description: the id you want to get
required: true
type: string
responses:
"200":
description: '{data} models.data'
put:
tags:
- data
description: |-
create datas
<br>
operationId: DataController.Update
parameters:
- in: path
name: id
description: the data id you want to get
required: true
type: string
- in: body
name: body
description: The data content
required: true
schema:
$ref: '#/definitions/models.data'
responses:
"200":
description: '{data} models.data'
delete:
tags:
- data
description: |-
delete the data
<br>
operationId: DataController.Delete
parameters:
- in: path
name: id
description: The id you want to delete
required: true
type: string
responses:
"200":
description: '{data} delete success!'
/data/{search}:
get:
tags:
- data
description: |-
find data by key word
<br>
operationId: DataController.Get
parameters:
- in: path
name: search
description: the search you want to get
required: true
type: string
responses:
"200":
description: '{data} models.data'
/datacenter/:
get:
tags:
- datacenter
description: |-
find datacenter by id
<br>
operationId: DatacenterController.GetAll
responses:
"200":
description: '{datacenter} models.datacenter'
post:
tags:
- datacenter
description: |-
create datacenter
<br>
operationId: DatacenterController.Create
parameters:
- in: body
name: datacenter
description: body for datacenter content (Json format)
required: true
schema:
$ref: '#/definitions/json'
responses:
"200":
description: '{datacenter} models.datacenter'
/datacenter/{id}:
get:
tags:
- datacenter
description: |-
find datacenter by id
<br>
operationId: DatacenterController.Get
parameters:
- in: path
name: id
description: the id you want to get
required: true
type: string
responses:
"200":
description: '{datacenter} models.datacenter'
put:
tags:
- datacenter
description: |-
create datacenters
<br>
operationId: DatacenterController.Update
parameters:
- in: path
name: id
description: the datacenter id you want to get
required: true
type: string
- in: body
name: body
description: The datacenter content
required: true
schema:
$ref: '#/definitions/models.datacenter'
responses:
"200":
description: '{datacenter} models.datacenter'
delete:
tags:
- datacenter
description: |-
delete the datacenter
<br>
operationId: DatacenterController.Delete
parameters:
- in: path
name: id
description: The id you want to delete
required: true
type: string
responses:
"200":
description: '{datacenter} delete success!'
/datacenter/{search}:
get:
tags:
- datacenter
description: |-
find datacenter by key word
<br>
operationId: DatacenterController.Get
parameters:
- in: path
name: search
description: the search you want to get
required: true
type: string
responses:
"200":
description: '{datacenter} models.datacenter'
/processing/:
get:
tags:
- processing
description: |-
find processing by id
<br>
operationId: ProcessingController.GetAll
responses:
"200":
description: '{processing} models.processing'
post:
tags:
- processing
description: |-
create processing
<br>
operationId: ProcessingController.Create
parameters:
- in: body
name: processing
description: body for processing content (Json format)
required: true
schema:
$ref: '#/definitions/json'
responses:
"200":
description: '{processing} models.processing'
/processing/{id}:
get:
tags:
- processing
description: |-
find processing by id
<br>
operationId: ProcessingController.Get
parameters:
- in: path
name: id
description: the id you want to get
required: true
type: string
responses:
"200":
description: '{processing} models.processing'
put:
tags:
- processing
description: |-
create processings
<br>
operationId: ProcessingController.Update
parameters:
- in: path
name: id
description: the processing id you want to get
required: true
type: string
- in: body
name: body
description: The processing content
required: true
schema:
$ref: '#/definitions/models.processing'
responses:
"200":
description: '{processing} models.processing'
delete:
tags:
- processing
description: |-
delete the processing
<br>
operationId: ProcessingController.Delete
parameters:
- in: path
name: id
description: The id you want to delete
required: true
type: string
responses:
"200":
description: '{processing} delete success!'
/processing/{search}:
get:
tags:
- processing
description: |-
find processing by key word
<br>
operationId: ProcessingController.Get
parameters:
- in: path
name: search
description: the search you want to get
required: true
type: string
responses:
"200":
description: '{processing} models.processing'
/resource/:
get:
tags:
- resource
description: |-
find resource by id
<br>
operationId: ResourceController.GetAll
responses:
"200":
description: '{resource} models.resource'
/resource/{id}:
get:
tags:
- resource
description: |-
find resource by id
<br>
operationId: ResourceController.Get
parameters:
- in: path
name: id
description: the id you want to get
required: true
type: string
responses:
"200":
description: '{resource} models.resource'
delete:
tags:
- resource
description: |-
delete the resource
<br>
operationId: ResourceController.Delete
parameters:
- in: path
name: id
description: The id you want to deleteDeleteOne
required: true
type: string
responses:
"200":
description: '{resource} delete success!'
/resource/{search}:
get:
tags:
- resource
description: |-
find resource by key word
<br>
operationId: ResourceController.Get
parameters:
- in: path
name: search
description: the search you want to get
required: true
type: string
responses:
"200":
description: '{resource} models.resource'
/storage/:
get:
tags:
- storage
description: |-
find storage by id
<br>
operationId: StorageController.GetAll
responses:
"200":
description: '{storage} models.storage'
post:
tags:
- storage
description: |-
create storage
<br>
operationId: StorageController.Create
parameters:
- in: body
name: storage
description: body for storage content (Json format)
required: true
schema:
$ref: '#/definitions/json'
responses:
"200":
description: '{storage} models.storage'
/storage/{id}:
get:
tags:
- storage
description: |-
find storage by id
<br>
operationId: StorageController.Get
parameters:
- in: path
name: id
description: the id you want to get
required: true
type: string
responses:
"200":
description: '{storage} models.storage'
put:
tags:
- storage
description: |-
create storages
<br>
operationId: StorageController.Update
parameters:
- in: path
name: id
description: the storage id you want to get
required: true
type: string
- in: body
name: body
description: The storage content
required: true
schema:
$ref: '#/definitions/models.storage'
responses:
"200":
description: '{storage} models.storage'
delete:
tags:
- storage
description: |-
delete the storage
<br>
operationId: StorageController.Delete
parameters:
- in: path
name: id
description: The id you want to delete
required: true
type: string
responses:
"200":
description: '{storage} delete success!'
/storage/{search}:
get:
tags:
- storage
description: |-
find storage by key word
<br>
operationId: StorageController.Get
parameters:
- in: path
name: search
description: the search you want to get
required: true
type: string
responses:
"200":
description: '{storage} models.storage'
/version/:
get:
tags:
- version
description: |-
get version
<br>
operationId: VersionController.GetAll
responses:
"200":
description: ""
/workflow/:
get:
tags:
- workflow
description: |-
find workflow by id
<br>
operationId: WorkflowController.GetAll
responses:
"200":
description: '{workflow} models.workflow'
post:
tags:
- workflow
description: |-
create workflow
<br>
operationId: WorkflowController.Create
parameters:
- in: body
name: workflow
description: body for workflow content (Json format)
required: true
schema:
$ref: '#/definitions/json'
responses:
"200":
description: '{workflow} models.workflow'
/workflow/{id}:
get:
tags:
- workflow
description: |-
find workflow by id
<br>
operationId: WorkflowController.Get
parameters:
- in: path
name: id
description: the id 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 workflow id 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: '{workflow} models.workflow'
delete:
tags:
- workflow
description: |-
delete the workflow
<br>
operationId: WorkflowController.Delete
parameters:
- in: path
name: id
description: The id you want to delete
required: true
type: string
responses:
"200":
description: '{workflow} delete success!'
/workflow/{search}:
get:
tags:
- workflow
description: |-
find workflow by key word
<br>
operationId: WorkflowController.Get
parameters:
- in: path
name: search
description: the search you want to get
required: true
type: string
responses:
"200":
description: '{workflow} models.workflow'
definitions:
json:
title: json
type: object
models.data:
title: data
type: object
models.datacenter:
title: datacenter
type: object
models.processing:
title: processing
type: object
models.storage:
title: storage
type: object
models.workflow:
title: workflow
type: object
tags:
- name: resource
description: |
Operations about resource
- name: data
description: |
Operations about data
- name: datacenter
description: |
Operations about datacenter
- name: storage
description: |
Operations about storage
- name: processing
description: |
Operations about processing
- name: workflow
description: |
Operations about workflow
- name: version
description: |
VersionController operations for Version