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

Need of @apiBodyExample #1370

Open
Saatwik-Mehta opened this issue May 11, 2023 · 4 comments
Open

Need of @apiBodyExample #1370

Saatwik-Mehta opened this issue May 11, 2023 · 4 comments

Comments

@Saatwik-Mehta
Copy link

Saatwik-Mehta commented May 11, 2023

Feature request

Instead of giving the allowed values in the @apiBody parameter, it will be good to have apiBodyExample as a separate parameter, so that it is easy to show multiple body example in the docs.

@apiBodyExample {json} Request-Example with example1:
    {
      `param1`: `some value`,
      `param2`: null
    }
@apiBodyExample {json} Request-Example with example2:
    {
      `param1`: null,
      `param2`: `some value`
    }
@Saatwik-Mehta
Copy link
Author

Any updates on this?

@NicolasCARPi
Copy link
Collaborator

NicolasCARPi commented May 17, 2023

Any updates on this?

No.

@Saatwik-Mehta
Copy link
Author

Okay

@IVoyt
Copy link

IVoyt commented Oct 6, 2023

Feature request

Instead of giving the allowed values in the @apiBody parameter, it will be good to have apiBodyExample as a separate parameter, so that it is easy to show multiple body example in the docs.

@apiBodyExample {json} Request-Example with example1:
    {
      `param1`: `some value`,
      `param2`: null
    }
@apiBodyExample {json} Request-Example with example2:
    {
      `param1`: null,
      `param2`: `some value`
    }

maybe @apiParamExample is what you looking for?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants