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

feat(api): integrate OpenAPI client generator for frontend #286

Merged
merged 1 commit into from
Jan 30, 2025

Conversation

jimmypalelil
Copy link
Contributor

Description

  • Add OpenAPI CLI generator dependency for TypeScript-Axios library
  • Implement resource entity fetching with generated client
  • Update DTO types in NestJS server
  • Add client library generation instructions to README

Fixes # (issue) N/A

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Modified tests in frontend

Checklist

  • I have read the [CONTRIBUTING](https://www.notion.so/CONTRIBUTING.md) doc
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have already been accepted and merged

Copy link
Contributor

@marcellmueller marcellmueller left a comment

Choose a reason for hiding this comment

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

This is amazing! Really solid first PR, I think Om is going to add this to Quickstart Openshift when he has time.

Something to consider for the future is a check in CI to compare the frontend and backend and ensure the client has been generated on the frontend before submitting pr for review.

Looks like Sonarcloud is complaining about test coverage, let me know if you have any issues with that thanks!

@jimmypalelil jimmypalelil force-pushed the jimmy/openapi-auto-generated-client branch 2 times, most recently from fde2ae1 to d19b846 Compare January 29, 2025 01:05
@mishraomp
Copy link
Collaborator

This is cool work, would love to steal it @jimmypalelil
cc @DerekRoberts @marcellmueller

@jimmypalelil jimmypalelil force-pushed the jimmy/openapi-auto-generated-client branch 4 times, most recently from 96491f2 to 00b98f6 Compare January 29, 2025 22:01
- Add OpenAPI CLI generator dependency for TypeScript-Axios library
- Implement resource entity fetching with generated client
- Update DTO types in NestJS server
- Add client library generation instructions to README
@jimmypalelil jimmypalelil force-pushed the jimmy/openapi-auto-generated-client branch from 00b98f6 to 846d13b Compare January 30, 2025 00:30
@jimmypalelil jimmypalelil merged commit ae7d0bc into main Jan 30, 2025
30 checks passed
@jimmypalelil jimmypalelil deleted the jimmy/openapi-auto-generated-client branch January 30, 2025 02:33
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