Referring to onap-discuss list topic: https://lists.onap.org/g/onap-discuss/topic/30889857

The documentation of the query parameters should be improved to reduce confusion so that either:

• it appears separately from the custom query, nodes query, REST API sections, or
• it appears with all of the custom query, nodes query, REST API sections

Appearing separately allows the documentation to show a matrix of where it is applicable, while also being easy to link and reference to answer questions.

Appearing with all relevant sections allows a full understanding without needing to jump around different sections.

Both methods can be customised to show specific areas where the parameters are/aren't applicable.

However, if all the query parameters are always generally applicable everywhere, then perhaps that needs to be called out explicitly too.

Right now, the placement of the explanations makes it seem like it is only applicable within certain URL paths and not others.

The swagger template could include a section for the generated REST API document.