swagger: '2.0'
info:
  description: Configuration for Details of the device used by managed app resource.
  version: 'v2'
  title: app_device
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: app_device
    description: Details of the device used by managed app
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key for all the app-device mapping
   required: true
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/app_device:
    get:
      tags:
        - app_device
      summary: GET all app_device
      operationId: getall_app_device
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the app_device resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the app_device resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of app_device resources.
          enum:
            - yes
      responses:
        200:
          description:  for app_device
          schema: 
              $ref: '#/definitions/getapp_devicesResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getapp_deviceResponse:
    type: object
    required:
      - app_device
    properties:
      app_device:
        $ref: '#/definitions/app_device'
    title: getapp_deviceResponse
    example:
      app_device:
        device_id: "5"
        parent_name: "parent_device"
        device_mgmt_ip: "1.1.1.1"
        id: "00000000-0000-375c-0000-000400000004"
        parent_id: "10"

  getapp_devicesResponse:
    type: object
    required:
      - app_device
    properties:
      app_device:
        type: array
        items:
          $ref: '#/definitions/app_device'
    title: getapp_devicesResponse
    example:
      app_device:
        device_id: "5"
        parent_name: "parent_device"
        device_mgmt_ip: "1.1.1.1"
        id: "00000000-0000-375c-0000-000400000004"
        parent_id: "10"

  app_device_readwrite:
    type: object
    properties:
      device_id:
        description: "Instance ID for the device"
        type: string
        format: string
      parent_name:
        description: "Nmae of the parent device"
        type: string
        format: string
      device_mgmt_ip:
        description: "IPv4 or IPv6 Address assigned to the device"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      parent_id:
        description: "Instance ID for the parent"
        type: string
        format: string

  app_device:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the app-device mapping
            type: string
            format: uuid
      - $ref: '#/definitions/app_device_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
