swagger: '2.0'
info:
  description: Configuration for ADC Feature Usage Information resource.
  version: 'v2'
  title: adc_feature_usage
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: adc_feature_usage
    description: ADC Feature Usage Information
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
   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/adc_feature_usage:
    get:
      tags:
        - adc_feature_usage
      summary: GET all adc_feature_usage
      operationId: getall_adc_feature_usage
      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 adc_feature_usage 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 adc_feature_usage 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 adc_feature_usage resources.
          enum:
            - yes
      responses:
        200:
          description:  for adc_feature_usage
          schema: 
              $ref: '#/definitions/getadc_feature_usagesResponse'
        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:
  getadc_feature_usageResponse:
    type: object
    required:
      - adc_feature_usage
    properties:
      adc_feature_usage:
        $ref: '#/definitions/adc_feature_usage'
    title: getadc_feature_usageResponse
    example:
      adc_feature_usage:
        waf: "true"
        timestamp: "1581396152"
        icaproxy: "true"
        bot: "true"
        ip_address: "1.1.1.1"
        id: "a36127db-23a5-4ad1-b329-0a067cd0f431"
        sslvpn: "true"

  getadc_feature_usagesResponse:
    type: object
    required:
      - adc_feature_usage
    properties:
      adc_feature_usage:
        type: array
        items:
          $ref: '#/definitions/adc_feature_usage'
    title: getadc_feature_usagesResponse
    example:
      adc_feature_usage:
        waf: "true"
        timestamp: "1581396152"
        icaproxy: "true"
        bot: "true"
        ip_address: "1.1.1.1"
        id: "a36127db-23a5-4ad1-b329-0a067cd0f431"
        sslvpn: "true"

  adc_feature_usage_readwrite:
    type: object
    properties:
      waf:
        description: "WAF feature config is present or not"
        type: boolean
        format: boolean
      icaproxy:
        description: "ICAProxy feature config is present or not"
        type: boolean
        format: boolean
      bot:
        description: "BOT feature config is present or not"
        type: boolean
        format: boolean
      sslvpn:
        description: "SSLVPN feature config is present or not"
        type: boolean
        format: boolean

  adc_feature_usage:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: uuid
          timestamp:
             description: "Timestamp of the feature details"
             type: integer
             format: int32
          ip_address:
             description: "IP address of device"
             type: string
             format: string
             minLength: 1
             maxLength: 64
      - $ref: '#/definitions/adc_feature_usage_readwrite'

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