swagger: '2.0'
info:
  description: Configuration for Configuration Variables for use in configuration template resource.
  version: 'v2'
  title: config_variable
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: config_variable
    description: Configuration Variables for use in configuration template
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 config variable
   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/config_variable:
    get:
      tags:
        - config_variable
      summary: GET all config_variable
      operationId: getall_config_variable
      description: Use this operation to get config variable.
      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 config_variable 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 config_variable 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 config_variable resources.
          enum:
            - yes
      responses:
        200:
          description:  for config_variable
          schema: 
              $ref: '#/definitions/getconfig_variablesResponse'
        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:
        - config_variable
      summary: POST operation for config_variable
      operationId: post_config_variable
      description: POST operation for config_variable
      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: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: body
          name: config_variable
          description: config_variable object
          schema:
              $ref: '#/definitions/addconfig_variableRequest'
      responses:
        200:
          description: add for config_variable
          schema: 
              $ref: '#/definitions/addconfig_variableResponse'
        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/config_variable/{id}:
    get:
      tags:
        - config_variable
      summary: GET by key for config_variable
      operationId: getbykey_config_variable
      description: Use this operation to get config variable.
      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: add for config_variable
          schema: 
              $ref: '#/definitions/getconfig_variableResponse'
        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:
  addconfig_variableRequest:
    type: object
    required:
      - config_variable
    properties:
      config_variable:
        $ref: '#/definitions/config_variable_readwrite'
    title: addconfig_variableRequest
    example:
      config_variable:
        parent_name: "template1"
        name: "variable1"
        valuex: "password"
        display_name: "lb vserver1"
        description: "NetScaler Console: System: User Administration"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        required: "true"
        default_value: "lbvserver1"
        type: "Text Field"
        values_enum_db: "string_value"
        values_enum: ["string_value1","string_value2"]

  addconfig_variableResponse:
    type: object
    required:
      - config_variable
    properties:
      config_variable:
        $ref: '#/definitions/config_variable'
    title: addconfig_variableResponse
    example:
      config_variable:
        parent_name: "template1"
        name: "variable1"
        valuex: "password"
        display_name: "lb vserver1"
        description: "NetScaler Console: System: User Administration"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        required: "true"
        default_value: "lbvserver1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "Text Field"
        values_enum_db: "string_value"
        values_enum: ["string_value1","string_value2"]

  getconfig_variableResponse:
    type: object
    required:
      - config_variable
    properties:
      config_variable:
        $ref: '#/definitions/config_variable'
    title: getconfig_variableResponse
    example:
      config_variable:
        parent_name: "template1"
        name: "variable1"
        valuex: "password"
        display_name: "lb vserver1"
        description: "NetScaler Console: System: User Administration"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        required: "true"
        default_value: "lbvserver1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "Text Field"
        values_enum_db: "string_value"
        values_enum: ["string_value1","string_value2"]

  getconfig_variablesResponse:
    type: object
    required:
      - config_variable
    properties:
      config_variable:
        type: array
        items:
          $ref: '#/definitions/config_variable'
    title: getconfig_variablesResponse
    example:
      config_variable:
        parent_name: "template1"
        name: "variable1"
        valuex: "password"
        display_name: "lb vserver1"
        description: "NetScaler Console: System: User Administration"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        required: "true"
        default_value: "lbvserver1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "Text Field"
        values_enum_db: "string_value"
        values_enum: ["string_value1","string_value2"]

  config_variable_readwrite:
    type: object
    properties:
      parent_name:
        description: "Parent name of config variable"
        type: string
        format: string
      name:
        description: "Variable name"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      valuex:
        description: "Secure Value of the Variable to be used for all device ips/groups"
        type: string
        format: password
      display_name:
        description: "Display name of configuration variable"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      description:
        description: "Description of configuration variable"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      parent_id:
        description: "Parent Id of config variable"
        type: string
        format: uuid
      required:
        description: "If it is required argument for command then true else false."
        type: boolean
        format: boolean
      default_value:
        description: "Default Value of configuration variable"
        type: string
        format: string
      type:
        description: "Type of Variable Text Field, Numeric Text Field, Choice, File, IP Addrss Field, Password Field"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      values_enum_db:
        description: "Comma separated list of possible values of variable"
        type: string
        format: string
      values_enum:
        description: "Possible Values values for choice type variable"
        type: array
        items:
          type: string
          format: string

  config_variable:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all config variable
            type: string
            format: uuid
      - $ref: '#/definitions/config_variable_readwrite'

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