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

Support x-fern-availability OpenAPI extension on the property-level #5376

Open
bdbyrne opened this issue Dec 9, 2024 · 2 comments
Open

Support x-fern-availability OpenAPI extension on the property-level #5376

bdbyrne opened this issue Dec 9, 2024 · 2 comments
Labels
feature Requests for new features. spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs.

Comments

@bdbyrne
Copy link

bdbyrne commented Dec 9, 2024

The x-fern-availability extension is currently supported on endpoints, however it'd be useful to support this at the propery level, namely to document which fields are beta vs. generally available.

I could imagine it'd have to look like the following to handle $refs:

some_object:
  type: object
  properties:
    field1: ...
    field2: ...
  x-fern-availability:
    field1: beta
    field2: generally-available

We also scope the beta tag down to enum values, if that's also an option. But field-level would be good enough for our use case.

@bdbyrne bdbyrne added feature Requests for new features. product/sdk-generator Fern's SDK Generator that outputs client libraries in 7 languages labels Dec 9, 2024
@dannysheridan dannysheridan added spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs. and removed product/sdk-generator Fern's SDK Generator that outputs client libraries in 7 languages labels Dec 10, 2024
@dannysheridan dannysheridan changed the title Support x-fern-availability OpenAPI extension on fields Support x-fern-availability OpenAPI extension on the property-level Dec 10, 2024
@dannysheridan
Copy link
Member

Thanks for filing. Right now, you can control availability at the endpoint level. It makes sense for us to extend this control to the property level. This aligns with our roadmap as it gives you more control over how your API docs render to developers. Will keep you updated here.

@RohinBhargava
Copy link
Member

Hi @bdbyrne!

We are currently in the process of writing an OpenApi Parser that will handle conversion in a first-class way. I have noted this as something to include in our property parsing. Please let us know if there are other features that we can support. As Danny mentioned, we'll keep you updated with this here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Requests for new features. spec/openapi Using Swagger 2.x & OpenAPI 3.x for describing REST APIs.
Development

No branches or pull requests

3 participants