swagger: '2.0'
info:
  description: Configuration for License Configuration resource.
  version: 'v2'
  title: license_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: license_config
    description: License Configuration
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_config:
    get:
      tags:
        - license_config
      summary: GET all license_config
      operationId: getall_license_config
      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_config 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_config 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_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for license_config
          schema: 
              $ref: '#/definitions/getlicense_configsResponse'
        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_config/{id}:
    get:
      tags:
        - license_config
      summary: GET by key for license_config
      operationId: getbykey_license_config
      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_config
          schema: 
              $ref: '#/definitions/getlicense_configResponse'
        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_config
      summary: POST operation with actions for license_config
      operationId: post_license_config_actions
      description: POST operation with actions for license_config
      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_config
          description: license_config object
          schema:
              $ref: '#/definitions/addlicense_configRequest'
      responses:
        200:
          description: apply for license_config
          schema: 
              $ref: '#/definitions/addlicense_configResponse'
        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_configRequest:
    type: object
    required:
      - license_config
    properties:
      license_config:
        $ref: '#/definitions/license_config_readwrite'
    title: addlicense_configRequest
    example:
      license_config:
        policyName: "string_value"
        max_limit: "0"
        ip_address: "1.1.1.1"

  addlicense_configResponse:
    type: object
    required:
      - license_config
    properties:
      license_config:
        $ref: '#/definitions/license_config'
    title: addlicense_configResponse
    example:
      license_config:
        policyName: "string_value"
        max_limit: "0"
        ip_address: "1.1.1.1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getlicense_configResponse:
    type: object
    required:
      - license_config
    properties:
      license_config:
        $ref: '#/definitions/license_config'
    title: getlicense_configResponse
    example:
      license_config:
        policyName: "string_value"
        max_limit: "0"
        ip_address: "1.1.1.1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getlicense_configsResponse:
    type: object
    required:
      - license_config
    properties:
      license_config:
        type: array
        items:
          $ref: '#/definitions/license_config'
    title: getlicense_configsResponse
    example:
      license_config:
        policyName: "string_value"
        max_limit: "0"
        ip_address: "1.1.1.1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  license_config_readwrite:
    type: object
    properties:
      policyName:
        description: "policyName"
        type: string
        format: string
        minLength: 1
        maxLength: 256
      max_limit:
        description: "Max limit"
        type: integer
        format: int32
      ip_address:
        description: "IP Addresse list"
        type: string
        format: string

  license_config:
    allOf:
      -
        properties:
          id:
            description: System generated value
            type: string
            format: string
      - $ref: '#/definitions/license_config_readwrite'

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