Add Response examples to a request

[codeasashu]

Closes #1875

Description

Since 1894 has gone stale, I've decided to revamp the feature once again. My main motivations are:

1. Save common useful responses to a request
2. This is a prerequisite to support openapi export ([feature]: Export to OpenAPI format #3821)
3. Ability to edit and share responses along with request, provides more fulfilling API experiences

• Save responses of request
• Rename, delete and edit saved responses
• Import responses from postman collection
• Import responses from openapi
• Export responses

Checks

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• All the tests have passed

[thetronjohnson]

hi @codeasashu we might bring this feature only to the API Documentation side of Hoppscotch, for which we're currently developing a proof of concept (POC). Hence, we might not consider this feature for the API Testing side of Hoppscotch. Can we get back to this conversation once the POC is ready

[codeasashu]

@thetronjohnson Thank you for responding. Yes, examples (or saved responses) are essentially a part of documentation.

Curious to know if the API Docs you're working on, is compatible with openapi? We've been waiting long enough for this to land, so I am not expecting much. I just want to be able to share my hoppscotch collection and tell how 200 and 404 will look like. Waiting for 3 years to be able to document such seemingly simple thing is just out of scope for me (no offense, the tool is still great).

I've already made openapi doc converters for postman and insomnia, so this one shouldn't be hard. I feel supporting openapi would open endless possibilities, due to the large ecosystem it supports.

Not expecting this to land in mainstream anytime soon, but can't wait on promises no more.

[thetronjohnson]

@codeasashu yes it will be compatible with OpenAPI 💯

[codeasashu]

@thetronjohnson Awesome!!! Finally a great news. Do you have any ETA/Roadmaps? Is it already in any sprint goals for this year? I'll be super happy to contribute in any way. Let me know if this can be prioritised.

[baek-sang]

We hope this feature will be included in the next desktop release.