Skip to content

story: evaluate OpenAPI export for records and value objects #22

@soulcodingmatt

Description

@soulcodingmatt

Story

As a project maintainer, I want to evaluate whether OpenAPI schema export makes sense for Records and Value Objects (as defined in Equilibrium), so that I can make an informed decision about extending the export feature beyond DTOs.

Context

Parent epic: #18

DTOs are the primary use case for OpenAPI export. Records and Value Objects have different semantics — Records are immutable data carriers, VOs represent domain concepts with equality by value. Whether exporting these to OpenAPI schemas is useful depends on how they're used in API boundaries.

Acceptance Criteria

  • A technical evaluation document is produced covering: use cases for Record/VO export, semantic differences from DTO export, and implementation complexity
  • The document includes a recommendation (export both, export Records only, or DTOs only)
  • If export is recommended, the approach is documented (reuse DTO export logic vs separate generator)

Acceptance Criteria

TODO: Define acceptance criteria for this story.

Acceptance Criteria

TODO: Define acceptance criteria for this story.

Metadata

Metadata

Assignees

No one assigned

    Labels

    backendArea: backendstoryHierarchy: story

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions