swagger: '2.0'
info:
  description: Configuration for Syslog generic table resource.
  version: 'v2'
  title: syslog_generic
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: syslog_generic
    description: Syslog generic table
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 syslog generic record.
   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/syslog_generic:
    get:
      tags:
        - syslog_generic
      summary: GET all syslog_generic
      operationId: getall_syslog_generic
      description: Report for generic syslog message received by this collector.
      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 syslog_generic 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 syslog_generic 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 syslog_generic resources.
          enum:
            - yes
      responses:
        200:
          description:  for syslog_generic
          schema: 
              $ref: '#/definitions/getsyslog_genericsResponse'
        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/syslog_generic/{id}:
    get:
      tags:
        - syslog_generic
      summary: GET by key for syslog_generic
      operationId: getbykey_syslog_generic
      description: Report for generic syslog message received by this collector.
      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 syslog_generic
          schema: 
              $ref: '#/definitions/getsyslog_genericResponse'
        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:
  getsyslog_genericResponse:
    type: object
    required:
      - syslog_generic
    properties:
      syslog_generic:
        $ref: '#/definitions/syslog_generic'
    title: getsyslog_genericResponse
    example:
      syslog_generic:
        source: "1.1.1.1"
        device_family: "ns"
        event_id: "number_value"
        system_name: "string_value"
        full_message: "string_value"
        isparsed: "boolean_value"
        ttime: "1580971329"
        device_type: "nsvpx"
        host_name: "test"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "GET"
        syslog_msg: "string_value"
        severity: "debug"
        module: "api"

  getsyslog_genericsResponse:
    type: object
    required:
      - syslog_generic
    properties:
      syslog_generic:
        type: array
        items:
          $ref: '#/definitions/syslog_generic'
    title: getsyslog_genericsResponse
    example:
      syslog_generic:
        source: "1.1.1.1"
        device_family: "ns"
        event_id: "number_value"
        system_name: "string_value"
        full_message: "string_value"
        isparsed: "boolean_value"
        ttime: "1580971329"
        device_type: "nsvpx"
        host_name: "test"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        type: "GET"
        syslog_msg: "string_value"
        severity: "debug"
        module: "api"


  syslog_generic:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the syslog generic record.
            type: string
            format: uuid
          source:
             description: "source from where the syslog is generated"
             type: string
             format: ipaddress
             maxLength: 255
          device_family:
             description: "Device family"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          event_id:
             description: "<TODO>"
             type: number
             format: int64
          system_name:
             description: "Device System Name"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          full_message:
             description: "Syslog original Message."
             type: string
             format: string
             maxLength: 2000
          isparsed:
             description: "Whethersyslog message is parsed successfully or not"
             type: boolean
             format: boolean
          ttime:
             description: "ttime when the syslog is generated"
             type: number
             format: int64
          device_type:
             description: "Device Type"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          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 Name."
             type: string
             format: string
             maxLength: 255
          syslog_msg:
             description: "Syslog original Message."
             type: string
             format: string
             maxLength: 2000
          severity:
             description: "severity"
             type: string
             format: string
          module:
             description: "Module Name."
             type: string
             format: string
             maxLength: 255

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