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

Eng 2698 Implement v2 api framework #1148

Merged
merged 4 commits into from
Mar 30, 2023

Conversation

likawind
Copy link
Contributor

@likawind likawind commented Mar 29, 2023

Describe your changes and why you are making these changes

This PR implement foundations of RTK Query framework together with a basic WorkflowGet query. The RTK implementation is based on prototype in #1130 .

  • All v2 routes will have v2 prefix in route name so that they don't conflict with any existing routes, and we can safely merge them to main.
  • We now have clear mapping between UI routes / responses and backend handler / responses, which are also explicitly stated in comments.
  • In v2, we name routes by resourceMethod so that the same resource is naturally grouped together by file ordering

Related issue number (if any)

Loom demo (if any)

Checklist before requesting a review

  • I have created a descriptive PR title. The PR title should complete the sentence "This PR...".
  • I have performed a self-review of my code.
  • I have included a small demo of the changes. For the UI, this would be a screenshot or a Loom video.
  • If this is a new feature, I have added unit tests and integration tests.
  • I have run the integration tests locally and they are passing.
  • I have run the linter script locally (See python3 scripts/run_linters.py -h for usage).
  • All features on the UI continue to work correctly.
  • Added one of the following CI labels:
    • run_integration_test: Runs integration tests
    • skip_integration_test: Skips integration tests (Should be used when changes are ONLY documentation/UI)

Copy link
Contributor

@kenxu95 kenxu95 left a comment

Choose a reason for hiding this comment

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

The backend changes look good to me, as well as WorkflowGet.tsx.

@likawind likawind added the run_integration_test Triggers integration tests label Mar 30, 2023
@likawind likawind merged commit 64ed7ad into main Mar 30, 2023
@likawind likawind deleted the eng-2698-m1-implement-v2-api-framework branch April 3, 2023 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run_integration_test Triggers integration tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants