refactor(frontend): generate API react-query helpers with Orval DEV-893 #6083
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Akuukis
requested review from
jamesrkiger,
magicznyleszek,
noliveleger and
p2edwards
as code owners
Akuukis
force-pushed
the
kalvis/api-orval
branch
2 times, most recently
from
4a6835d to
4807342
Compare
|
root cause for CI fail is addressed at #6084, let's merge that into |
Akuukis
force-pushed
the
kalvis/api-orval
branch
2 times, most recently
from
ac0ff84 to
fb91f82
Compare
Akuukis
changed the base branch from
feature/api-documentation
to
kalvis/ignore-minified-swagger
Base automatically changed from
kalvis/ignore-minified-swagger
to
feature/api-documentation
August 13, 2025 12:59
Akuukis
force-pushed
the
kalvis/api-orval
branch
2 times, most recently
from
708a733 to
563a626
Compare
Akuukis
force-pushed
the
kalvis/api-orval
branch
3 times, most recently
from
006359a to
3a900e6
Compare
Akuukis
changed the title
Akuukis
changed the title
Akuukis
added a commit
that referenced
this pull request
Aug 20, 2025
### 💭 Notes For development purposes let's commit the generated schema, so that we can build on top of that frontend typed API helpers, see #6083. To ensure that the committed schema is always up-to-date, let's add to CI a job that checks if it's generated. P.S. along the way simplified the script with a helper for gosu. ### 👀 Preview steps 1. see the new "openapi" job 2. 🟢 [on PR showcase commit [f4d9501](f4d9501) before updating schema] notice that CI fails 3. 🟢 [on PR latest commit [936c461](936c461) after updating schema] notice that CI succeeds 4. 🟢 run locally `./run.py -cf run --rm kpi ./scripts/generate_openapi_schemas.sh` from `kobo-install` and it succeeds to regenerate schema
Akuukis
force-pushed
the
kalvis/api-orval
branch
from
3a900e6 to
847c7b4
Compare
Akuukis
changed the title
Akuukis
force-pushed
the
kalvis/api-orval
branch
5 times, most recently
from
60b1e32 to
e6aee5a
Compare
Akuukis
requested review from
pauloamorimbr
and removed request for
olive-KTB,
p2edwards and
rgraber
Akuukis
changed the title
pauloamorimbr
approved these changes
Aug 28, 2025
Akuukis
force-pushed
the
kalvis/api-orval
branch
from
e6aee5a to
1461192
Compare
pauloamorimbr
pushed a commit
that referenced
this pull request
Sep 8, 2025
…93 (#6083) ### 💭 Notes Generate react-query helpers from API with Orval. By it's own does nothing. See these few refactors, the rest is for now unused generated files: - `jsapp/js/api.ts` - `package.json` - `package-lock.json` Configuration is split across these files: - `orval.config.js` - `jsapp/js/api/orval.mutator.ts` - `jsapp/js/api/orval.operationName.ts` - `scripts/generate_api.sh` - `.github/workflows/openapi.yml` See other refactor PRs that use these helpers to call API: - #6090 ### 👀 Preview steps 1. run kobo-install locally 2. `./run.py -cf run --rm kpi ./scripts/generate_api.sh` to re-generate helpers 3. notice that helpers are regenerated 4. click around so that some APIs are called the old way 5. notice that it still works and the refactors didn't break anything
pauloamorimbr
pushed a commit
that referenced
this pull request
Sep 17, 2025
…93 (#6083) ### 💭 Notes Generate react-query helpers from API with Orval. By it's own does nothing. See these few refactors, the rest is for now unused generated files: - `jsapp/js/api.ts` - `package.json` - `package-lock.json` Configuration is split across these files: - `orval.config.js` - `jsapp/js/api/orval.mutator.ts` - `jsapp/js/api/orval.operationName.ts` - `scripts/generate_api.sh` - `.github/workflows/openapi.yml` See other refactor PRs that use these helpers to call API: - #6090 ### 👀 Preview steps 1. run kobo-install locally 2. `./run.py -cf run --rm kpi ./scripts/generate_api.sh` to re-generate helpers 3. notice that helpers are regenerated 4. click around so that some APIs are called the old way 5. notice that it still works and the refactors didn't break anything
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
💭 Notes
Generate react-query helpers from API with Orval. By it's own does nothing. See these few refactors, the rest is for now unused generated files:
jsapp/js/api.tspackage.jsonpackage-lock.jsonConfiguration is split across these files:
orval.config.jsjsapp/js/api/orval.mutator.tsjsapp/js/api/orval.operationName.tsscripts/generate_api.sh.github/workflows/openapi.ymlSee other refactor PRs that use these helpers to call API:
👀 Preview steps
./run.py -cf run --rm kpi ./scripts/generate_api.shto re-generate helpers