swagger: '2.0'
info:
  description: Configuration for System Log Message resource.
  version: 'v2'
  title: syslog_messages
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: syslog_messages
    description: System Log Message
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 system log entries
   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_messages:
    get:
      tags:
        - syslog_messages
      summary: GET all syslog_messages
      operationId: getall_syslog_messages
      description: Use this operation to get system log messages
      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_messages 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_messages 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_messages resources.
          enum:
            - yes
      responses:
        200:
          description:  for syslog_messages
          schema: 
              $ref: '#/definitions/getsyslog_messagessResponse'
        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_messages/{id}:
    get:
      tags:
        - syslog_messages
      summary: GET by key for syslog_messages
      operationId: getbykey_syslog_messages
      description: Use this operation to get system log messages
      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_messages
          schema: 
              $ref: '#/definitions/getsyslog_messagesResponse'
        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_messagesResponse:
    type: object
    required:
      - syslog_messages
    properties:
      syslog_messages:
        $ref: '#/definitions/syslog_messages'
    title: getsyslog_messagesResponse
    example:
      syslog_messages:
        source: "1.1.1.1"
        event_type: "string_value"
        system_gmt_time: "1580971329"
        message: "ns_client_ipaddress : 1.1.1.1"
        app_name: "API"
        system_time: "1580971329"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        instance_ip: "1.1.1.1"
        severity: "Critical"
        module: "api"

  getsyslog_messagessResponse:
    type: object
    required:
      - syslog_messages
    properties:
      syslog_messages:
        type: array
        items:
          $ref: '#/definitions/syslog_messages'
    title: getsyslog_messagessResponse
    example:
      syslog_messages:
        source: "1.1.1.1"
        event_type: "string_value"
        system_gmt_time: "1580971329"
        message: "ns_client_ipaddress : 1.1.1.1"
        app_name: "API"
        system_time: "1580971329"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        instance_ip: "1.1.1.1"
        severity: "Critical"
        module: "api"

  syslog_messages_readwrite:
    type: object
    properties:
      source:
        description: "Source IP Address"
        type: string
        format: ipaddress
      event_type:
        description: "Event type"
        type: string
        format: string
      message:
        description: "Message"
        type: string
        format: string
      app_name:
        description: "Application Name"
        type: string
        format: string
      system_time:
        description: "System Time in local timezone"
        type: string
        format: string
      instance_ip:
        description: "Instance IP Address"
        type: string
        format: ipaddress
      severity:
        description: "Severity of the message"
        type: string
        format: string
      module:
        description: "Module name"
        type: string
        format: string

  syslog_messages:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the system log entries
            type: string
            format: uuid
          system_gmt_time:
             description: "System Time in GMT timezone"
             type: integer
             format: int32
      - $ref: '#/definitions/syslog_messages_readwrite'

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