Skip to content

refactor(members): adopt Orval for members and invites DEV-870 DEV-871 DEV-947 #6090

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

refactor(members): adopt Orval for members and invites DEV-870 DEV-871 DEV-947 #6090

wants to merge 2 commits into from

Conversation

Akuukis
Copy link
Contributor

@Akuukis Akuukis commented Aug 11, 2025 •
edited
Loading

🗒️ Checklist

  1. run linter locally
  2. update developer docs (API, README, inline, etc.), if any
  3. for user-facing doc changes create a Zulip thread at #Kobo support docs, if any
  4. draft PR with a title <type>(<scope>)<!>: <title> DEV-1234
  5. assign yourself, tag PR: at least Front end and/or Back end or workflow
  6. fill in the template below and delete template comments
  7. review thyself: read the diff and repro the preview as written
  8. open PR & confirm that CI passes & request reviewers, if needed
  9. delete this section before merging

💭 Notes

Refactor organization invites endpoints to use generated react-query helpers.

👀 Preview steps

  1. have local env with a project
  2. in django admin panel create and enable organization for the super user
  3. in django admin panel create another user
  4. login as superuser, go to http://kf.kobo.local/#/account/organization/members
  5. invite the user
  6. 🟢 notice that invite is in the list
  7. edit the invite's role
  8. 🟢 notice that invite in the list updates
  9. resend the invite
  10. 🟢 notice that invite in the list updates
  11. delete the invite
  12. 🟢 notice that list updates and invite is not there anymore

@Akuukis Akuukis self-assigned this Aug 13, 2025
@Akuukis Akuukis mentioned this pull request Aug 13, 2025
Merged
@Akuukis Akuukis force-pushed the kalvis/api-orval branch 2 times, most recently from 708a733 to 563a626 Compare August 13, 2025 16:39
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch 2 times, most recently from dba2f08 to 3eade12 Compare August 18, 2025 12:03
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from 3eade12 to fc8085c Compare August 18, 2025 12:57
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from fc8085c to cb8f9de Compare August 19, 2025 09:44
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from cb8f9de to bfbd9e4 Compare August 19, 2025 10:19
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from b411641 to 2fa3321 Compare August 25, 2025 12:09
@Akuukis Akuukis force-pushed the kalvis/api-orval branch 4 times, most recently from 60b1e32 to e6aee5a Compare August 25, 2025 14:50
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch 5 times, most recently from c8aaa26 to 6964d89 Compare August 25, 2025 17:34
@Akuukis Akuukis changed the title refactor(invites): use generated react-query DEV-871 refactor(invites): use generated react-query DEV-871 DEV-947 Aug 25, 2025
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from 6964d89 to 56a365a Compare August 26, 2025 09:00
Akuukis added a commit that referenced this pull request Aug 28, 2025
@Akuukis
refactor(frontend): generate API react-query helpers with Orval DEV-8…
aa3b6a4 
…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
Base automatically changed from kalvis/api-orval to main August 28, 2025 10:46
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from 56a365a to 7bca51f Compare September 4, 2025 10:11
pauloamorimbr pushed a commit that referenced this pull request Sep 8, 2025
@Akuukis @pauloamorimbr
refactor(frontend): generate API react-query helpers with Orval DEV-8…
110f48d 
…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
@Akuukis @pauloamorimbr
refactor(frontend): generate API react-query helpers with Orval DEV-8…
01bcfa3 
…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
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from 7bca51f to 7fc4f29 Compare September 22, 2025 15:16
@Akuukis Akuukis force-pushed the kalvis/api-orval-invite branch from 5125b0c to 8f55d0b Compare October 1, 2025 07:26
@Akuukis Akuukis changed the title refactor(invites): use generated react-query DEV-871 DEV-947 refactor(invites): use generated react-query DEV-870 DEV-871 DEV-947 Oct 1, 2025
@Akuukis Akuukis changed the title refactor(invites): use generated react-query DEV-870 DEV-871 DEV-947 refactor(members): adpot Orval for members and invites DEV-870 DEV-871 DEV-947 Oct 1, 2025
@Akuukis Akuukis changed the title refactor(members): adpot Orval for members and invites DEV-870 DEV-871 DEV-947 refactor(members): adopt Orval for members and invites DEV-870 DEV-871 DEV-947 Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jamesrkiger jamesrkiger Awaiting requested review from jamesrkiger jamesrkiger will be requested when the pull request is marked ready for review jamesrkiger is a code owner

@magicznyleszek magicznyleszek Awaiting requested review from magicznyleszek magicznyleszek will be requested when the pull request is marked ready for review magicznyleszek is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@Akuukis Akuukis

Labels

Front end

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Akuukis