mirror of
https://github.com/hoppscotch/hoppscotch.git
synced 2026-04-26 01:06:00 +03:00
[GH-ISSUE #885] [feature]: request parameter description & documentation generation #310
Labels
No labels
CodeDay
a11y
browser limited
bug
bug fix
cli
core
critical
design
desktop
discussion
docker
documentation
duplicate
enterprise
feature
feature
fosshack
future
good first issue
hacktoberfest
help wanted
i18n
invalid
major
minor
need information
need testing
not applicable to hoppscotch
not reproducible
pull-request
question
refactor
resolved
sandbox
self-host
spam
stale
testmu
wip
wont fix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/hoppscotch#310
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @piliplaker on GitHub (May 20, 2020).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/885
Sometimes we use postman not only for api testing , but also for documentation generation.
I know there has been a doc generator already, but it is just basicly functional, which is not enough for our daily use. We need the description per parameter and a relatively isolated page to show the doc to the guys we work with.
Also can you improve the experience of the process when tring to generate documentation by given collection from the request page? Now I have to copy the whole content of the collection in json form, click the "generate documentation" button, paste the content to the box, and then finally click the generate button.
@liyasthomas commented on GitHub (May 20, 2020):
Thanks for raising concerns on current Documentation generator. Current implementation is very basic and needs major improvements. Will work on it as we move forward.
@joeetten-progenity commented on GitHub (May 28, 2020):
I agree, the documentation needs some help but it is at least semi-useful.
I'd also add that I'd expect that when I click on an object/collection in my collections tab and hit the "Generate Documentation" button, it would show me the documentation for that object/collection.
Currently, it does not appear to do this. It just takes you to a "blank" page where you can import or paste a collection.
I can add this as a separate issue if you need.
@liyasthomas commented on GitHub (May 28, 2020):
@joeetten-progenity separate issue isn't needed - overall improvements are required which covers the mentioned use case
@perseveringman commented on GitHub (Jul 15, 2020):
Is anyone following up on this issue? I really want to participate in optimizing this part.😊😊😊
@liyasthomas commented on GitHub (Jul 15, 2020):
We're working on #955 which will introduce lot of new improvements in the core structuring. Even though this doesn't effect the Documentation part, we went quite busy with it. If you're interested to help us, do let me know. I can help.
@liyasthomas commented on GitHub (Sep 8, 2020):
@perseveringman shall we optimize doc generator. We could really use your help.
@perseveringman commented on GitHub (Sep 9, 2020):
Willing to help！
@liyasthomas commented on GitHub (Sep 9, 2020):
What features/improvements you'd like to see in current doc generator?
@perseveringman commented on GitHub (Sep 9, 2020):
Shall we continue the previous progress？Add the params description and optimize the layout of the document page.
@perseveringman commented on GitHub (Sep 9, 2020):
If you have other ideas, I am willing to help
@liyasthomas commented on GitHub (Sep 9, 2020):
Can start on adding param description and optimising layout as a first and will iterate then.
@perseveringman commented on GitHub (Sep 9, 2020):
Okay, I will resubmit a PR.
@liyasthomas commented on GitHub (Aug 5, 2023):
Possibly a duplicate of #2018, hence closing.