Skip to content

Resolve spec typing bugs detailed in FER 4816 #240

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

Merged
merged 1 commit into from
Apr 8, 2025
Merged

Resolve spec typing bugs detailed in FER 4816 #240

merged 1 commit into from
Apr 8, 2025

Conversation

fern-support
Copy link
Collaborator

Check FER 4816 for details. Basically there's several type issues/inconsistencies in the OpenAPI spec.

Some notes on each of the issues:

1-3 had been resolved before I started the task, possibly fixed over the course of adding overrides while making it work for TS SDK generation.

  1. "avatar" attribute was already overridden to be the correct type (string).
  2. Parameters were already added to the OpenAPI spec, the so issue shouldn't be present anymore. Also double-checked by checking that the parameters exist on the generated SDK.
  3. Consistency has already been reinforced via override for company_list as well as for several other types that used to use "cursor_pages" - now all use offset_pages as the type for pages.
  4. Repro'd via curl by calling API that this issue was present. Resolved by overriding type to the response to oneOf to capture the possible divergence in return type.
  5. Difficult to debug as we don't know what generator this user is using, so fixes are speculative. The first two are very likely due to an error in the OpenAPI spec, as item types for the array option in the ticket related schemas are missing. Resolved by overriding the type to any. The error with snooze_conversation_request.required is too vague to properly diagnose, so no action was taken for it.

@Eclairemoy Eclairemoy enabled auto-merge (squash) April 8, 2025 14:48
@Eclairemoy Eclairemoy self-requested a review April 8, 2025 14:48
@Eclairemoy Eclairemoy merged commit 8a8b0b7 into main Apr 8, 2025
5 checks passed
@Eclairemoy Eclairemoy deleted the FER-4816 branch April 8, 2025 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants