openapi: 3.2.0
info:
  title: Fusio Log API
  version: '1'
  description: 'Operations tagged log across 2 of this provider''s published API definitions: fusio-backend.json, fusio-consumer.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://demo.fusio-project.org
tags:
- name: Log
paths:
  /backend/log/{log_id}:
    parameters:
    - name: log_id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Log
      description: Returns a specific log
      operationId: backend.log.get
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backend_Log'
        4XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
        5XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
      security:
      - app:
        - backend.log
      summary: Backend log get
      x-summary-source: derived
    servers:
    - url: https://demo.fusio-project.org
  /backend/log:
    get:
      tags:
      - Log
      description: Returns a paginated list of logs
      operationId: backend.log.getAll
      parameters:
      - name: startIndex
        in: query
        required: false
        schema:
          type: integer
      - name: count
        in: query
        required: false
        schema:
          type: integer
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: from
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: operationId
        in: query
        required: false
        schema:
          type: integer
      - name: appId
        in: query
        required: false
        schema:
          type: integer
      - name: userId
        in: query
        required: false
        schema:
          type: integer
      - name: ip
        in: query
        required: false
        schema:
          type: string
      - name: userAgent
        in: query
        required: false
        schema:
          type: string
      - name: method
        in: query
        required: false
        schema:
          type: string
      - name: path
        in: query
        required: false
        schema:
          type: string
      - name: header
        in: query
        required: false
        schema:
          type: string
      - name: body
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backend_LogCollection'
        4XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
        5XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
      security:
      - app:
        - backend.log
      summary: Backend log get all
      x-summary-source: derived
    servers:
    - url: https://demo.fusio-project.org
  /backend/log/error:
    get:
      tags:
      - Log
      description: Returns a paginated list of log errors
      operationId: backend.log.getAllErrors
      parameters:
      - name: startIndex
        in: query
        required: false
        schema:
          type: integer
      - name: count
        in: query
        required: false
        schema:
          type: integer
      - name: search
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backend_LogErrorCollection'
        4XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
        5XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
      security:
      - app:
        - backend.log
      summary: Backend log get all errors
      x-summary-source: derived
    servers:
    - url: https://demo.fusio-project.org
  /backend/log/error/{error_id}:
    parameters:
    - name: error_id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Log
      description: Returns a specific error
      operationId: backend.log.getError
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backend_LogError'
        4XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
        5XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
      security:
      - app:
        - backend.log
      summary: Backend log get error
      x-summary-source: derived
    servers:
    - url: https://demo.fusio-project.org
  /consumer/log/{log_id}:
    parameters:
    - name: log_id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Log
      description: Returns a specific log for the authenticated user
      operationId: consumer.log.get
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consumer_Log'
        4XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
        5XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
      security:
      - app:
        - consumer.log
      summary: Consumer log get
      x-summary-source: derived
    servers:
    - url: https://demo.fusio-project.org
  /consumer/log:
    get:
      tags:
      - Log
      description: Returns a paginated list of logs which are assigned to the authenticated user
      operationId: consumer.log.getAll
      parameters:
      - name: startIndex
        in: query
        required: false
        schema:
          type: integer
      - name: count
        in: query
        required: false
        schema:
          type: integer
      - name: search
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consumer_LogCollection'
        4XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
        5XX:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_Message'
      security:
      - app:
        - consumer.log
      summary: Consumer log get all
      x-summary-source: derived
    servers:
    - url: https://demo.fusio-project.org
