Skip to content

story: integrate OpenAPI schema output with external OAS projects #23

Description

@soulcodingmatt

Story

As a backend developer working in an organization with a separate OpenAPI project, I want Equilibrium to push generated schemas to a configurable external location, so that my API contracts stay in sync without manual copying.

Context

Parent epic: #18

Many organizations maintain a separate Git repository for their OpenAPI specifications. Generated schemas need to be placed in the correct directory structure within that project. This story covers configuring the output location, directory structure, and optionally triggering a push to the OAS repo.

Acceptance Criteria

  • Given an openapi.outputDir processor option, when schemas are generated, then they are written to the specified directory
  • Given a configured directory structure pattern, when schemas are generated, then they follow the pattern (e.g., schemas/v1/ExampleDto.yaml)
  • Documentation describes how to integrate with a CI/CD pipeline that pushes schemas to an OAS repo

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