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

Serve raw openapi json spec as part of fern docs #5531

Open
paul-paliychuk opened this issue Jan 6, 2025 · 1 comment
Open

Serve raw openapi json spec as part of fern docs #5531

paul-paliychuk opened this issue Jan 6, 2025 · 1 comment
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@paul-paliychuk
Copy link

Feature Description

We would like to be able to expose our openapi.json file to the people using our docs.

Use Case

We've had requests by the community for the openapi file so that they could generate their own sdks using the tooling of their choise, particularly for languages/ecosystems we currently do not support (or that we do not intend to support in the future).

Proposed Experience (Optional)

Just the JSON file served on the api-reference/json endpoint.

Alternatives Considered (Optional)

We are currently considering open sourcing our fern docs repository to make the openapi file available to the public.

@paul-paliychuk paul-paliychuk added feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site labels Jan 6, 2025
@dannysheridan dannysheridan added spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs. and removed spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs. labels Jan 6, 2025
@dannysheridan
Copy link
Member

dannysheridan commented Jan 6, 2025

Thanks for filing. I could see us exposing the OpenAPI specification(s) at one of the following:

ReadMe takes the approach of sharing a link to each OpenAPI spec you've uploaded on the /openapi url: https://developer.bill.com/openapi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

2 participants