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

BodyParams type arrays or objects #19

Closed
js-moreno opened this issue Jan 22, 2021 · 2 comments
Closed

BodyParams type arrays or objects #19

js-moreno opened this issue Jan 22, 2021 · 2 comments

Comments

@js-moreno
Copy link
Contributor

js-moreno commented Jan 22, 2021

Hi,

I'd like to use arrays or objects as @BodyParam but it not identify dot notation.

I mean something like:

 * @bodyParam  my_object object required.
 * Some object
 * 
 * @bodyParam  my_object.item string required 
 * Item in the object.

And

 * @bodyParam  my_array array 
 * Some array.
 * 
 * @bodyParam  my_array.* integer 
 *  Items in the array.

Even

 * @bodyParam  my_set array 
 * Some set
 * 
 * @bodyParam  my_set.*.item string
 * Object element within set
@badjuice
Copy link

I also need to document fields that come in arrays of objects but am not currently able to do that. This would be a huge addition!

@ovac ovac closed this as completed Jun 10, 2023
@deevus
Copy link

deevus commented Aug 1, 2023

Closed as completed?

Arrays currently don't work properly. An array in @bodyParam shows the payload as a string containing "[]".

image

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

4 participants