Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Endpoint Block component #5240

Open
aweaver89 opened this issue Nov 21, 2024 · 0 comments
Open

[Feature] Endpoint Block component #5240

aweaver89 opened this issue Nov 21, 2024 · 0 comments

Comments

@aweaver89
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant