[GH-ISSUE #3747] [feature]: Add Doc section for every API #1301

New issue

Closed

opened 2026-03-16 19:45:24 +03:00 by kerem · 2 comments

kerem commented

2026-03-16 19:45:24 +03:00

Owner

Originally created by @giosueDelgado on GitHub (Jan 12, 2024).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/3747

Is there an existing issue for this?

I have searched the existing issues

Summary

I think a new section that can be very useful is that in the hoppscotch request configured in the various tab we add a "Doc" section

Where inside it there is a description (I suggest tu use markdown format)

I see this very useful for example inside insomnia api:

Why should this be worked on?

This is usefult for many reason:

To explain to a not so technical person what the API do
To write some notes shared in the team that work on a single api
To write a mock for example before the api is available in the backend so the FE team can mock the request.

Originally created by @giosueDelgado on GitHub (Jan 12, 2024). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/3747 ### Is there an existing issue for this? - [X] I have searched the existing issues ### Summary I think a new section that can be very useful is that in the hoppscotch request configured in the various tab we add a "Doc" section Where inside it there is a description (I suggest tu use markdown format) I see this very useful for example inside insomnia api: ![image](https://github.com/hoppscotch/hoppscotch/assets/11545723/918158ab-59da-4729-aa34-e9e2173f934d) ### Why should this be worked on? This is usefult for many reason: - To explain to a not so technical person what the API do - To write some notes shared in the team that work on a single api - To write a mock for example before the api is available in the backend so the FE team can mock the request.

kerem

2026-03-16 19:45:24 +03:00

closed this issue
added the
feature
label

kerem commented

2026-03-16 19:45:40 +03:00

Author

Owner

@baek-sang commented on GitHub (Jan 13, 2024):

#3583

maybe not planned

@baek-sang commented on GitHub (Jan 13, 2024): #3583 maybe not planned

kerem commented

2026-03-16 19:45:45 +03:00

Author

Owner

@liyasthomas commented on GitHub (Jan 13, 2024):

We've planned to implement the API documentation feature this quarter. Stay tuned for updates on #2018. Since this ticket is possibly a duplicate, I'm closing the ticket.

@liyasthomas commented on GitHub (Jan 13, 2024): We've planned to implement the API documentation feature this quarter. Stay tuned for updates on #2018. Since this ticket is possibly a duplicate, I'm closing the ticket.

kerem referenced this issue

2026-03-17 00:51:09 +03:00

[PR #1301] [MERGED] adding codegen for the java-unirest #3218