swagger: '2.0'
info:
  description: Configuration for Holds information regarding VIP and thirdparty VIP autoselection preference. resource.
  version: 'v2'
  title: autoselection_preference
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: autoselection_preference
    description: Holds information regarding VIP and thirdparty VIP autoselection preference.
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Primary key for this table.
   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/autoselection_preference:
    get:
      tags:
        - autoselection_preference
      summary: GET all autoselection_preference
      operationId: getall_autoselection_preference
      description: Use this operation to get vip_autoselection_preference
      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 autoselection_preference 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 autoselection_preference 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 autoselection_preference resources.
          enum:
            - yes
      responses:
        200:
          description:  for autoselection_preference
          schema: 
              $ref: '#/definitions/getautoselection_preferencesResponse'
        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/autoselection_preference/{id}:
    get:
      tags:
        - autoselection_preference
      summary: GET by key for autoselection_preference
      operationId: getbykey_autoselection_preference
      description: Use this operation to get vip_autoselection_preference
      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 autoselection_preference
          schema: 
              $ref: '#/definitions/getautoselection_preferenceResponse'
        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'

    put:
      tags:
        - autoselection_preference
      summary: PUT for autoselection_preference
      operationId: putbykey_autoselection_preference
      description: Use this operation to modify vip_autoselection_preference
      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: body
          name: autoselection_preference
          description: autoselection_preference object
          schema:
              $ref: '#/definitions/modifyautoselection_preferenceRequest'
      responses:
        200:
          description:  for autoselection_preference
          schema: 
              $ref: '#/definitions/modifyautoselection_preferenceResponse'
        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:
  getautoselection_preferenceResponse:
    type: object
    required:
      - autoselection_preference
    properties:
      autoselection_preference:
        $ref: '#/definitions/autoselection_preference'
    title: getautoselection_preferenceResponse
    example:
      autoselection_preference:
        enable_non_access_vserver: "false"
        enable_auto_tp_vserver_selection: "true"
        enable_auto_vip_selection: "true"
        type: "1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getautoselection_preferencesResponse:
    type: object
    required:
      - autoselection_preference
    properties:
      autoselection_preference:
        type: array
        items:
          $ref: '#/definitions/autoselection_preference'
    title: getautoselection_preferencesResponse
    example:
      autoselection_preference:
        enable_non_access_vserver: "false"
        enable_auto_tp_vserver_selection: "true"
        enable_auto_vip_selection: "true"
        type: "1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  modifyautoselection_preferenceRequest:
    type: object
    required:
      - autoselection_preference
    properties:
      autoselection_preference:
        $ref: '#/definitions/autoselection_preference_readwrite'
    title: modifyautoselection_preferenceRequest
    example:
      autoselection_preference:
        enable_non_access_vserver: "false"
        enable_auto_tp_vserver_selection: "true"
        enable_auto_vip_selection: "true"
        type: "1"

  modifyautoselection_preferenceResponse:
    type: object
    required:
      - autoselection_preference
    properties:
      autoselection_preference:
        $ref: '#/definitions/autoselection_preference'
    title: modifyautoselection_preferenceResponse
    example:
      autoselection_preference:
        enable_non_access_vserver: "false"
        enable_auto_tp_vserver_selection: "true"
        enable_auto_vip_selection: "true"
        type: "1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  autoselection_preference_readwrite:
    type: object
    properties:
      enable_non_access_vserver:
        description: "Enable auto selection of non Accesible Vservers"
        type: boolean
        format: boolean
      enable_auto_tp_vserver_selection:
        description: "Enable auto selection of Third Party Vservers"
        type: boolean
        format: boolean
      enable_auto_vip_selection:
        description: "Enable auto selection of vips"
        type: boolean
        format: boolean
      type:
        type: string
        format: string

  autoselection_preference:
    allOf:
      -
        properties:
          id:
            description: Primary key for this table.
            type: string
            format: uuid
      - $ref: '#/definitions/autoselection_preference_readwrite'

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