Skip to content

[Maintenance] OpenAPI Schema Audit and Strictness #21

@realfishsam

Description

@realfishsam

Purpose / Goal

The OpenAPI generator creates our multi-language models. If the schema is loose (using too many 'any' types or missing required fields), the SDKs become harder to use and more prone to runtime errors.

Tasks

  • Audit core/src/types.ts and core/api-doc-config.json.
  • Ensure all fields that ARE always present are marked as required in the schema.
  • Fix any 'any' types that could be replaced with specific interfaces.
  • Verify that resolutionDate is consistently handled as an ISO string across the boundary.

Easy Way to Get Started

  1. Run the SDK generation script and look at the generated Python/TS models.
  2. Identify any fields that are typed as object or any that should have a specific structure.
  3. Update the corresponding interface in core/src/types.ts.

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreCore sidecar/server logicmaintenanceCode maintenance and cleanup

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions