Skip to content

fix(DOCS-5494): remove unsupported custom prompt data fields from ACUL JS SDK docs#1172

Merged
BcnCarlos merged 6 commits into
mainfrom
fix/DOCS-5494
May 19, 2026
Merged

fix(DOCS-5494): remove unsupported custom prompt data fields from ACUL JS SDK docs#1172
BcnCarlos merged 6 commits into
mainfrom
fix/DOCS-5494

Conversation

@BcnCarlos
Copy link
Copy Markdown
Contributor

Summary

  • Removes ## Indexable sections from 53 non-supported screen option interface files — the [key: string] indexable signature (custom ulp--prefixed prompt data via CustomOptions) is only valid on 10 supported screens
  • Removes [\key`: `string`] ParamFieldentries from methodblocks in **69** non-supported screen class files — for methods whose only parameter wasCustomOptions, the entire Method Parameters / ` block is removed since no meaningful parameters remain

Supported screens (unchanged): Login, LoginId, LoginPassword, LoginPasswordlessSmsOtp, LoginPasswordlessEmailCode, Signup, SignupId, SignupPassword, PasskeyEnrollment, PasskeyEnrollmentLocal

Test plan

  • Verify ## Indexable section no longer appears in any non-supported interface file
  • Verify [\key`: `string`]` ParamField no longer appears in any non-supported class file
  • Verify the 10 supported screen class and interface files still contain their [\key`: `string`]/## Indexable` entries
  • Spot-check AcceptInvitation.mdxacceptInvitation method should have no **Method Parameters** block; changeLanguage method should retain language and persist? params
  • Spot-check MfaBeginEnrollOptions.mdxenroll method should retain action param but have no [\key`: `string`]` entry

🤖 Generated with Claude Code

…L JS SDK docs

- Remove `## Indexable` sections from 53 non-supported screen option interface files;
  `## Indexable` / `[key: string]` custom prompt data is only valid on 10 supported screens
  (Login, LoginId, LoginPassword, LoginPasswordlessSmsOtp, LoginPasswordlessEmailCode,
  Signup, SignupId, SignupPassword, PasskeyEnrollment, PasskeyEnrollmentLocal)
- Remove `[`key`: `string`]` ParamField entries from method Expandable blocks in 69
  non-supported screen class files; for CustomOptions-only methods, remove the entire
  Method Parameters / Expandable block since no meaningful parameters remain

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@BcnCarlos BcnCarlos requested a review from a team as a code owner May 13, 2026 15:10
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 13, 2026

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

Project Status Preview Updated (UTC)
auth0 🟢 Ready View Preview May 13, 2026, 3:17 PM

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 13, 2026

Summary

Status Count
🔍 Total 917
✅ Successful 4
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 913
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0
Full Github Actions output

Copy link
Copy Markdown
Contributor Author

@BcnCarlos BcnCarlos left a comment

Choose a reason for hiding this comment

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

Update of ACUL JS SDK

Copy link
Copy Markdown
Contributor Author

@BcnCarlos BcnCarlos left a comment

Choose a reason for hiding this comment

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

Reviewed

Copy link
Copy Markdown
Contributor Author

@BcnCarlos BcnCarlos left a comment

Choose a reason for hiding this comment

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

update

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@BcnCarlos BcnCarlos added documentation Improvements or additions to documentation MERGE-ON-APPROVAL Approving reviewer should merge. labels May 19, 2026
@BcnCarlos BcnCarlos merged commit 5213192 into main May 19, 2026
5 checks passed
@BcnCarlos BcnCarlos deleted the fix/DOCS-5494 branch May 19, 2026 13:42
avanscoy pushed a commit that referenced this pull request May 19, 2026
…L JS SDK docs (#1172)

* fix(DOCS-5494): remove unsupported custom prompt data fields from ACUL JS SDK docs

- Remove `## Indexable` sections from 53 non-supported screen option interface files;
  `## Indexable` / `[key: string]` custom prompt data is only valid on 10 supported screens
  (Login, LoginId, LoginPassword, LoginPasswordlessSmsOtp, LoginPasswordlessEmailCode,
  Signup, SignupId, SignupPassword, PasskeyEnrollment, PasskeyEnrollmentLocal)
- Remove `[`key`: `string`]` ParamField entries from method Expandable blocks in 69
  non-supported screen class files; for CustomOptions-only methods, remove the entire
  Method Parameters / Expandable block since no meaningful parameters remain

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* update

* update method

* Update options

* update

* Remove empty Method Parameters sections from JS SDK screen docs

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

---------

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

Labels

documentation Improvements or additions to documentation MERGE-ON-APPROVAL Approving reviewer should merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants