You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(myaccount): mark the My Account Profile API as Beta - #779
Marks the My Account Profile API as Beta in the docs and TSDoc, replacing the Early Access note added in #772.
Docs: EXAMPLES.md
The Profile heading is now tagged [Beta]. An <a id="profile"></a> anchor keeps the existing #profile link in the MyAccount table of contents working.
The Early Access note is replaced with a Beta note: the API might change before General Availability, Auth0 does not support beta functionality for production use, and the feature must be enabled for the tenant.
TSDoc: src/interfaces/auth0-vue-client.ts
The myAccount JSDoc now notes that getUserProfile() and updateUserProfile() are in Beta. The method and type docs (UserProfile, ProfileFieldPolicy, GetUserProfileOptions, UpdateUserProfileRequest) are re-exported from @auth0/auth0-spa-js and get their Beta notes from docs(myaccount): mark the My Account Profile API as Beta auth0-spa-js#1830.
Labeled the MyAccount Profile section as Beta and clarified that it may change before general availability, isn’t supported for production use, and requires tenant enablement.
Added the same Beta lifecycle information to the profile retrieval and update documentation.
Replace the Early Access note in EXAMPLES.md with a Beta note and tag the
Profile heading as [Beta], keeping the #profile anchor. Add a Beta note for
getUserProfile() and updateUserProfile() to the myAccount JSDoc.
Co-Authored-By: Claude <noreply@anthropic.com>
No actionable comments were generated in the recent review.
Walkthrough
The Profile example and API documentation now label the feature as Beta. They state that it may change before General Availability, is unsupported for production use, and requires tenant enablement.
Changes: Profile Beta documentation
Layer / File(s)
Summary
Document Beta status EXAMPLES.md, src/interfaces/auth0-vue-client.ts
The Profile example and the getUserProfile() and updateUserProfile() documentation identify the feature as Beta and state its lifecycle and tenant requirements.
auth0/auth0-vue#772: Adds the Profile APIs and documents them as Early Access; this PR updates their documentation to Beta.
Suggested reviewers:yogeshchoudhary147
Merge Risk: Minimal · up to df215
The change updates Profile API documentation without changing runtime behavior. No merge-blocking risk is established.
Pre-merge checks: 5
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title clearly describes the documentation change that marks the My Account Profile API as Beta.
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (1 skipped: 1 unsupported.)
Finishing Touches
Generate docstrings
Commit to this branch
Create a new PR
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Reviewing files that changed from the base of the PR and between 106df80 and df21534.
Files selected for processing: 2
EXAMPLES.md
src/interfaces/auth0-vue-client.ts
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Marks the My Account Profile API as Beta in the docs and TSDoc, replacing the Early Access note added in #772.
Docs:
EXAMPLES.mdProfileheading is now tagged[Beta]. An<a id="profile"></a>anchor keeps the existing#profilelink in the MyAccount table of contents working.TSDoc:
src/interfaces/auth0-vue-client.tsmyAccountJSDoc now notes thatgetUserProfile()andupdateUserProfile()are in Beta. The method and type docs (UserProfile,ProfileFieldPolicy,GetUserProfileOptions,UpdateUserProfileRequest) are re-exported from@auth0/auth0-spa-jsand get their Beta notes from docs(myaccount): mark the My Account Profile API as Beta auth0-spa-js#1830.References
Testing
Checklist
🤖 Generated with Claude Code
Summary by CodeRabbit