Skip to content

Conversation

@Akuukis
Copy link
Contributor

@Akuukis Akuukis commented Aug 14, 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 before updating schema] notice that CI fails
  3. 🟢 [on PR latest commit 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 Akuukis self-assigned this Aug 14, 2025
@noliveleger noliveleger force-pushed the kalvis/gen-schema branch 2 times, most recently from 47274cf to 011e437 Compare August 17, 2025 12:55
@Akuukis Akuukis marked this pull request as ready for review August 18, 2025 08:44
@Akuukis Akuukis requested a review from noliveleger August 18, 2025 08:48
@Akuukis Akuukis force-pushed the kalvis/gen-schema branch from fb0b0bb to 82338a7 Compare August 19, 2025 09:29
@Akuukis Akuukis force-pushed the kalvis/gen-schema branch from 82338a7 to 0fd5e3e Compare August 19, 2025 09:33
Copy link
Contributor

@noliveleger noliveleger left a comment

Choose a reason for hiding this comment

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

LGTM

@Akuukis Akuukis merged commit e1b06d1 into feature/api-documentation Aug 20, 2025
12 checks passed
@Akuukis Akuukis deleted the kalvis/gen-schema branch August 20, 2025 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants