fix: replace organization_billing with organization_plan_details#737
fix: replace organization_billing with organization_plan_details#737abdelrahman-zaki wants to merge 3 commits into
Conversation
…elf-serve portal sub_nav examples
WalkthroughThis PR renames the portal deep-link parameter from ChangesSelf-Serve Portal Navigation Documentation Update
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@public/llms-full.txt`:
- Line 1148: Replace the misspelled word "generting" with "generating" in the
user-facing sentence that reads "dynamically generting the URL (see below)"
inside the docs content (search for that exact phrase to locate the text block
describing SDK vs Management API portal link generation).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 8c494170-1757-40e6-ba10-6a95aa9f583c
📒 Files selected for processing (4)
public/_llms-txt/build.txtpublic/llms-full.txtsrc/content/docs/build/self-service-portal/self-serve-portal-for-orgs.mdxsrc/content/docs/build/self-service-portal/self-serve-portal-for-users.mdx
panosatkinde
left a comment
panosatkinde
left a comment
There was a problem hiding this comment.
Do we have a place in the documentation where we list all the possible values of the sub_nav parameter?
panosatkinde
left a comment
panosatkinde
left a comment
There was a problem hiding this comment.
-
Provide text where you specify that the actual set of valid values for the
sub_navare listed here: https://docs.kinde.com/kinde-apis/frontend/#tag/self-serve-portal/get/account_api/v1/portal_link -
Provide text where you mention that both
subnavandsub_navare accepted as the key of the parameter.
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/content/docs/build/self-service-portal/self-serve-portal-for-orgs.mdx (1)
112-128:⚠️ Potential issue | 🟠 Major | ⚡ Quick winParameter name is inconsistent between examples (
subnavvssub_nav).Line 112 documents
subnav, but Line 127 still usessub_navin the request body example. This inconsistency is likely to mislead implementers and cause invalid requests unless explicitly intentional per endpoint.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/content/docs/build/self-service-portal/self-serve-portal-for-orgs.mdx` around lines 112 - 128, The docs show inconsistent parameter names for the portal endpoint: "subnav" in the description but "sub_nav" in the POST /api/v1/portal/generate_url request body example; update the content so the parameter name is consistent across the page (choose the actual API parameter used by POST /api/v1/portal/generate_url and replace all occurrences of the alternate form), and ensure the example JSON and the prose both use that same symbol (e.g., use "sub_nav" everywhere or "subnav" everywhere to match the real endpoint).
♻️ Duplicate comments (2)
public/llms-full.txt (2)
1148-1148:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winTypo still present:
genertingshould begenerating.The typo "dynamically generting the URL" was flagged in a previous review but remains uncorrected in line 1148.
✏️ Proposed fix
- This can also be used as a fallback URL if you decide to use the SDK method of dynamically generting the URL (see below). + This can also be used as a fallback URL if you decide to use the SDK method of dynamically generating the URL (see below).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@public/llms-full.txt` at line 1148, Fix the typo in the documentation phrase "dynamically generting the URL" by replacing "generting" with "generating" so the sentence reads "dynamically generating the URL"; update the occurrence of that exact string in the text (near the SDK method description and the sentence referencing the fallback URL) to ensure consistency.
1148-1148:⚠️ Potential issue | 🟠 Major | ⚡ Quick winInconsistent parameter names between Account API and Management API examples.
Same issue as in the organization portal section: the "Optional parameters" list documents
subnav, but the Management API request body example uses"sub_nav": "profile". Please ensure both APIs are documented with their correct parameter names.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@public/llms-full.txt` at line 1148, The Account API example documents optional param `subnav` while the Management API request body uses `sub_nav` (and both mention `return_url`), so verify the actual parameter names used by each endpoint (/account_api/v1/portal_link and POST /api/v1/portal/generate_url) and make them consistent in the docs: update the "Optional parameters" list and the Management API JSON example so both use the correct, matching keys (e.g., `subnav` vs `sub_nav` and `return_url`) and ensure the examples reference the same parameter names developers should send.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@public/llms-full.txt`:
- Line 1139: The docs show inconsistent parameter names: change the "Optional
parameters" list and examples so they explicitly state the naming
conventions—SDK/JS helpers use camelCase (e.g., subNav / subnav in PortalLink or
client SDK examples) while the Management API payload uses snake_case
(`sub_nav`); update the "Optional parameters" bullet to show both variants and
ensure the POST /api/v1/portal/generate_url request body example uses `sub_nav`
(snake_case) and add a short note referencing SDK usage (PortalLink / fetch
example) to avoid confusion.
---
Outside diff comments:
In `@src/content/docs/build/self-service-portal/self-serve-portal-for-orgs.mdx`:
- Around line 112-128: The docs show inconsistent parameter names for the portal
endpoint: "subnav" in the description but "sub_nav" in the POST
/api/v1/portal/generate_url request body example; update the content so the
parameter name is consistent across the page (choose the actual API parameter
used by POST /api/v1/portal/generate_url and replace all occurrences of the
alternate form), and ensure the example JSON and the prose both use that same
symbol (e.g., use "sub_nav" everywhere or "subnav" everywhere to match the real
endpoint).
---
Duplicate comments:
In `@public/llms-full.txt`:
- Line 1148: Fix the typo in the documentation phrase "dynamically generting the
URL" by replacing "generting" with "generating" so the sentence reads
"dynamically generating the URL"; update the occurrence of that exact string in
the text (near the SDK method description and the sentence referencing the
fallback URL) to ensure consistency.
- Line 1148: The Account API example documents optional param `subnav` while the
Management API request body uses `sub_nav` (and both mention `return_url`), so
verify the actual parameter names used by each endpoint
(/account_api/v1/portal_link and POST /api/v1/portal/generate_url) and make them
consistent in the docs: update the "Optional parameters" list and the Management
API JSON example so both use the correct, matching keys (e.g., `subnav` vs
`sub_nav` and `return_url`) and ensure the examples reference the same parameter
names developers should send.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 3b400da2-2c0a-4676-81b9-9c31840199b1
📒 Files selected for processing (4)
public/_llms-txt/build.txtpublic/llms-full.txtsrc/content/docs/build/self-service-portal/self-serve-portal-for-orgs.mdxsrc/content/docs/build/self-service-portal/self-serve-portal-for-users.mdx
✅ Files skipped from review due to trivial changes (1)
- src/content/docs/build/self-service-portal/self-serve-portal-for-users.mdx
panosatkinde
left a comment
panosatkinde
left a comment
There was a problem hiding this comment.
I see that the public/_llms-txt/build.txt still refers to sub_nav.
…nt API subnav usage
2 participants
Updated docs to replace
organization_billingwithorganization_plan_details, standardizesubnavfor Account API examples, and remove Management API portal-link examples across source and generated llms docs.Summary by CodeRabbit