gravitee-docs icon indicating copy to clipboard operation
gravitee-docs copied to clipboard

[swagger] Enums documented in swagger definition are incorrect.

Open danlange opened this issue 6 years ago • 1 comments

In a number of places in the swagger doc (https://docs.gravitee.io/apim/api/1.18/swagger.json or https://raw.githubusercontent.com/gravitee-io/gravitee-docs/master/apim/api/1.18/swagger.json) enumerations are documented as all caps, while using the API produces the same enumerations in all lower case. For example, ApiEntity.visibility is documented as "PUBLIC" or "PRIVATE", but the values retrieved from the API are "public" or "private".

This renders the swagger documentation unusable for code generation.

I am gradually working through the enums where this occurs. So far, I have found: ApiEntity.visibility ApiEntity.state PlanEntity.validation PlanEntity.security PlanEntity.type

danlange avatar Sep 10 '18 17:09 danlange

Yes, you're right.

We are looking to move all the enums as upper-case string for Gravitee 1.20.x

brasseld avatar Sep 11 '18 21:09 brasseld