openapi/add-route

Source

add-route.ts

Usage

npm exec saf-workflow kickoff openapi/add-route <path>

To run this workflow automatically, tell the agent to:

1. Navigate to the target package
2. Run this command
3. Follow the instructions until done

Checklist

When run, the workflow will:

• Copy template files and rename placeholders.
  • Upsert example.yaml from template
  • Upsert openapi.yaml from template
  • Upsert openapi.d.ts from template
  • Upsert openapi.json from template
  • Upsert index.ts from template
• Update example.yaml. Resolve all TODOs.
• Add the route to the openapi.yaml file in the paths section. Reference the route file using $ref.
• Run npm exec saf-specs generate
• Run npx tsc --noEmit

Help Docs

Usage: npm exec saf-workflow kickoff openapi/add-route <path>

Add a new route to an existing OpenAPI specification package

Arguments:
  path        The path for the route (e.g., 'users' or 'products')
              Example: "./routes/example/example.yaml"