components:
  schemas:
    Backend_LogError:
      type: object
      properties:
        id:
          description: Unique identifier for the object
          type: integer
        logId:
          type: integer
        message:
          type: string
        trace:
          type: string
        file:
          type: string
        line:
          type: integer
        insertDate:
          type: string
          format: date-time
    Backend_LogErrorCollection:
      description: Base collection
      type: object
      properties:
        totalResults:
          type: integer
        startIndex:
          type: integer
        itemsPerPage:
          type: integer
        entry:
          type: array
          items:
            $ref: '#/components/schemas/Backend_LogError'
    Backend_Log:
      description: This object represents a log entry. Every HTTP requests to the system generates such a log entry.
      type: object
      properties:
        id:
          description: Unique identifier for the object
          type: integer
        ip:
          description: The remote IP which has initiated the request
          type: string
        userAgent:
          description: The user agent provided by the HTTP user agent header
          type: string
        method:
          description: The HTTP method i.e. GET or POST
          type: string
        path:
          description: The target path
          type: string
        header:
          description: The provided HTTP headers
          type: string
        body:
          description: The provided HTTP body
          type: string
        date:
          description: Insert date of this request
          type: string
          format: date-time
        errors:
          description: An array of errors which occurred through this request
          type: array
          items:
            $ref: '#/components/schemas/Backend_LogError'
    Common_Message:
      description: Common error message
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        id:
          type: string
    Backend_LogCollection:
      description: Base collection
      type: object
      properties:
        totalResults:
          type: integer
        startIndex:
          type: integer
        itemsPerPage:
          type: integer
        entry:
          type: array
          items:
            $ref: '#/components/schemas/Backend_Log'
    Consumer_LogCollection:
      description: Base collection
      type: object
      properties:
        totalResults:
          type: integer
        startIndex:
          type: integer
        itemsPerPage:
          type: integer
        entry:
          type: array
          items:
            $ref: '#/components/schemas/Consumer_Log'
    Consumer_Log:
      type: object
      properties:
        id:
          type: integer
        appId:
          type: integer
        ip:
          type: string
        userAgent:
          type: string
        method:
          type: string
        path:
          type: string
        header:
          type: string
        body:
          type: string
        date:
          type: string
          format: date-time
  securitySchemes:
    app:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://demo.fusio-project.org/authorization/token
          refreshUrl: https://demo.fusio-project.org/authorization/token
          scopes:
            backend: ''
            backend.account: ''
            backend.action: ''
            backend.agent: ''
            backend.app: ''
            backend.audit: ''
            backend.backup: ''
            backend.bundle: ''
            backend.category: ''
            backend.config: ''
            backend.connection: ''
            backend.cronjob: ''
            backend.dashboard: ''
            backend.event: ''
            backend.firewall: ''
            backend.form: ''
            backend.generator: ''
            backend.identity: ''
            backend.log: ''
            backend.marketplace: ''
            backend.operation: ''
            backend.page: ''
            backend.plan: ''
            backend.rate: ''
            backend.role: ''
            backend.schema: ''
            backend.scope: ''
            backend.sdk: ''
            backend.specification: ''
            backend.statistic: ''
            backend.taxonomy: ''
            backend.tenant: ''
            backend.test: ''
            backend.token: ''
            backend.transaction: ''
            backend.trash: ''
            backend.trigger: ''
            backend.user: ''
            backend.webhook: ''
        authorizationCode:
          authorizationUrl: https://demo.fusio-project.org/authorization/authorize
          tokenUrl: https://demo.fusio-project.org/authorization/token
          refreshUrl: https://demo.fusio-project.org/authorization/token
          scopes:
            backend: ''
            backend.account: ''
            backend.action: ''
            backend.agent: ''
            backend.app: ''
            backend.audit: ''
            backend.backup: ''
            backend.bundle: ''
            backend.category: ''
            backend.config: ''
            backend.connection: ''
            backend.cronjob: ''
            backend.dashboard: ''
            backend.event: ''
            backend.firewall: ''
            backend.form: ''
            backend.generator: ''
            backend.identity: ''
            backend.log: ''
            backend.marketplace: ''
            backend.operation: ''
            backend.page: ''
            backend.plan: ''
            backend.rate: ''
            backend.role: ''
            backend.schema: ''
            backend.scope: ''
            backend.sdk: ''
            backend.specification: ''
            backend.statistic: ''
            backend.taxonomy: ''
            backend.tenant: ''
            backend.test: ''
            backend.token: ''
            backend.transaction: ''
            backend.trash: ''
            backend.trigger: ''
            backend.user: ''
            backend.webhook: ''
x-refined-from:
- fusio-backend.json
- fusio-consumer.json