swagger: '2.0'
info:
  description: Configuration for License Information resource.
  version: 'v2'
  title: license_info
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: license_info
    description: License Information
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: System generated value
   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/license_info:
    get:
      tags:
        - license_info
      summary: GET all license_info
      operationId: getall_license_info
      description: Use this operation to get license information
      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 license_info 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 license_info 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 license_info resources.
          enum:
            - yes
      responses:
        200:
          description:  for license_info
          schema: 
              $ref: '#/definitions/getlicense_infosResponse'
        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'

  /massvc/{customerid}/nitro/v2/config/license_info/{id}:
    get:
      tags:
        - license_info
      summary: GET by key for license_info
      operationId: getbykey_license_info
      description: Use this operation to get license information
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - 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
      responses:
        200:
          description:  for license_info
          schema: 
              $ref: '#/definitions/getlicense_infoResponse'
        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'

    post:
      tags:
        - license_info
      summary: POST operation with actions for license_info
      operationId: post_license_info_actions
      description: POST operation with actions for license_info
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - 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: action
          type: string
          required: true
          enum: [apply]
          description: >
            actions:
              * `apply` - 

        - in: body
          name: license_info
          description: license_info object
          schema:
              $ref: '#/definitions/addlicense_infoRequest'
      responses:
        200:
          description: apply for license_info
          schema: 
              $ref: '#/definitions/addlicense_infoResponse'
        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:
  addlicense_infoRequest:
    type: object
    required:
      - license_info
    properties:
      license_info:
        $ref: '#/definitions/license_info_readwrite'
    title: addlicense_infoRequest
    example:
      license_info:
        sync_operation: "true"

  addlicense_infoResponse:
    type: object
    required:
      - license_info
    properties:
      license_info:
        $ref: '#/definitions/license_info'
    title: addlicense_infoResponse
    example:
      license_info:
        license_type: "string_value"
        user_info: [{        no_of_license: "integer_value"
,        parent_name: "string_value"
,        time: "integer_value"
,        name: "string_value"
,        id: "string_value"
,        node: "string_value"
,        display: "string_value"
,        parent_id: "string_value"
}]
        feature: "string_value"
        burst_license_available: "0"
        license_used: "integer_value"
        sync_operation: "true"
        act_id: "string_value"
        vpx_license_used: "0"
        id: "a2f7a85e-f388-4d2d-ae0e-646b4f66797e"
        product: "string_value"
        license_available: "integer_value"

  getlicense_infoResponse:
    type: object
    required:
      - license_info
    properties:
      license_info:
        $ref: '#/definitions/license_info'
    title: getlicense_infoResponse
    example:
      license_info:
        license_type: "string_value"
        user_info: [{        no_of_license: "integer_value"
,        parent_name: "string_value"
,        time: "integer_value"
,        name: "string_value"
,        id: "string_value"
,        node: "string_value"
,        display: "string_value"
,        parent_id: "string_value"
}]
        feature: "string_value"
        burst_license_available: "0"
        license_used: "integer_value"
        sync_operation: "true"
        act_id: "string_value"
        vpx_license_used: "0"
        id: "a2f7a85e-f388-4d2d-ae0e-646b4f66797e"
        product: "string_value"
        license_available: "integer_value"

  getlicense_infosResponse:
    type: object
    required:
      - license_info
    properties:
      license_info:
        type: array
        items:
          $ref: '#/definitions/license_info'
    title: getlicense_infosResponse
    example:
      license_info:
        license_type: "string_value"
        user_info: [{        no_of_license: "integer_value"
,        parent_name: "string_value"
,        time: "integer_value"
,        name: "string_value"
,        id: "string_value"
,        node: "string_value"
,        display: "string_value"
,        parent_id: "string_value"
}]
        feature: "string_value"
        burst_license_available: "0"
        license_used: "integer_value"
        sync_operation: "true"
        act_id: "string_value"
        vpx_license_used: "0"
        id: "a2f7a85e-f388-4d2d-ae0e-646b4f66797e"
        product: "string_value"
        license_available: "integer_value"

  license_info_readwrite:
    type: object
    properties:
      sync_operation:
        description: "sync operation"
        type: boolean
        format: boolean

  license_info:
    allOf:
      -
        properties:
          id:
            description: System generated value
            type: string
            format: string
          license_type:
             description: "License Type [Retail, NFR, Eval, TP, System]"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          user_info:
            type: array
            items:
              $ref: '#/definitions/license_user_detail'
          feature:
             description: "Feature"
             type: string
             format: string
             minLength: 1
             maxLength: 256
          burst_license_available:
             description: "Burst license available for this license"
             type: integer
             format: int32
          license_used:
             description: "Used Licenses"
             type: integer
             format: int32
          act_id:
             description: "Activity Id"
             type: string
             format: string
          vpx_license_used:
             description: "Total license used by ADC/SDX"
             type: integer
             format: int32
          product:
             description: "Product"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          license_available:
             description: "Available Licenses"
             type: integer
             format: int32
      - $ref: '#/definitions/license_info_readwrite'

  license_user_detail_readwrite:
    type: object
    properties:
      parent_name:
        type: string
        format: string
      parent_id:
        type: string
        format: string

  license_user_detail:
    allOf:
      -
        properties:
          id:
            type: string
            format: string
          no_of_license:
             description: "No of licenses"
             type: integer
             format: int32
          time:
             description: "Time"
             type: integer
             format: int32
          name:
             description: "Name"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          node:
             description: "Node"
             type: string
             format: string
             minLength: 1
             maxLength: 128
          display:
             description: "display"
             type: string
             format: string
             minLength: 1
             maxLength: 64
      - $ref: '#/definitions/license_user_detail_readwrite'

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