Fix typo: seperate -> separate#11494
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughSummaryThis pull request updates documentation by correcting the misspelling “seperate”/“seperated” to “separate”/“separated” and making a few related formatting and documentation improvements in the affected API reference files and navigation configuration. Changesgovernance-v1.yaml
service-catalog-v1.yaml
en/mkdocs.yml
WalkthroughThis PR standardizes OpenAPI YAML reference formatting in the governance-v1 API reference, adds a default value for the offset pagination parameter, and corrects minor wording and spacing in API documentation text. It also updates the service-catalog-v1 reference text for spelling, and fixes a MkDocs navigation target path. Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
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
`@en/docs/reference/product-apis/governance-apis/governance-v1/governance-v1.yaml`:
- Line 74: Replace the misspelled placeholder "admin_passowrd" with
"admin_password" in the curl auth examples; specifically update the curl lines
that contain the grant_type=password payload (the string
"grant_type=password&username=<admin_username>&password=<admin_passowrd&scope=...")
in both the governance-v1 and service-catalog-v1 YAML docs so the placeholder is
consistently spelled "admin_password".
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9110c286-778f-4e05-b6f9-e9fdc95dda63
📒 Files selected for processing (7)
en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yamlen/docs/reference/product-apis/governance-apis/governance-v1/governance-v1.yamlen/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.yamlen/docs/reference/product-apis/service-catalog-apis/service-catalog-v1/service-catalog-v1.yamlen/mkdocs.ymlen/redirects.ymlen/tools/config-catalog-generator/data/configs.json
| Following is the format of the request if you are using the password grant type. | ||
| ``` | ||
| curl -k -d "grant_type=password&username=<admin_username>&password=<admin_passowrd&scope=<scopes seperated by space>" | ||
| curl -k -d "grant_type=password&username=<admin_username>&password=<admin_passowrd&scope=<scopes separated by space>" |
There was a problem hiding this comment.
Standardize the password placeholder spelling across both auth examples.
The same typo (admin_passowrd) appears in both en/docs/reference/product-apis/governance-apis/governance-v1/governance-v1.yaml and en/docs/reference/product-apis/service-catalog-apis/service-catalog-v1/service-catalog-v1.yaml. Updating both to admin_password keeps the docs consistent and avoids confusion in copy/edit workflows.
🤖 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
`@en/docs/reference/product-apis/governance-apis/governance-v1/governance-v1.yaml`
at line 74, Replace the misspelled placeholder "admin_passowrd" with
"admin_password" in the curl auth examples; specifically update the curl lines
that contain the grant_type=password payload (the string
"grant_type=password&username=<admin_username>&password=<admin_passowrd&scope=...")
in both the governance-v1 and service-catalog-v1 YAML docs so the placeholder is
consistently spelled "admin_password".
Summary
Fixed a typo in multiple files.
Problem
The word "seperate" was misspelled across 7 files.
Changes