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

Fix Swagger definitions #2008

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Fix Swagger definitions #2008

merged 1 commit into from
Oct 11, 2024

Conversation

iamacook
Copy link
Member

Summary

We are observing inconsistencies between our TypeScript types and Swagger schema in our automatically generated SDK. This fixes some of those encountered issues.

Changes

  • All nullable values are defined in ApiOptionalProperty decorators, flagged as nullable with the correct type
  • All array-expected values leverage the isArray property instead of TypeScript annotations

@iamacook iamacook self-assigned this Oct 10, 2024
@iamacook iamacook requested a review from a team as a code owner October 10, 2024 14:30
Copy link
Member

@hectorgomezv hectorgomezv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏻

@iamacook iamacook merged commit c61ff00 into main Oct 11, 2024
18 checks passed
@iamacook iamacook deleted the fix-swagger-defs branch October 11, 2024 09:47
PooyaRaki pushed a commit that referenced this pull request Oct 15, 2024
Fixes some issues in the Swagger schema:

- All nullable values are defined in `ApiOptionalProperty` decorators, flagged as `nullable` with the correct `type`
- All array-expected values leverage the `isArray` property instead of TypeScript annotations
DenSmolonski pushed a commit to Zilliqa/safe-client-gateway that referenced this pull request Oct 24, 2024
Fixes some issues in the Swagger schema:

- All nullable values are defined in `ApiOptionalProperty` decorators, flagged as `nullable` with the correct `type`
- All array-expected values leverage the `isArray` property instead of TypeScript annotations
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.

2 participants