swagger: '2.0'
info:
  description: Configuration for This includes the application components (virtual servers) resource.
  version: 'v2'
  title: app_component
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: app_component
    description: This includes the application components (virtual servers)
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  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_component:
    get:
      tags:
        - app_component
      summary: GET all app_component
      operationId: getall_app_component
      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_component 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_component 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_component resources.
          enum:
            - yes
      responses:
        200:
          description:  for app_component
          schema: 
              $ref: '#/definitions/getapp_componentsResponse'
        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_componentResponse:
    type: object
    required:
      - app_component
    properties:
      app_component:
        $ref: '#/definitions/app_component'
    title: getapp_componentResponse
    example:
      app_component:
        export_option: "string_value"
        name: "CPU_Dashboard"
        hostname: "NA"
        display_name: "NA"
        state: "Down"
        ns_ip_address: "1.1.1.1"
        vsvr_type: "string_value"
        vsvr_ip_address: "string_value"
        configuration_path: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "NA"

  getapp_componentsResponse:
    type: object
    required:
      - app_component
    properties:
      app_component:
        type: array
        items:
          $ref: '#/definitions/app_component'
    title: getapp_componentsResponse
    example:
      app_component:
        export_option: "string_value"
        name: "CPU_Dashboard"
        hostname: "NA"
        display_name: "NA"
        state: "Down"
        ns_ip_address: "1.1.1.1"
        vsvr_type: "string_value"
        vsvr_ip_address: "string_value"
        configuration_path: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "NA"

  app_component_readwrite:
    type: object
    properties:
      export_option:
        description: "Export Options - webinsight, securityinsight."
        type: string
        format: string
      name:
        description: "name"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      hostname:
        description: "Hostname of NetScaler on which vserver created."
        type: string
        format: string
      state:
        description: "state"
        type: string
        format: string
      ns_ip_address:
        description: "Device IP Address"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      vsvr_type:
        description: "Vserver type Eg. HTTP"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      vsvr_ip_address:
        description: "Vserver IP Address"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      id:
        description: "ID"
        type: string
        format: string
      type:
        description: "Application type ( CS/LB/GSLB etc.)"
        type: string
        format: string
        minLength: 1
        maxLength: 1024

  app_component:
    allOf:
      -
        properties:
          display_name:
             description: "Display Name"
             type: string
             format: string
          configuration_path:
             description: "Config Path of HA Proxies on this HAPRoxy Host."
             type: string
             format: string
      - $ref: '#/definitions/app_component_readwrite'

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