Skip to content

x-enum-descriptions support #394

@Skyppid

Description

@Skyppid

We currently face the problem that our backend enums are not properly exported to our generated typescript client. It would be very beneficial for our frontend developers to have the documentation from the backend in the models to understand what the values mean.

Unfortunately descriptions are only supported by vendor extension (x-enum-descriptions) and thus only work if ng-open-api implements support for that as well. So currently there's no way to expose the per-value documentation to our frontend.

For reference, ReDocly has a good overview of it: https://redocly.com/docs-legacy/api-reference-docs/specification-extensions/x-enum-descriptions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions