swagger: '2.0'
info:
  description: Configuration for NetScaler GSLbvserver Domain Information resource.
  version: 'v2'
  title: ns_gslbvserver_domain
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_gslbvserver_domain
    description: NetScaler GSLbvserver Domain 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/ns_gslbvserver_domain:
    get:
      tags:
        - ns_gslbvserver_domain
      summary: GET all ns_gslbvserver_domain
      operationId: getall_ns_gslbvserver_domain
      description: Use this operation to get GSLB Domain 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 ns_gslbvserver_domain 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 ns_gslbvserver_domain 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 ns_gslbvserver_domain resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_gslbvserver_domain
          schema: 
              $ref: '#/definitions/getns_gslbvserver_domainsResponse'
        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/ns_gslbvserver_domain/{id}:
    get:
      tags:
        - ns_gslbvserver_domain
      summary: GET by key for ns_gslbvserver_domain
      operationId: getbykey_ns_gslbvserver_domain
      description: Use this operation to get GSLB Domain 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 ns_gslbvserver_domain
          schema: 
              $ref: '#/definitions/getns_gslbvserver_domainResponse'
        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:
        - ns_gslbvserver_domain
      summary: POST operation with actions for ns_gslbvserver_domain
      operationId: post_ns_gslbvserver_domain_actions
      description: POST operation with actions for ns_gslbvserver_domain
      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: [poll]
          description: >
            actions:
              * `poll` - Use this operation to poll the GSLB Domain

        - in: body
          name: ns_gslbvserver_domain
          description: ns_gslbvserver_domain object
          schema:
              $ref: '#/definitions/addns_gslbvserver_domainRequest'
      responses:
        200:
          description: poll for ns_gslbvserver_domain
          schema: 
              $ref: '#/definitions/addns_gslbvserver_domainResponse'
        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:
  addns_gslbvserver_domainRequest:
    type: object
    required:
      - ns_gslbvserver_domain
    properties:
      ns_gslbvserver_domain:
        $ref: '#/definitions/ns_gslbvserver_domain_readwrite'
    title: addns_gslbvserver_domainRequest
    example:
      ns_gslbvserver_domain:
        name: "www.citrix.com"
        ns_ip_address: "1.1.1.1"

  addns_gslbvserver_domainResponse:
    type: object
    required:
      - ns_gslbvserver_domain
    properties:
      ns_gslbvserver_domain:
        $ref: '#/definitions/ns_gslbvserver_domain'
    title: addns_gslbvserver_domainResponse
    example:
      ns_gslbvserver_domain:
        name: "www.citrix.com"
        poll_time: "1580714461"
        display_name: "display_name"
        vservername: "string_value"
        state: "UP"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        servicetype: "http"

  getns_gslbvserver_domainResponse:
    type: object
    required:
      - ns_gslbvserver_domain
    properties:
      ns_gslbvserver_domain:
        $ref: '#/definitions/ns_gslbvserver_domain'
    title: getns_gslbvserver_domainResponse
    example:
      ns_gslbvserver_domain:
        name: "www.citrix.com"
        poll_time: "1580714461"
        display_name: "display_name"
        vservername: "string_value"
        state: "UP"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        servicetype: "http"

  getns_gslbvserver_domainsResponse:
    type: object
    required:
      - ns_gslbvserver_domain
    properties:
      ns_gslbvserver_domain:
        type: array
        items:
          $ref: '#/definitions/ns_gslbvserver_domain'
    title: getns_gslbvserver_domainsResponse
    example:
      ns_gslbvserver_domain:
        name: "www.citrix.com"
        poll_time: "1580714461"
        display_name: "display_name"
        vservername: "string_value"
        state: "UP"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        servicetype: "http"

  ns_gslbvserver_domain_readwrite:
    type: object
    properties:
      name:
        description: "GSLB Domain Name"
        type: string
        format: string
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64

  ns_gslbvserver_domain:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: uuid
          display_name:
             description: "Display Name"
             type: string
             format: string
          vservername:
             description: "GSLB Vserver name"
             type: string
             format: string
          partition_name:
             description: "Partition Name"
             type: string
             format: string
      - $ref: '#/definitions/ns_gslbvserver_domain_readwrite'

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