Skip to content

Add better OpenAPI descriptions to resources/components.schemas #15002

@johncowen

Description

@johncowen

Description

I've noticed that the descriptions for our resources/schemas in our OAS look as though they are using a generic/default message.

https://github.com/kumahq/kuma-gui/blob/276872e535539de296f70a0f8fe93096f6b4a9aa/packages/kuma-http-api/dist/components/schemas/MeshAccessLogItem.yaml#L1

It would be good to fill these out with a short single sentence description of what the policy does.

We could then surface that in various places in the GUI.

This would also be useful in the Terraform provider and docs I believe


edit: We could also potentially use externalDocs for adding links to our doc site and have the GUI use those?

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/improvementImprovement on an existing featuretriage/acceptedThe issue was reviewed and is complete enough to start working on it

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions