Would it be possible to split API docs to a separate page per module?

[snowch]

• Nipyapi version: N/A
• NiFi version: N/A
• NiFi-Registry version: N/A
• Python version: N/A
• Operating System: N/A

Description

Would it be possible to split API docs to a separate page per module? This would make the docs much easier to navigate.

Currently, it takes a lot of scrolling and searching to navigate to the documentation I need.

[Chaffelson]

Hi Chris - where are you reading them at the moment, on https://nipyapi.readthedocs.io/en/latest/ ?

So I can better understand the ask, can you give me a quick run through of the steps of your current process and where it is painful?

[snowch]

Here is one workflow I recently did:

• using browser network call inspector, perform UI action and watch the rest api call (e.g. upload process group)
• find the REST API docs (e.g. /process-groups/{id}/process-groups/upload)
• search NiPyAPI docs for "process group upload"
• click first link taking me to the swagger docs
• I now have to scroll to find which module (ProcessGroupsApi) the call sits in to determine how to call the method

If each module of the NiFi Swagger Client had it's own page, it would be so much easier to navigate.

Hope that makes sense?

[snowch]

Thanks for fixing this @Chaffelson!