Update API generation docs and just task (#2668)

2025-07-16 09:48:30 -07:00
parent 201d5c9cf6
commit 98880c3ec3
2 changed files with 22 additions and 0 deletions
@@ -67,6 +67,21 @@ you can talk to goose!

 You can now make changes in the code in ui/desktop to iterate on the GUI half of goose.

+### Regenerating the OpenAPI schema
+
+The file `ui/desktop/openapi.json` is automatically generated during the build.
+It is written by the `generate_schema` binary in `crates/goose-server`.
+If you need to update the spec without starting the UI, run:
+
+```
+just generate-openapi
+```
+
+This command regenerates `ui/desktop/openapi.json` and then runs the UI's
+`generate-api` script to rebuild the TypeScript client from that spec.
+
+Changes to the API should be made in the Rust source under `crates/goose-server/src/`.
+
 ## Creating a fork

 To fork the repository: