Skip to content

docs(api): remove context grant fields - #16

Merged
tjtanjin merged 1 commit into
mainfrom
refactor/remove-context-grants
Aug 2, 2026
Merged

docs(api): remove context grant fields#16
tjtanjin merged 1 commit into
mainfrom
refactor/remove-context-grants

Conversation

@halfofning

@halfofning halfofning commented Aug 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Remove context-grant fields from the public API reference and generated OpenAPI examples.
  • Align user-facing Workflow, schedule, and webhook documentation with native-tool routing authority.

Cross-Repo Change Set

Tracking issue: none

Related PRs:

Merge order:

  1. control-plane
  2. docs-website
  3. llm-gateway
  4. management-console

Validation

  • npm run validate passed in the repository Node 22 container.
  • npm run links passed with no broken links.

Docs Impact

  • This PR is the documentation portion of the coordinated contract removal.

Residual Risk

  • Publish after the service contract changes so the reference does not get ahead of deployed behavior.

@tjtanjin
tjtanjin marked this pull request as ready for review August 2, 2026 15:32
@tjtanjin
tjtanjin merged commit e8188bc into main Aug 2, 2026
2 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1eb018e264

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@@ -4344,12 +4344,6 @@
"type": "string",
"example": "UTC"
},

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove stale grant claims from update operations

After removing approvedContextGrants, the descriptions for PATCH /api/v1/workflow-schedules/{scheduleId} and PATCH /api/v1/workflow-webhooks/{webhookId} still claim that these operations update grants. This directs API-reference users toward an unsupported payload, and the webhook schema rejects that payload because it disallows additional properties; remove the grant wording from both operation descriptions.

Useful? React with 👍 / 👎.

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.

2 participants