swagger: '2.0'
info:
  description: Configuration for VWAN EVENT resource.
  version: 'v2'
  title: vwan_event
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: vwan_event
    description: VWAN EVENT
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 the events
   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/vwan_event:
    get:
      tags:
        - vwan_event
      summary: GET all vwan_event
      operationId: getall_vwan_event
      description: Use this operation to get events
      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 vwan_event 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 vwan_event 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 vwan_event resources.
          enum:
            - yes
      responses:
        200:
          description:  for vwan_event
          schema: 
              $ref: '#/definitions/getvwan_eventsResponse'
        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/vwan_event/{id}:
    get:
      tags:
        - vwan_event
      summary: GET by key for vwan_event
      operationId: getbykey_vwan_event
      description: Use this operation to get events
      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 vwan_event
          schema: 
              $ref: '#/definitions/getvwan_eventResponse'
        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:
  getvwan_eventResponse:
    type: object
    required:
      - vwan_event
    properties:
      vwan_event:
        $ref: '#/definitions/vwan_event'
    title: getvwan_eventResponse
    example:
      vwan_event:
        source: "1.1.1.1"
        wan_link_state: "string_value"
        virtual_path: "string_value"
        status_message: "string_value"
        rpt_sample_time: "1580897863"
        virtual_path_state: "string_value"
        message: "ns_client_ipaddress : 1.1.1.1"
        host_name: "test"
        type: "NS"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        category: "entityDown"
        severity: "Major"
        wan_link: "string_value"

  getvwan_eventsResponse:
    type: object
    required:
      - vwan_event
    properties:
      vwan_event:
        type: array
        items:
          $ref: '#/definitions/vwan_event'
    title: getvwan_eventsResponse
    example:
      vwan_event:
        source: "1.1.1.1"
        wan_link_state: "string_value"
        virtual_path: "string_value"
        status_message: "string_value"
        rpt_sample_time: "1580897863"
        virtual_path_state: "string_value"
        message: "ns_client_ipaddress : 1.1.1.1"
        host_name: "test"
        type: "NS"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        category: "entityDown"
        severity: "Major"
        wan_link: "string_value"


  vwan_event:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the events
            type: string
            format: uuid
          source:
             description: "Source"
             type: string
             format: ipaddress
             minLength: 1
             maxLength: 128
          wan_link_state:
             description: "Internal Event ID used in the source device."
             type: string
             format: string
          virtual_path:
             description: "Operation Type"
             type: string
             format: string
          status_message:
             description: "status_message"
             type: string
             format: string
          rpt_sample_time:
             description: "Event Time"
             type: number
             format: int64
          virtual_path_state:
             description: "virtual_path_state"
             type: string
             format: string
          message:
             description: "VWAN Event_Message"
             type: string
             format: string
          host_name:
             description: "Assign hostname to managed device, if this is not provided, name will be set as host name "
             type: string
             format: string
             minLength: 1
             maxLength: 256
          type:
             description: "type"
             type: string
             format: string
          category:
             description: "Category of VWAN Event"
             type: string
             format: string
          severity:
             description: "Severity of Vwan Event"
             type: string
             format: string
             minLength: 1
             maxLength: 32
          wan_link:
             description: "WAN Link"
             type: string
             format: string

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