api.yaml

openapi: 3.0.0
info:
  title: Event Gate
  version: 0.0.0
  description: This API provides topic management for an event bus.

servers:
  - url: https://{id}-vpce-{vpce}.execute-api.{region}.amazonaws.com/DEV
    variables:
      id:
        default: 01234567ab
        description: API Gateway ID
      vpce:
        default: '01234567abcdef012'
        description: VPC endpoint
      region:
        default: 'af-south-1'
        description: AWS Region

paths:
  /api:
    get:
      summary: Open API specification
      description: Open API specification
      responses:
        '200':
          description: Open API specification
          content:
            application/vnd.oai.openapi:
              schema:
                type: string

  /token:
    get:
      summary: Login to the service
      description: Allows a user to obtain credentials (JWT token) from LoginService for the service
      responses:
        '303':
          description: Redirect to actual address of Login service which performs auth up to its capabilities

  /health:
    get:
      summary: Service health check
      description: Service health and dependency status check
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  uptime_seconds:
                    type: integer
                    example: 12345
        '503':
          description: Service is degraded
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: degraded
                  failures:
                    type: object
                    additionalProperties:
                      type: string
                    example:
                      eventbridge: client not initialized
                      kafka: producer not initialized
                      postgres: host not configured

  /topics:
    get:
      summary: Get a list of topics
      description: Returns a list of all available topics.
      responses:
        '200':
          description: A list of topics
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string

  /topics/{topic_name}:
    get:
      summary: Get schema for a specific topic
      description: Returns the schema for a specified topic using [JSON Schema](https://json-schema.org/).
      parameters:
        - name: topic_name
          in: path
          required: true
          schema:
            type: string
          description: Name of the topic
      responses:
        '200':
          description: Key-value pairs representing the schema for the topic
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '404':
          description: Topic not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string

    post:
      summary: Publish an event to a topic
      description: Publishes an event to the event bus under the specified topic. User must be authenticated with a JWT token.
      security:
        - bearerAuth: []
      parameters:
        - name: topic_name
          in: path
          required: true
          schema:
            type: string
          description: Name of the topic
      requestBody:
        description: Event data to be published
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Event successfully published
        '400':
          description: Invalid event data
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '404':
          description: Topic not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    
  /stats/{topic_name}:
    post:
      summary: Query run/job statistics
      description: >
        Returns a paginated list of run/job records from PostgreSQL for the
        specified topic.  Currently only `public.cps.za.runs` is supported.
        Results are sorted by `internal_id DESC` with keyset cursor pagination. 
        When `timestamp_start` and `timestamp_end` are omitted the default time
        window is the last `7 days`.
      security: []
      parameters:
        - name: topic_name
          in: path
          required: true
          schema:
            type: string
          description: Name of the topic to query statistics for
      requestBody:
        description: Query parameters including time window, pagination cursor, and limit
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                timestamp_start:
                  type: integer
                  nullable: true
                  description: Start of time window in epoch milliseconds (default now - 7 days)
                  example: 1704067200000
                timestamp_end:
                  type: integer
                  nullable: true
                  description: End of time window in epoch milliseconds (default now)
                  example: 1706745600000
                cursor:
                  type: integer
                  nullable: true
                  description: Last internal_id from previous page (keyset pagination)
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 50
                  description: Maximum number of records per page
      responses:
        '200':
          description: Paginated list of run/job records with computed fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  statusCode:
                    type: integer
                    example: 200
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        event_id:
                          type: string
                        job_ref:
                          type: string
                        tenant_id:
                          type: string
                        source_app:
                          type: string
                        internal_id:
                          type: integer
                        catalog_id:
                          type: string
                        status:
                          type: string
                        run_date:
                          type: string
                          description: Date of run-level timestamp_start (DD-MM-YYYY)
                        run_status:
                          type: string
                          description: Computed status (succeeded, failed, no data received, no data produced)
                        formatted_tenant:
                          type: string
                          description: Lowercase tenant_id
                        elapsed_time:
                          type: integer
                          nullable: true
                          description: Difference in milliseconds between job end and start
                        start_time:
                          type: string
                          description: Formatted job start (YYYY-MM-DD HH:MM:SS UTC)
                        end_time:
                          type: string
                          description: Formatted job end (YYYY-MM-DD HH:MM:SS UTC)
                      additionalProperties: true
                  pagination:
                    type: object
                    properties:
                      cursor:
                        type: integer
                        nullable: true
                      has_more:
                        type: boolean
                      limit:
                        type: integer
        '400':
          description: Invalid parameters or unsupported topic
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User not authorized for topic
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Topic not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Database query error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /terminate:
    post:
      summary: Terminates lambda environment
      description: Facilitates fresh start of lambda environment on next invocation (i.e. loads fresh public keys and configs)
      responses:
        '502':
          description: Internal server error or bad gateway error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string

components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: integer
        errors:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              message:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT