Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
gusilveiramp opened this issue Sep 4, 2020 · 3 comments
Open

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

gusilveiramp opened this issue Sep 4, 2020 · 3 comments
Labels
upstream Issue depends on changes that need to be made in Insomnia

Comments

@gusilveiramp
Copy link

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:

  • Admin
  • Client
  • Auth

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
Copy link
Collaborator

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
Copy link

develohpanda commented Sep 16, 2020

Looks like the editing descriptions was never added in even though the model was updated (as part of Kong/insomnia#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
Copy link

develohpanda commented Sep 17, 2020

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.

@jozsefsallai jozsefsallai added the upstream Issue depends on changes that need to be made in Insomnia label May 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
upstream Issue depends on changes that need to be made in Insomnia
Projects
None yet
Development

No branches or pull requests

3 participants