Replies: 1 comment 1 reply
-
The
etc. is an indirection swagger needs/uses to connect the comment about an API to the actual reponse and/or parameters. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
While updating the API documentation that generates the swagger file I've seen that the models used to generate the doc are not the one that we are using as response in our APIs.
The main point of using annotations on the struct is to keep the documentation close to the code, so it can be easily maintained, and updated. Having the two splitted and unrelated adds more complexity to everything.
Do we want to refactor/fix this?
As an example I've looked ad the ServiceAppsResponse.
The response returned is this one
but the one that generates the doc is this one
There is no reference on the
apps_of
key, so its not reliable nor updated.Beta Was this translation helpful? Give feedback.
All reactions