update-spec
Source
Usage
bash
npm exec saf-workflow kickoff update-spec [options]
To run this workflow automatically, tell the agent to:
- Navigate to the target package
- Run this command
- Follow the instructions until done
Checklist
When run, the workflow will:
- Review the project spec, and the documentation for updating specs.
- Add common objects to
schemas/
, and routes toroutes/
. Then link them in theopenapi.yaml
file. - Update the openapi.yaml file to include the new routes and schemas.
- Run
npm run generate
- Update
index.ts
to export any new schemas that were added to the spec.
Help Docs
bash
Usage: saf-workflow kickoff update-spec [options]
Update the OpenAPI spec for the project.
Options:
-h, --help display help for command