swagger: '2.0'
info:
  description: Configuration for Diagnostics Record Details resource.
  version: 'v2'
  title: diagnostics_details
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: diagnostics_details
    description: Diagnostics Record Details
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 PRIMARY_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/diagnostics_details:
    get:
      tags:
        - diagnostics_details
      summary: GET all diagnostics_details
      operationId: getall_diagnostics_details
      description: Use this operation to get diagnostic details
      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 diagnostics_details 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 diagnostics_details 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 diagnostics_details resources.
          enum:
            - yes
      responses:
        200:
          description:  for diagnostics_details
          schema: 
              $ref: '#/definitions/getdiagnostics_detailssResponse'
        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/diagnostics_details/{id}:
    get:
      tags:
        - diagnostics_details
      summary: GET by key for diagnostics_details
      operationId: getbykey_diagnostics_details
      description: Use this operation to get diagnostic details
      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 diagnostics_details
          schema: 
              $ref: '#/definitions/getdiagnostics_detailsResponse'
        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:
  getdiagnostics_detailsResponse:
    type: object
    required:
      - diagnostics_details
    properties:
      diagnostics_details:
        $ref: '#/definitions/diagnostics_details'
    title: getdiagnostics_detailsResponse
    example:
      diagnostics_details:
        msg: "The collector is not reachable from the instance af_collector_rest_1.1.1.1"
        job_id: "string_value"
        status: "Completed"
        hostname: "ADC16_Devlab"
        rpt_sample_time: "1580897863"
        sub_issue_type: "string_value"
        ns_ip_address: "1.1.1.1"
        vsrvr_name: "vpn1"
        feature: "HDX_INSIGHT"
        action: "Please check if NetScaler is able to reach collector through SNIP"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        issue_type: "Configuration"

  getdiagnostics_detailssResponse:
    type: object
    required:
      - diagnostics_details
    properties:
      diagnostics_details:
        type: array
        items:
          $ref: '#/definitions/diagnostics_details'
    title: getdiagnostics_detailssResponse
    example:
      diagnostics_details:
        msg: "The collector is not reachable from the instance af_collector_rest_1.1.1.1"
        job_id: "string_value"
        status: "Completed"
        hostname: "ADC16_Devlab"
        rpt_sample_time: "1580897863"
        sub_issue_type: "string_value"
        ns_ip_address: "1.1.1.1"
        vsrvr_name: "vpn1"
        feature: "HDX_INSIGHT"
        action: "Please check if NetScaler is able to reach collector through SNIP"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        issue_type: "Configuration"

  diagnostics_details_readwrite:
    type: object
    properties:
      msg:
        description: "Diagnosis Message"
        type: string
        format: string
        maxLength: 128
      hostname:
        description: "Hostname"
        type: string
        format: hostname
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
      vsrvr_name:
        description: "VServer Name"
        type: string
        format: string
      feature:
        description: "Feature being diagnosed for"
        type: string
        format: string
      action:
        description: "Diagnosis Message"
        type: string
        format: string
        maxLength: 128
      issue_type:
        description: "Category of issue that occured"
        type: string
        format: string

  diagnostics_details:
    allOf:
      -
        properties:
          id:
            description: Id is system generated PRIMARY_KEY
            type: string
            format: uuid
      - $ref: '#/definitions/diagnostics_details_readwrite'

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