openapi: 3.1.0
info:
  title: Credentially Public Compliance-packages Meta API
  description: Public API Proxy with Rate Limiting and Audit
  version: 2.0.0
servers:
- url: https://app.credentially.io/gateway
  description: Generated server url
tags:
- name: Meta
  description: API for fetching metadata
paths:
  /meta/events:
    get:
      tags:
      - Meta
      summary: Get list of available webhook event types with details
      operationId: getAvailableEventTypes
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventTypeInfo'
      security:
      - bearer-key: []
components:
  schemas:
    PayloadFieldInfo:
      type: object
      properties:
        key:
          type: string
        description:
          type: string
        dataType:
          type: string
          enum:
          - STRING
          - NUMBER
          - BOOLEAN
          - OBJECT
          - ARRAY
          - UUID
          - DATE_TIME
          - DATE
        exampleValue: {}
    EventTypeInfo:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
        payloadFields:
          type: array
          items:
            $ref: '#/components/schemas/PayloadFieldInfo'
  securitySchemes:
    bearer-key:
      type: http
      scheme: bearer
      bearerFormat: JWT