Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] param annotation with brackets #193

Open
g-portugues opened this issue Oct 5, 2021 · 1 comment
Open

[BUG] param annotation with brackets #193

g-portugues opened this issue Oct 5, 2021 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@g-portugues
Copy link

Hello,

In my application I use query params with brackets in the name. When documenting these parameters with the @param annotation it is not considered when generating the documentation (http://localhost:8000/examples?filter[limit]=10&filter[offset]=1).

/**
 * GET /examples
 * @summary This is the summary of the endpoint
 * @description This is the description of the endpoint
 * @tags Examples
 * @param {integer} filter[limit].query - limit description here
 * @param {integer} filter[offset].query - offset description here
 * @return {array<Example>} 200 - Examples list
 */

Perhaps a way to solve the problem is to implement the RecordType of @types/doctrine so that it accepts the following structure:

/**

  • GET /examples
  • @summary This is the summary of the endpoint
  • @description This is the description of the endpoint
  • @tags Examples
  • @param {{filter:integer}} limit.query - limit description here
  • @param {{filter:integer}} offset.query - offset description here
  • @return {array} 200 - Examples list
    */
@kevinccbsg kevinccbsg added the bug Something isn't working label Oct 26, 2021
@kevinccbsg kevinccbsg added the good first issue Good for newcomers label Jul 27, 2022
@kevinccbsg
Copy link
Member

Hi @g-portugues could you solve it with the definition you shared?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants