Implement apiBody and apiQuery tags

[ghost]

This is for issue #24 which suggested an apiBody and apiQuery be created instead of using (the general tag) apiParam.

[NicolasCARPi]

Hello,

Thank you for your contribution. It would be great if you could add some tests.

Also, the documentation needs to be modified to reflect the changes and the new available params.

Finally, it looks like you basically took the code from api_param and copy/pasted it to create the two new types. Isn't it possible to reduce this duplication in one way or another?

[ghost]

@NicolasCARPi where is the documentation? I was not able to find it in the project, though I may have been looking in the wrong place for it.

[NicolasCARPi]

Here you go: https://github.com/apidoc/apidocjs.com

[ghost]

@NicolasCARPi I am working on updating the documentation. When I make a PR, do you want me to reference this PR (with a URL or something to that extent)?

[ghost]

@NicolasCARPi I have finished making the changes you requested, with the exception of the documentation on the other project.

[NicolasCARPi]

@SWheeler17 This is already much better. I'll merge this after you propose a documentation change. It's important to keep the documentation in sync with the code, and because you are adding functionality, it is also your responsability to modify the documentation to indicate the usage of such params and in which case they are useful.

[ghost]

Ok, @NicolasCARPi how do you want me to link this PR to the PR on the documentation PR? I was going to add the link of this PR to that (eventual) PR unless you want me to do something else.

[NicolasCARPi]

Whatever works for you!

[NicolasCARPi]

Please ping me if this has not been reviewed in a week.

[ghost]

@NicolasCARPi this has not been merged and does not appear to have been reviewed either.

[tommy87]

Here is a good example https://github.com/apidoc/apidoc-core/blob/master/lib/workers/api_success_title.js

[ghost]

@tommy87 I updated the two files you commented on, addressing your comments. Please review it again.

[tommy87]

Looks much better, but i still need to run tests.

@rottmann @NicolasCARPi
is there any chance to enable CI / Actions in this project which run the tests automatically?

[NicolasCARPi]

@tommy87 Yes sure! Github actions or CircleCI.

[tommy87]

@NicolasCARPi ah i thought it must be enabled first, but when it is similar to gitlab i could create a simple test in the next days

[NicolasCARPi]

I would favor github actions as they do not require a third party account/access.

There used to be Travis CI IIRC on this repo. But maybe @rottmann pulled the plug.

[tommy87]

@SWheeler17 i have create some CI actions on the dev branch. Could you rebase your branch so that the tests are triggered

@NicolasCARPi shouldnt the dokumentation be updated before pulling?

[ghost]

@tommy87 I have rebased and the tests seem to have run successfully. The documentation PR is here: apidoc/apidocjs.com#34 (for future reference).

[tommy87]

Just correct the name and then everythign should be fine

[ghost]

Oops, fixed @tommy87, my bad.

[tommy87]

@NicolasCARPi i think it is ready for pulling

[ghost]

What is the likelihood of this PR being pulled within the next few days?

[NicolasCARPi]

What is the likelihood of this PR being pulled within the next few days?

100% :p