Skip to content

Fix: Update hardcoded Mocky URL to placeholder#11495

Open
Pasansa-w wants to merge 2 commits into
wso2:masterfrom
Pasansa-w:patch-2
Open

Fix: Update hardcoded Mocky URL to placeholder#11495
Pasansa-w wants to merge 2 commits into
wso2:masterfrom
Pasansa-w:patch-2

Conversation

@Pasansa-w

@Pasansa-w Pasansa-w commented Jun 12, 2026

Copy link
Copy Markdown

Replaced the static, hardcoded Mocky endpoint with a descriptive placeholder in the Quick Start Guide to improve clarity for users.

Purpose

The Quick Start Guide currently provides a hardcoded, static Mocky URL. If a user utilizes the hardcoded link, it removes the purpose of the step where they generate their own mock service.

Goals

Replace the static endpoint with a clear, descriptive placeholder (<YOUR_GENERATED_MOCKY_ID>) so users know to use their own unique generated resource.

Approach

Updated en/docs/get-started/api-manager-quick-start-guide.md to use the placeholder format inside the REST API configuration table.

Learning

Learned the end-to-end open-source contribution workflow, including forking repositories, utilizing the GitHub web-based editor and submitting pull requests. Gained experience in navigating and auditing documentation to resolve configuration discrepancies.

Replaced the static, hardcoded Mocky endpoint with a descriptive placeholder in the Quick Start Guide to improve clarity for users.
@CLAassistant

CLAassistant commented Jun 12, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This change updates the API Manager quick start guide to improve usability by replacing a hard-coded Mocky endpoint URL with a template placeholder. Line 121 of api-manager-quick-start-guide.md is modified to use https://run.mocky.io/v3/<YOUR_GENERATED_MOCKY_ID> instead of a specific hard-coded Mocky link. This guides users to generate their own Mocky ID and insert it into the URL, rather than relying on a potentially unavailable or stale endpoint.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description addresses the core sections of the template but lacks comprehensive coverage of several required sections. Complete missing sections: Release note (brief summary for release notes), Documentation (link or confirmation of doc impact), Training, Certification, Marketing, Automation tests, Security checks, and Test environment details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: replacing a hardcoded Mocky URL with a placeholder in the quick start guide.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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/get-started/api-manager-quick-start-guide.md`:
- Line 121: Escape the angle brackets around the placeholder inside the code
element so it renders literally; replace the current snippet
<code>https://run.mocky.io/v3/<YOUR_GENERATED_MOCKY_ID></code> with the
placeholder using HTML escapes for the brackets (e.g.
&lt;YOUR_GENERATED_MOCKY_ID&gt;) so the renderer does not treat it as an HTML
tag.
🪄 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: d43c4a3c-0138-4db1-bb9d-0d9e7e0e31f5

📥 Commits

Reviewing files that changed from the base of the PR and between 5642000 and 26e93bd.

📒 Files selected for processing (1)
  • en/docs/get-started/api-manager-quick-start-guide.md

Comment thread en/docs/get-started/api-manager-quick-start-guide.md Outdated
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