subasraj / flashpost-support

Flashpost is a lightweight Rest API Client Extension for Visual Studio Code.
MIT License
10 stars 0 forks source link

(New Request) description text field for requests would be helpful #16

Closed BananaAcid closed 8 months ago

BananaAcid commented 9 months ago

It would be great to have an additional description text field for each api request for documentation purposes.

Just for display, no logic needs to be attached to it. Otherwise, all description needs to go into the caption.

subasraj commented 8 months ago

Its already there called notes on the right hand side. Please see image below.

image

BananaAcid commented 8 months ago

@subasraj yes notes seems to to be used for larger text but would work as well - is there an option to have it show up right below the request name and the method pill for each request in the collections explorer to the left?

subasraj commented 8 months ago

@BananaAcid sorry we cannot move it to the left. It’s the request option area.

BananaAcid commented 8 months ago

@subasraj

My idea (Photoshop): flashpost_shortdescription_idea

Original image

subasraj commented 8 months ago

@BananaAcid i can do this by a menu "Add Description"

image

and show in the ALT text like below

image

BananaAcid commented 8 months ago

Good idea - adding with the options this would work, but the alt text would require hovering each item. Having it display always would be way more helpful.

subasraj commented 8 months ago

Good idea - adding with the options this would work, but the alt text would require hovering each item. Having it display always would be way more helpful.

@BananaAcid please try now. I can do only alt text for now.