insodoc / insomnia-documenter

Tool to create minimalist and beautiful API documentation pages using your Insomnia workspace export file.
MIT License
492 stars 59 forks source link

Add description for a FOLDER. Is that possible? #29

Open gusilveiramp opened 4 years ago

gusilveiramp commented 4 years ago

Through the "Docs" tab we can document the methods, but it would be really cool if we could put a description in a folder that contains several methods.

For example, if my workspace is divided in 3 folders:

When I click on Admin option, from left menu, is there any way to add a description like image shows?

Captura de Tela 2020-09-04 às 19 37 43
jozsefsallai commented 3 years ago

Theoretically, the Insomnia export file does contain a description field for folders too but there's no way (that I know of) to make changes to it. The documenter does have support for folder descriptions but until there's a way to edit the descriptions from within Insomnia, the only way you can achieve this is by editing the file directly.

To be fair, folders don't have their own view in Insomnia, so specifying descriptions for them would be useless for Insomnia anyway because there's no way to view them.

Perhaps @develohpanda could enlighten us more about this?

develohpanda commented 3 years ago

Looks like the editing descriptions was never added in even though the model was updated (as part of https://github.com/Kong/insomnia/pull/252 and subsequent PRs).

The context menus for folders and requests are very different, and the method of renaming is also different. Folder -> context menu -> rename -> modal, Request -> double click.

Descriptions for a Request are currently in the request settings modal. Given the interaction patterns for Request and Folders are already different, perhaps a plain-text (instead of markdown) description field can also be added to the folder rename modal?

image

Feel free to create a feature request in Insomnia, our designer can have a look and provide some feedback on it too, but I don't see any reason to not add it in. If not in the app itself, we can probably add API for a custom plugin 😄

develohpanda commented 3 years ago

I just noticed that a workspace has a workspace settings view, containing name and description. Request also has a request settings view, with name and description. Something similar can be done for the folder rename view, updating it to "folder settings" with a name and description.