Skip to content

docs: Sync the API reference with platform-client 0.24.0 - #12409

Merged
vasilev-alex merged 2 commits into
masterfrom
docs/api-reference-platform-client-0.24.0
Oct 24, 2026
Merged

vasilev-alex merged 2 commits into
masterfrom
docs/api-reference-platform-client-0.24.0

Conversation

@vasilev-alex

@vasilev-alex vasilev-alex commented Oct 24, 2026 •

Copy link
Copy Markdown
Member

Check List

  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

Description of Changes Made

Syncs docs-mintlify/api-reference/ with @cube-dev/platform-client@0.24.0, which is live on npm.

  • Scheduled task create, update and response schemas gain notification (users, groups, Slack channels over Inbox, Email and Slack); notificationEnabled is documented as deprecated; a condition task that notifies nobody answers 400.
  • changelog.mdx gains the v0.24.0 entry; existing entries are untouched.

api.yaml carries only the delta between the 0.23.1 and 0.24.0 specs, applied to the committed file. A full regeneration would also drop content hand-added since the 0.23.1 sync (for example the alert rules documented in #12306), which is not in the released spec. That drift predates this release and is left for a separate call.

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
cubed3 🟢 Ready View Preview Oct 24, 2026, 9:58 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions github-actions Bot added the docs Issues that require a documentation improvement label Oct 24, 2026
@claude

claude Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @vasilev-alex's task in 1m 15s —— View job


Looks good to merge: 2 low findings, nothing blocking.

Review details
  • Read diff and changed files
  • Check api.yaml / changelog.mdx consistency
  • Review threads
  • Post review

Findings

  • Low: docs-mintlify/api-reference/api.yaml:9563 (also at :16551 and :17798). The condition descriptions say the deprecated notificationEnabled shape "keeps its earlier behaviour", but this diff deletes the sentence that described that behaviour, so the phrase points at nothing. The text comes from the spec, so it needs fixing upstream.
  • Low: docs-mintlify/api-reference/changelog.mdx:59. The regenerated v0.20.0 entry now announces eval-run securityContext, new EvaluationResultResponse fields and memoryGenerationEnabled. None of these are in api.yaml, so the existing spec drift gets bigger.

Checked, no issue

  • The spec is OpenAPI 3.1.0, so description next to $ref on ScheduledTaskResponse.notification is valid.
  • The new schemas (ScheduledTaskNotification, …NotificationInput, …NotificationChannels, ScheduledTaskSlackChannel) all resolve. Their required lists and size limits match between the input and response shapes.
  • optedOutUserIds is correctly left out of required, because only the creator or an admin gets it.
  • notification as explicit null on update answers 400, the same as the existing notificationEnabled behaviour.
  • User-facing docs: this PR is itself the docs change for the 0.24.0 API.
  • No code, tests, security or performance surface.

Review threads

No prior threads: the listing returned 0 of my own, so none were resolved or re-affirmed.

Comment thread docs-mintlify/api-reference/api.yaml
Comment thread docs-mintlify/api-reference/changelog.mdx Outdated
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@claude

claude Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @vasilev-alex's task in 51s —— View job


LGTM: 0 high, 0 medium, 0 low.

Review details
  • Read diff and changed files
  • Verify schema refs, ordering and consistency with scheduled-tasks.mdx
  • Check prior review threads
  • Post review

Checks

  • Every new $ref resolves. That covers ScheduledTaskNotification, ScheduledTaskNotificationChannels, ScheduledTaskNotificationInput and ScheduledTaskSlackChannel, which are inserted in alphabetical order among the existing ScheduledTask* schemas.
  • notification on ScheduledTaskResponse uses $ref with a sibling description. That is valid because api.yaml is openapi: 3.1.0.
  • notificationEnabled is marked deprecated: true on create, update and response. The update input keeps "Explicit null answers 400" for both fields.
  • The user guide already describes notification, its limits (1,000 users, 200 groups, 50 Slack channels) and the deprecated notificationEnabled (docs-mintlify/docs/explore-analyze/scheduled-tasks.mdx:443-449). That matches the new schemas, so no user-facing docs are missing.
  • The changelog entry only adds v0.24.0 on top of the existing entries, after the second commit, so the hand-added history stays in place.
  • Applying only the spec delta, rather than regenerating the whole file, keeps the alert-rule content added in docs: % change and anomaly alerts on a KPI, compared with previous checks (CUB-5218) #12306. That is a reasonable call for this PR.

Not verified

I couldn't download @cube-dev/platform-client@0.24.0 from npm (the command needs approval in this run), so I didn't diff the YAML against the released spec byte for byte. The review is based on internal consistency.

Prior review threads

The listing returned 0 of my own threads, so there were none to resolve or re-affirm.

@vasilev-alex
vasilev-alex merged commit 895e97b into master Oct 24, 2026
20 checks passed
@vasilev-alex
vasilev-alex deleted the docs/api-reference-platform-client-0.24.0 branch October 24, 2026 10:01

This branch was successfully deployed

1 active deployment
staging - docs-mintlify — a72595df Deployed Oct 24, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues that require a documentation improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants