Skip to content

Update cloud public API - #133

Open
caidobot wants to merge 1 commit into
mainfrom
bot-openapi-update
Open

caidobot wants to merge 1 commit into
mainfrom
bot-openapi-update

Conversation

@caidobot

@caidobot caidobot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated the API schema to require email_verified as a boolean field for TeamUser and User records. This clarifies that responses for these record types include an email verification status.

@caidobot
caidobot requested a review from Corb3nik as a code owner November 20, 2026 17:59
@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The OpenAPI specification now defines email_verified as a required boolean property in the TeamUser and User schemas.

Changes: User Schema Update

Layer / File(s) Summary
Add email verification fields
.vitepress/data/openapi.yaml
The TeamUser and User schemas now require email_verified and define it as a boolean property.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: Minimal · up to 0ea5d

This updates the public API documentation to list an email verification flag on user objects. There is no code behavior change in this repository, so merge risk is minimal.

Pre-merge checks: Passed 3 · Inconclusive 1

Failed Failed checks: 1 inconclusive

Check name Status Explanation Resolution
Title check Inconclusive The title "Update cloud public API" is vague. It names no specific change. The raw summary shows the only change is that the TeamUser and User schemas in .vitepress/data/openapi.yaml now require email… Rename the PR to name the main change. For example: "Require email_verified in TeamUser and User schemas". The PR has no description, so the author should also confirm the intent of the change.
Passed Passed checks: 3 passed

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "Update cloud public API" is vague. It names no specific change. The raw summary shows the only change is that the TeamUser and User schemas in .vitepress/data/openapi.yaml now require email_verified as a boolean property. The title does refer to the changed area (a public API spec), so it is not unrelated. It does not name the main change, so a teammate scanning history cannot tell what changed.

Resolution

Rename the PR to name the main change. For example: "Require email_verified in TeamUser and User schemas". The PR has no description, so the author should also confirm the intent of the change.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: b23801a9-7985-47b5-a282-2e1e65e4f845
Commits

Reviewing files that changed from the base of the PR and between 330415c and 0ea5d2a.

Files selected for processing: 1

  • .vitepress/data/openapi.yaml

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

@netlify

netlify Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for caido-doc-developer ready!

Name Link
🔨 Latest commit 0ea5d2a
🔍 Latest deploy log https://app.netlify.com/projects/caido-doc-developer/deploys/6b008a9f83682d54815fba0e
😎 Deploy Preview https://deploy-preview-133--caido-doc-developer.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

This branch has not been deployed

No deployments
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.

1 participant