swagger: '2.0'
info:
  description: Configuration for NetScaler Summary resource.
  version: 'v2'
  title: ns_summary
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_summary
    description: NetScaler Summary
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  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_summary:
    get:
      tags:
        - ns_summary
      summary: GET all ns_summary
      operationId: getall_ns_summary
      description: Use this operation to get NetScaler device summary
      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_summary 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_summary 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_summary resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_summary
          schema: 
              $ref: '#/definitions/getns_summarysResponse'
        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:
  getns_summaryResponse:
    type: object
    required:
      - ns_summary
    properties:
      ns_summary:
        $ref: '#/definitions/ns_summary'
    title: getns_summaryResponse
    example:
      ns_summary:
        subcategory_name: "model"
        device_family: "ns"
        value: "0"
        category_type: "uptime"
        category_name: "less than 1 day"
        device_type: "ns"
        subcategory_type: "string_value"

  getns_summarysResponse:
    type: object
    required:
      - ns_summary
    properties:
      ns_summary:
        type: array
        items:
          $ref: '#/definitions/ns_summary'
    title: getns_summarysResponse
    example:
      ns_summary:
        subcategory_name: "model"
        device_family: "ns"
        value: "0"
        category_type: "uptime"
        category_name: "less than 1 day"
        device_type: "ns"
        subcategory_type: "string_value"


  ns_summary:
    allOf:
      -
        properties:
          subcategory_name:
             description: "Name of Subcategory"
             type: string
             format: string
          device_family:
             description: "Device family"
             type: string
             format: string
          value:
             description: "Value of category"
             type: number
             format: double
          category_type:
             description: "Type of Category"
             type: string
             format: string
          category_name:
             description: "Name of Category"
             type: string
             format: string
          device_type:
             description: "Device Type"
             type: string
             format: string
          subcategory_type:
             description: "Type of Subcategory"
             type: string
             format: string

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