v0.19.0

Changes

Integrations

Temporal

• [Feature] Introduce REST-related utilities so a front-end client can now parse Temporal metadata that could be returned by a REST API. See example below how an OpenAPI description can now add Temporal metadata object to a HTTP response returned by the REST router.

Descriptions

OpenAPI

• [Enhancement] Improve OpenAPI file structure. Each object can be used as a $ref in an OpenAPI, either as a "schema" object or as a whole response. Example:

  post:
    operationId: custom
    tags:
      - System
    summary: Custom operation
    description: |
      This is a custom operation.
    responses:
      '202':
        description: Accepted
        content:
          application/json:
            schema:
              allOf:
                - $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/schemas/rest/200.yaml
                - type: object
                  properties:
                    metadata:
                      type: object
                      properties:
                        temporal:
                          $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/schemas/temporal/Metadata.yaml
                      required:
                        - temporal
                  required:
                    - metadata
      '400':
        $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/responses/400.yaml
      '401':
        $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/responses/401.yaml
      '429':
        $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/responses/429.yaml
      '500':
        $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/responses/500.yaml
      '503':
        $ref: https://raw.githubusercontent.com/nunchistudio/helix/refs/heads/main/descriptions/openapi/components/responses/503.yaml