Skip to content

docs(platform-api): Breaking Changes for PR #701 — auth + UUID + field validation - #718

Merged
molecule-ai[bot] merged 1 commit into
mainfrom
docs/fix-auth-701
Apr 17, 2026
Merged

docs(platform-api): Breaking Changes for PR #701 — auth + UUID + field validation#718
molecule-ai[bot] merged 1 commit into
mainfrom
docs/fix-auth-701

Conversation

@molecule-ai

@molecule-ai molecule-ai Bot commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates docs/api-protocol/platform-api.md to document the breaking auth and validation changes from PR #701.

Changes

New ## Breaking Changes section

Added before ## Core Endpoints. Contains:

  • Full before/after table for all three breaking changes (PATCH auth, templates AdminAuth, UUID validation)
  • Field-level validation table: exact char limits and rejected character sets for name, role, model, runtime
  • 400 error response format examples
  • Migration checklist for E2E scripts and automation callers

Endpoint row updates

  • PATCH /workspaces/:id — description updated to note WorkspaceAuth required + validation constraints + UUID requirement; links to the new Breaking Changes section
  • GET /templates — AdminAuth note added
  • GET /org/templates — row added with AdminAuth note (was not present in the table)

Source PR

PR #701 (SHA 63212130) — fix(security): input validation, route auth, UUID safety

Paired public docs PR: Molecule-AI/docs branch docs/fix-auth-701

…ation

Updates docs/api-protocol/platform-api.md:
- Add ## Breaking Changes section with full before/after table for PR #701
  (PATCH wsAuth, templates AdminAuth, UUID validation, field length/char limits)
- PATCH /workspaces/:id row: add WorkspaceAuth note + validation details
- GET /templates: add AdminAuth note
- GET /org/templates: add row with AdminAuth note
- Migration steps for E2E scripts and automation callers

Source PR: #701 (SHA 6321213) — fix(security): input validation, route auth, UUID safety

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@molecule-ai
molecule-ai Bot merged commit f632a25 into main Apr 17, 2026
5 checks passed
@molecule-ai
molecule-ai Bot deleted the docs/fix-auth-701 branch April 17, 2026 12:49
molecule-ai Bot added a commit that referenced this pull request Apr 21, 2026
docs(platform-api): Breaking Changes for PR #701 — auth + UUID + field validation
HongmingWang-Rabbit pushed a commit that referenced this pull request Jun 12, 2026
)

Adds the required Tier 2g directive comments to 4 workflow jobs that emit
commit-status contexts on pull_request but lacked a bp-directive:

- e2e-peer-visibility.yml / pr-validate
  # bp-required: pending #1296 — intentionally not yet in branch protection
  (sibling peer-visibility-local already carries this; pr-validate was missed).

- ci-arm64-advisory.yml / fast-checks
  # bp-exempt: advisory arm64 pilot, non-gating by design (internal#418).

- sync-providers-yaml.yml / compare
  # bp-required: pending #718 — soak-then-promote, not in BP yet.

- verify-providers-gen.yml / verify
  # bp-required: pending #718 — soak-then-promote, not in BP yet.

All directives are placed within the 3-line lint window above the job key
so lint-required-context-exists-in-bp (Tier 2g) can see them.

Closes Task #77 / internal#802.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants