api.yaml

openapi: 3.0.0
info:
  title: EventGate API
  version: 1.0.0
  description: This API provides topic management for an event bus.

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

  /docs:
    get:
      summary: Swagger UI documentation page
      description: Renders interactive Swagger UI for the OpenAPI spec.
      security: []
      responses:
        '200':
          description: Swagger UI HTML page
          content:
            text/html:
              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
                  dependencies:
                    type: object
                    additionalProperties:
                      type: string
                    example:
                      kafka: ok
                      eventbridge: not configured
                      postgres: ok
        '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
                  dependencies:
                    type: object
                    additionalProperties:
                      type: string
                    example:
                      kafka: ok
                      eventbridge: client 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'

  /stats/{topic_name}/query/{query_name}:
    post:
      summary: Execute a predefined named query
      description: >
        Runs a curated, server-side named query by name. `runs_jobs_detail` returns paginated
        results. `runs_jobs_detail_aggregation` returns window totals and a bucketed timeline.
      security: []
      parameters:
        - name: topic_name
          in: path
          required: true
          schema:
            type: string
          description: Name of the topic to query
        - name: query_name
          in: path
          required: true
          schema:
            type: string
            enum: [runs_jobs_detail, runs_jobs_detail_aggregation]
          description: Identifier of the named query to run
      requestBody:
        description: >
          Query parameters. Shape depends on `query_name`: pagination fields for
          `runs_jobs_detail`, time window only for `runs_jobs_detail_aggregation`.
        required: false
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/RunsJobsDetailQueryBody'
                - $ref: '#/components/schemas/RunsJobsDetailAggregationQueryBody'
      responses:
        '200':
          description: >
            Named-query result. `runs_jobs_detail` returns a paginated result set;
            `runs_jobs_detail_aggregation` returns window-wide aggregations instead.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/RunsJobsDetailResponse'
                  - $ref: '#/components/schemas/RunsJobsDetailAggregationResponse'
        '400':
          description: Invalid parameters, unsupported topic, or unknown query_name
          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:
    RunsJobsDetailQueryBody:
      type: object
      description: >
        Request body for the paginated `runs_jobs_detail` named query.
        source_app and tenant_id are optional exact, case-sensitive filters combined with AND.
        Omitted or null filters mean all values. Filters do not enforce authorization.
      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
        source_app:
          type: string
          nullable: true
          description: Source application filter. Omitted or null means all applications
        tenant_id:
          type: string
          nullable: true
          description: Tenant identifier filter. Omitted or null means all tenants
    RunsJobsDetailAggregationQueryBody:
      type: object
      description: >
        Request body for the window-wide `runs_jobs_detail_aggregation` named query.
        `cursor`/`limit` are not accepted here (400 if present) since this query is not paginated.
        source_app and tenant_id are optional exact, case-sensitive filters combined with AND.
        Omitted or null filters mean all values. Filters do not enforce authorization.
      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
        source_app:
          type: string
          nullable: true
          description: Source application filter. Omitted or null means all applications
        tenant_id:
          type: string
          nullable: true
          description: Tenant identifier filter. Omitted or null means all tenants
    RunsJobsDetailResponse:
      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
              internal_id:
                type: integer
              catalog_id:
                type: string
              status:
                type: string
              run_date:
                type: string
                description: Date of the job-level timestamp_start (DD-MM-YYYY, UTC)
              run_status:
                type: string
                description: >
                  Computed status bucket. Message reclassification is applied to
                  every row (no data received, no data produced, timeout), else the
                  raw status is preserved (succeeded, failed, killed, skipped).
              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
    RunsJobsDetailAggregationResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        statusCode:
          type: integer
          example: 200
        aggregations:
          type: object
          description: >
            Window-wide totals, success rate, and a bucketed timeline for `runs_jobs_detail`(grain
            job rows). Always fully populated (zeroed counts, empty timeline entries).
          properties:
            window:
              type: object
              properties:
                timestamp_start:
                  type: integer
                  example: 1704067200000
                timestamp_end:
                  type: integer
                  example: 1706745600000
            total_runs:
              type: integer
              description: Count of job rows in the window (same grain as runs_jobs_detail)
              example: 1840
            total_tenants:
              type: integer
              description: Number of distinct tenants in the window
              example: 12
            total_catalogs:
              type: integer
              description: Number of distinct catalogs in the window
              example: 44
            succeeded:
              type: integer
              example: 1600
            failed:
              type: integer
              example: 210
            killed:
              type: integer
              description: Count of job rows with raw status killed
              example: 20
            skipped:
              type: integer
              description: Count of job rows with raw status skipped
              example: 10
            success_rate:
              type: number
              description: succeeded / total_runs * 100, rounded to 1 decimal, 0.0 when empty
              example: 86.9
            avg_duration_ms:
              type: integer
              nullable: true
              description: Average job duration in ms over rows with both timestamps; null when none
              example: 41000
            timeline:
              type: object
              properties:
                bucket:
                  type: string
                  enum: [hour, day]
                  description: Bucket width - hour for windows <= 7 days, day otherwise; aligned to UTC hours/days
                entries:
                  type: array
                  description: Non-empty buckets only, ordered oldest-first
                  items:
                    type: object
                    properties:
                      bucket_start:
                        type: integer
                        description: Start of the bucket in epoch milliseconds
                        example: 1704067200000
                      total:
                        type: integer
                        example: 12
                      succeeded:
                        type: integer
                        example: 10
                      failed:
                        type: integer
                        example: 2
                      killed:
                        type: integer
                        description: Count of job rows with raw status killed in this bucket
                        example: 0
                      skipped:
                        type: integer
                        description: Count of job rows with raw status skipped in this bucket
                        example: 0
    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