logger__v1.yml

openapi: 3.0.0
info:
  version: "1"
  title: "Logger"
  description: Writing logs by http request
servers:
  - url: http://rollun-net-prvt/openapi/Logger/v1
  - url: https://rollun.net/api/openapi/Logger/v1
tags:
  - name: Logs
paths:
  "/logs":
    post:
      tags:
        - Logs
      summary: "Add log record"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Log'
      responses:
        "200":
          description: 'Success'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogResponse'
        "500":
          description: 'Some internal error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Message:
      type: object
      properties:
        level:
          type: string
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
            - debug
        type:
          type: string
          enum:
            - UNDEFINED
          description: >
            UNDEFINED - Any undefined message type
        text:
          type: string
          description: Message, that describes what went wrong
    ErrorResponse:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: "#/components/schemas/Message"
      description: "Message field is not required"
    SuccessResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
      type: object
      properties:
        data:
          type: object
    LogResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessResponse'
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Log'

    ## Resources
    Log:
      type: object
      required:
        - level
        - message
        - indexName
      properties:
        level:
          type: string
          description: PSR-3 log level
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
            - debug
        message:
          type: string
          description: Log message
        indexName:
          type: string
          description: Index name in Elasticsearch where log record will be added
        context:
          type: object
          description: Any extra information that does not fit in the message
          additionalProperties: true