oc-catalog/swagger/swagger.yml

swagger: "2.0"
info:
  title: oc-catalog
  description: |
    OpenCloud catalog
  version: 1.0.0
  termsOfService: http://cloud.o-forge.io/
  contact:
    email: admin@o-cloud.io
  license:
    name: AGPL
    url: https://www.gnu.org/licenses/agpl-3.0.html
basePath: /oc/
paths:
  /compute/:
    get:
      tags:
      - compute
      description: |-
        find compute by id
        <br>
      operationId: ComputeController.GetAll
      parameters:
      - in: query
        name: is_draft
        description: draft wished
        type: string
      responses:
        "200":
          description: '{compute} models.compute'
    post:
      tags:
      - compute
      description: |-
        create compute
        <br>
      operationId: ComputeController.Create
      parameters:
      - in: body
        name: compute
        description: body for compute content (Json format)
        required: true
        schema:
          $ref: '#/definitions/json'
      responses:
        "200":
          description: '{compute} models.compute'
  /compute/{id}:
    get:
      tags:
      - compute
      description: |-
        find compute by id
        <br>
      operationId: ComputeController.Get
      parameters:
      - in: path
        name: id
        description: the id you want to get
        required: true
        type: string
      responses:
        "200":
          description: '{compute} models.compute'
    put:
      tags:
      - compute
      description: |-
        create computes
        <br>
      operationId: ComputeController.Update
      parameters:
      - in: path
        name: id
        description: the compute id you want to get
        required: true
        type: string
      - in: body
        name: body
        description: The compute content
        required: true
        schema:
          $ref: '#/definitions/models.compute'
      responses:
        "200":
          description: '{compute} models.compute'
    delete:
      tags:
      - compute
      description: |-
        delete the compute
        <br>
      operationId: ComputeController.Delete
      parameters:
      - in: path
        name: id
        description: The id you want to delete
        required: true
        type: string
      responses:
        "200":
          description: '{compute} delete success!'
  /compute/search/{search}:
    get:
      tags:
      - compute
      description: |-
        find compute by key word
        <br>
      operationId: ComputeController.Get
      parameters:
      - in: path
        name: search
        description: the search you want to get
        required: true
        type: string
      - in: query
        name: is_draft
        description: draft wished
        type: string
      responses:
        "200":
          description: '{compute} models.compute'
  /data/:
    get:
      tags:
      - data
      description: |-
        find data by id
        <br>
      operationId: DataController.GetAll
      parameters:
      - in: query
        name: is_draft
        description: draft wished
        type: string
      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/{search}:
    get:
      tags:
      - data
      responses:
        "200":
          description: '{data} models.data'
  /enum/booking/status:
    get:
      tags:
      - enum
      description: |-
        get list of Infrastructure
        <br>
      operationId: EnumController.BookingStatus
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/infrastructure:
    get:
      tags:
      - enum
      description: |-
        get list of Infrastructure
        <br>
      operationId: EnumController.EnumInfrastructure
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/refund/type:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumRefundType
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/strategy/buy:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStrategyBuy
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/strategy/data:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStrategyData
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/strategy/privilege:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStrategyPrivilege
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/strategy/privilege/storage:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStrategyPrivilegeStorage
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/strategy/storage:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStrategyStorage
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/pricing/strategy/time:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStrategyTime
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/resource/type:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumResourceType
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/status:
    get:
      tags:
      - enum
      description: |-
        get list of status
        <br>
      operationId: EnumController.EnumStatus
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/storage/size:
    get:
      tags:
      - enum
      description: |-
        get list of StorageSize
        <br>
      operationId: EnumController.EnumStorageSize
      responses:
        "200":
          description: '{resource} models.resource'
  /enum/storage/type:
    get:
      tags:
      - enum
      description: |-
        get list of StorageType
        <br>
      operationId: EnumController.EnumStorageType
      responses:
        "200":
          description: '{resource} models.resource'
  /processing/:
    get:
      tags:
      - processing
      description: |-
        find processing by id
        <br>
      operationId: ProcessingController.GetAll
      parameters:
      - in: query
        name: is_draft
        description: draft wished
        type: string
      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/{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
      - in: query
        name: is_draft
        description: draft wished
        type: string
      responses:
        "200":
          description: '{processing} models.processing'
  /resource/:
    get:
      tags:
      - resource
      description: |-
        find resource by id
        <br>
      operationId: ResourceController.GetAll
      parameters:
      - in: query
        name: is_draft
        description: draft wished
        type: string
      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/{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
      - in: query
        name: is_draft
        description: draft wished
        type: string
      responses:
        "200":
          description: '{resource} models.resource'
  /storage/:
    get:
      tags:
      - storage
      description: |-
        find storage by id
        <br>
      operationId: StorageController.GetAll
      parameters:
      - in: query
        name: is_draft
        description: draft wished
        type: string
      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/{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
      - in: query
        name: is_draft
        description: draft wished
        type: string
      responses:
        "200":
          description: '{storage} models.storage'
  /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: ""
  /workflow/:
    get:
      tags:
      - workflow
      description: |-
        find workflow by id
        <br>
      operationId: WorkflowController.GetAll
      parameters:
      - in: query
        name: is_draft
        description: draft wished
        type: string
      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/{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
      - in: query
        name: is_draft
        description: draft wished
        type: string
      responses:
        "200":
          description: '{workflow} models.workflow'
definitions:
  json:
    title: json
    type: object
  models.compute:
    title: compute
    type: object
  models.data:
    title: data
    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: compute
  description: |
    Operations about compute
- name: storage
  description: |
    Operations about storage
- name: processing
  description: |
    Operations about processing
- name: workflow
  description: |
    Operations about workflow
- name: enum
  description: |
    Operations about resource
- name: version
  description: |
    VersionController operations for Version