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

Add ability to check Fern Definition against OpenAPI spec #6087

Open
zachkirsch opened this issue Feb 19, 2025 · 1 comment
Open

Add ability to check Fern Definition against OpenAPI spec #6087

zachkirsch opened this issue Feb 19, 2025 · 1 comment
Assignees
Labels
product/CLI Fern's command line interface tool spec/fern-definition Using the Fern Definition for describing REST, Webhook, and WebSocket APIs. spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs.

Comments

@zachkirsch
Copy link
Contributor

zachkirsch commented Feb 19, 2025

How important is this?

P0 - Critical (Blocking work)

What's the feature?

We currently generate an openapi spec for our docs (and hopefully one day - SDKs!) using tsoa.

However, when it comes to ordering of properties, documenting fields, etc. tsoa is great, and I'd rather just use the fern definition.

Of course, I don't want by backend to drift from my openapi spec.

I think the ideal solution is to:

  1. Manually maintain a fern definition for my public API
  2. continue generating an openapi spec using tsoa
  3. Add some CI-time check that ensures that my fern definition does not drift from my openapi spec

Of course, I could do this manually, but I think it would be awesome if fern supported this out-of-the-box!

Anything else? (Optional)

I would be down to contribute but would need some handholding

Are you interested in contributing this feature?

Yes

@dsinghvi
Copy link
Member

@zachkirsch want to grab some time to chat through how you could buld this? https://calendly.com/deep-singhvi/15min

@dannysheridan dannysheridan added the product/CLI Fern's command line interface tool label Feb 20, 2025
@dannysheridan dannysheridan added spec/fern-definition Using the Fern Definition for describing REST, Webhook, and WebSocket APIs. spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs. labels Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product/CLI Fern's command line interface tool spec/fern-definition Using the Fern Definition for describing REST, Webhook, and WebSocket APIs. spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs.
Development

No branches or pull requests

3 participants