docs(api): list Braided Audio publish/stop in openapi (#198)

[yakimoto]

Summary

• Adds POST /v1/braid/publish and DELETE /v1/braid/publish/{ns} to the public OpenAPI spec, matching the live handler in wave-listen-edge/src/braid-publish.ts + worker.ts (request fields, response shapes, error codes 400/403/429/501).
• New Braided Audio tag + BraidPublishRequest/BraidPublishResult/BraidStopResult schemas.

Test plan

• python3 -c "import yaml; yaml.safe_load(open('openapi.yaml'))" — parses clean
• CI spec-lint (if configured) on this PR

Part of #198 (SHIP WAVE Braided Audio public — offline surfaces).

---

Note

Low Risk
OpenAPI-only documentation; no runtime, auth, or billing behavior changes.

Overview
Documents on-demand WAVE Braided Audio in the public openapi.yaml so clients can discover publish/stop without reading edge worker code.

Adds a Braided Audio tag describing MoQ braided tracks, moq:write, and replace/stop semantics. New paths: POST /braid/publish (start or replace a namespace publisher; 201 with machine metadata, plus 400/403/429/501) and DELETE /braid/publish/{ns} (explicit stop; 200/403/404/501). Component schemas BraidPublishRequest, BraidPublishResult, and BraidStopResult capture ns, labeled sources (url or path), optional windowMs/sampleRate, and org derived from auth—not the request body.

^{Reviewed by Cursor Bugbot for commit 1986b9f. Configure here.}

---

Summary by cubic

Adds Braided Audio publish/stop endpoints to the public OpenAPI so clients can start and stop on‑demand braided audio machines. Includes the Braided Audio tag, request/response schemas, and documented error responses.

• New Features
  • Added POST /v1/braid/publish and DELETE /v1/braid/publish/{ns} with moq:write entitlement.
  • New schemas: BraidPublishRequest, BraidPublishResult, BraidStopResult.
  • Responses include 201/200 plus 400, 403, 404 (for stop), 429, and 501.

^{Written for commit 1986b9f. Summary will update on new commits.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1986b9f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[cursor]

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_97f5218b-56e9-4e66-b3dc-93a7c356eb2d)

[coderabbitai]

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 46 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 026ad4fb-47c7-47e5-984d-5f255022ea01

📥 Commits

Reviewing files that changed from the base of the PR and between cc66edc and 1986b9f.

📒 Files selected for processing (1)

• openapi.yaml

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/braid-public-api-spec

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch feat/braid-public-api-spec

---

_{Comment @coderabbitai help to get the list of available commands.}

[cursor]

Risk: low. Cursor Bugbot did not complete (check skipped due to usage limit), so the automated review signal is unavailable. Human review is needed before merge.

  

_{Sent by Cursor Approval Agent: Pull Request Router and Approver}