Skip to content

[Documentation Errors Bug] Duplicate OpenAPI Schema Definitions #14

Open
@cbnsndwch

Description

@cbnsndwch

👤 User Story

As a developer relying on API description files in this repo to automatically generate SDKs and integration code, I would like there to not be duplicate schema definitions across the files, but instead that shared definitions would be extracted to a shared spec file, so that I can unify cross-cutting concerns such as logging and error handling in my client code without needing to manually rewrite import paths, or maintain multiple DTO files for the same data contract

🐛 Describe the Bug

Many API description files include duplicate schemas that are repeated instead of referenced from a shared document, which

📍 API Endpoint

Many, see attached log

✅ Expected Behavior

Definitions used across several API spec files but that describe the exact same object schema should be extracted to a shared definitions file and $ref-erenced, instead of being inlined

💻 Screenshots or Code Samples

See logs for listing of duplicate schemas

🧠 Additional Context

A stretch goal would be that this repo would include TypeScript interfaces/types for Request/Response DTOs

duplicate-schemas.log

Metadata

Metadata

Assignees

No one assigned

    Labels

    bug-documentation-errorsImprovements or additions to documentation of the Highlevel API

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions