Skip to content

openapi/init

Source

init.ts

Usage

bash
npm exec saf-workflow kickoff openapi/init <name> <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.
  • Change working directory to specs/example
  • Run npm exec saf-specs generate

Help Docs

bash
Usage: npm exec saf-workflow kickoff openapi/init <name> <path>

Create an OpenAPI package

Arguments:
  name        The name of the API spec package to create (e.g., 'user-spec' or 'analytics-spec')
              Example: "example-spec"
  path        The path to the target directory for the API spec package (e.g., './specs/example')
              Example: "./specs/example"