Skip to content

Fix inconsistent URL paths in See Also section of create-a-rest-api.md - #11706

Open
IT24100161 wants to merge 1 commit into
wso2:masterfrom
IT24100161:fix-inconsistent-url-path
Open

Fix inconsistent URL paths in See Also section of create-a-rest-api.md#11706
IT24100161 wants to merge 1 commit into
wso2:masterfrom
IT24100161:fix-inconsistent-url-path

Conversation

@IT24100161

Copy link
Copy Markdown

Purpose

To fix inconsistent URL paths in the "See Also" section of the "Create a REST API" page.

Goals

Ensure consistent URL path naming (/api-design-manage/) across the entire create-a-rest-api.md document, eliminating page-level inconsistencies, potential SEO duplicate content issues, and broken links in static site builds/forks.

Approach

Updated all 8 links in the See Also section at the bottom of create-a-rest-api.md to use {{base_path}}/api-design-manage/ instead of {{base_path}}/manage-apis/, bringing them into alignment with the rest of the document.

Modified links:

  • Endpoints -> {{base_path}}/api-design-manage/design/endpoints/endpoint-types/
  • API Security -> {{base_path}}/api-design-manage/design/api-security/api-authentication/secure-apis-using-oauth2-tokens/
  • Rate Limiting -> {{base_path}}/api-design-manage/design/rate-limiting/introducing-throttling-use-cases/
  • Life Cycle Management -> {{base_path}}/api-design-manage/design/lifecycle-management/api-lifecycle/
  • API Monetization -> {{base_path}}/api-design-manage/design/api-monetization/monetizing-an-api/
  • API Visibility -> {{base_path}}/api-design-manage/design/advanced-topics/control-api-visibility-and-subscription-availability-in-developer-portal/
  • API Documentation -> {{base_path}}/api-design-manage/design/api-documentation/add-api-documentation/
  • Custom Properties -> {{base_path}}/api-design-manage/design/create-api/adding-custom-properties-to-apis/

User stories

N/A

Release note

Fixed inconsistent URL paths in the "See Also" section of the "Create a REST API" documentation page.

Documentation

N/A - This PR is a documentation bug fix for docs-apim.

Training

N/A

Certification

N/A - Minor documentation link fix with no impact on certification exams.

Marketing

N/A

Automation tests

  • Unit tests

    N/A

  • Integration tests

    N/A

Security checks

Samples

N/A

Related PRs

Completes the migration started in PR #10492

Migrations (if applicable)

N/A

Test environment

Verified using local MkDocs dev server (python -m mkdocs serve).

Learning

Identified how client-side routing redirects /manage-apis/ to /api-design-manage/, masking raw source markup path discrepancies in the browser status bar.

@CLAassistant

CLAassistant commented Jul 27, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ac751d46-968b-4c4a-a9a4-65d37b664b3f

📥 Commits

Reviewing files that changed from the base of the PR and between 325aeae and 36de87b.

📒 Files selected for processing (1)
  • en/docs/api-design-manage/design/create-api/create-rest-api/create-a-rest-api.md

📝 Walkthrough

Summary

Updated all eight “See Also” links in the REST API creation guide to use the consistent {{base_path}}/api-design-manage/ path, improving documentation consistency and static-site compatibility.

Validation

Verified with a local MkDocs development server.

Walkthrough

Updated the REST API creation guide’s “See Also” links for Endpoints, API Security, Rate Limiting, Life Cycle Management, API Monetization, API Visibility, API Documentation, and Custom Properties. Each link now uses the api-design-manage URL prefix instead of manage-apis.

Suggested reviewers: chamilaadhi, tharikagithub

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately describes the primary documentation link fix in the PR.
Description check ✅ Passed The description follows the template and includes all required sections with relevant details or N/A notes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

2 participants