Currently Fern offers the Endpoint Request and Endpoint Response components for docs. However, sometimes it's really helpful to have the entire block of a single endpoint available so that you can add these to other pages via markdown.
Why would it be useful?
This would be helpful in instances where you want all information about an endpoint listed in the same place. In a quickstart doc this would be helpful to give a quick overview of several styles of endpoints. You might also use this to document a flow for using the API or another use case where seeing all of the element (query params, error codes, etc) could be helpful.
Describe the solution (optional)
Having the Request and Response components is already great. Still if you want to fully document a single endpoint, it's nice to have the full block as if it were present in the api reference for consistency. It also allows you to insert this into any page via markdown so that you can combine this with text walking users through use cases or showing off the code a bit more.
Problem description
Currently Fern offers the Endpoint Request and Endpoint Response components for docs. However, sometimes it's really helpful to have the entire block of a single endpoint available so that you can add these to other pages via markdown.
Why would it be useful?
This would be helpful in instances where you want all information about an endpoint listed in the same place. In a quickstart doc this would be helpful to give a quick overview of several styles of endpoints. You might also use this to document a flow for using the API or another use case where seeing all of the element (query params, error codes, etc) could be helpful.
Describe the solution (optional)
Having the Request and Response components is already great. Still if you want to fully document a single endpoint, it's nice to have the full block as if it were present in the api reference for consistency. It also allows you to insert this into any page via markdown so that you can combine this with text walking users through use cases or showing off the code a bit more.