Apidoc: Request body with array

[Znarkus]

Hi!

How would I document this?

POST /batch-insert
[
  { "name": "Name 1" },
  { "name": "Name 2" }
]

I understand that @apiParam can be used to document request body, but @apiParam {String[]} name implied { "name": ["Name 1", "Name 2"] } I think.

[dfreire]

I feel your pain.
While a solution is not implemented I use an underscore:
* @apiParam {Object[]} _ array of objects with:

It keeps the api legible enough...

[renatoargh]

hey @dfreire what does the _ do?

[dfreire]

Nothing. It is just a placeholder that is easy to read on the documentation output.

[koko-ng]

Hi,
If you use something like

 * @apiParam {Object[]} [names] A serie of names
 * @apiParam {Object} [names.name] A name

It outputs a quite clear and indented doc, however it's not sending it correctly with apiSampleUrl.

[machineghost]

@kok-ng What you are describing is a different API. The documentation you defined would describe a request of:

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

But what (I believe) @Znarkus was asking for, and what I'm looking for also, is how to document an API that expects:

 [{ "name": "Name 1" }, { "name": "Name 2" }]

P.S. This is particularly relevant if you're using the APIDoc feature where you have it generate forms for each endpoint. Currently it is impossible to get APIDoc to generate a form for an endpoint unless that endpoint takes named parameters (ie. takes an object, not an array).

[fedemengo]

Any update on this one?

[NicolasCARPi]

@fedemengo No, but you're welcome to contribute! ;)

Recently a lot of work has been put in reducing the number of open PR/issues. This issue will be addressed eventually. Right now issues that are not bugs have a lower priority.