bazable propose

Submit a plain-English request to the AI and generate a schema change proposal.

Submits a plain‑English request to the AI and generates a schema change proposal.

Usage

bazable propose <request>

Options

This command takes no options.

Prerequisites

• An AI API key must be configured. Run bazable config --set-ai-key <your-key> (and optionally --set-ai-base and --set-ai-model if you use a provider other than OpenAI). See bazable config.
• Your bazable.config.json must contain at least one endpoint so the AI can understand the existing contract.

What it does

1. Send the request to AI

   Sends your plain-English request (for example, "Add a phone_number field to the POST /v1/users endpoint") to the AI along with the entire current contract.

2. Receive a JSON diff

   The AI returns a JSON diff describing the exact schema changes needed (new fields, type changes, and more). The proposal is displayed in the terminal in yellow.

3. Confirm or discard

   You are asked: Send this proposal to the backend team? (Y/n). On Y, the proposal is saved to pending_proposals in bazable.config.json. On n, it is discarded.

Review the saved proposal, then apply it with bazable accept <proposalId>.

Example

bazable propose "Add a phone number field to the POST /v1/users endpoint"

Example output:

Proposed schema change:
{
  "endpoint": "POST https://api.example.com/v1/users",
  "changes": {
    "request": {
      "phone_number": "string"
    },
    "response": {
      "phone_number": "string"
    }
  }
}

Send this proposal to the backend team? (Y/n)