Skip to content

Fix: Replace Mocky.io with WSO2 dev-tools endpoint in Quick Start Guide [master]#10680

Open
wso2-engineering-bot wants to merge 1 commit intomaster-backupfrom
fixing-issue-10676-master-1770632991
Open

Fix: Replace Mocky.io with WSO2 dev-tools endpoint in Quick Start Guide [master]#10680
wso2-engineering-bot wants to merge 1 commit intomaster-backupfrom
fixing-issue-10676-master-1770632991

Conversation

@wso2-engineering-bot
Copy link
Contributor

@wso2-engineering-bot wso2-engineering-bot commented Feb 9, 2026

This PR was automatically generated by Claude AI.

Summary by CodeRabbit

  • Documentation
    • Updated the API Manager quick-start guide with a revised API creation workflow
    • Refreshed example configurations, endpoints, and API response samples throughout the guide

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

Walkthrough

This documentation update replaces a mock-service-based REST API creation workflow with a direct REST API creation approach in the API Manager quick-start guide. The example API metadata is updated, including renaming from HelloWorld to RandomUUID with corresponding endpoint and response payload changes throughout the guide.

Changes

Cohort / File(s) Summary
Documentation Update
en/docs/get-started/api-manager-quick-start-guide.md
Restructured REST API creation flow to bypass mock-service approach. Updated example API metadata (name: HelloWorld → RandomUUID, context: /hello → /uuid, endpoint URL changed). Modified step numbering and sequencing. Refreshed narrative references, developer portal examples, and API invocation output payload throughout the guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hoppily we bounce to UUID's call,
No mock-services needed at all!
Direct paths now lead us true,
Simpler steps, a clearer view.
RandomUUID hops in with grace. 🎲✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete. While it references the issue and provides a summary, it omits most required template sections including Goals, Approach, User stories, Release notes, Documentation, Training, Certification, Marketing, Tests, Security checks, and others. Complete the PR description by filling out all required template sections: Goals, Approach, User stories, Release note, Documentation, Training, Certification, Marketing, Automation tests, Security checks, and other applicable sections.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically identifies the main change: replacing Mocky.io with WSO2 dev-tools endpoint in the Quick Start Guide, matching the core objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fixing-issue-10676-master-1770632991

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@en/docs/get-started/api-manager-quick-start-guide.md`:
- Line 130: Fix the double space in the sentence within the API overview step:
locate the sentence "Once you click on the RandomUUID API, you will be
redirected to  the API overview page. Then, go ahead and click on the **TRY
OUT** button." in en/docs/get-started/api-manager-quick-start-guide.md and
remove the extra space between "to" and "the" so it reads "redirected to the API
overview page." while keeping the rest of the sentence unchanged.
🧹 Nitpick comments (1)
en/docs/get-started/api-manager-quick-start-guide.md (1)

162-162: Tighten JSON example formatting.
Use standard JSON spacing to avoid confusion in copy/paste.

Proposed fix
-     You should see the `{"uuid" : "<random-uuid-here>"}` response from the API. 
+     You should see the `{"uuid":"<random-uuid-here>"}` response from the API.

2. Click **Sign-In** and enter **`admin/admin`** as your credentials to sign in to the Developer Portal.

3. Once you click on the HelloWorld API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.
3. Once you click on the RandomUUID API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix double space in sentence.
Minor typo in “to the”.

Proposed fix
-3. Once you click on the RandomUUID API, you will be redirected to  the API overview page. Then, go ahead and click on the **TRY OUT** button.
+3. Once you click on the RandomUUID API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
3. Once you click on the RandomUUID API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.
3. Once you click on the RandomUUID API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.
🤖 Prompt for AI Agents
In `@en/docs/get-started/api-manager-quick-start-guide.md` at line 130, Fix the
double space in the sentence within the API overview step: locate the sentence
"Once you click on the RandomUUID API, you will be redirected to  the API
overview page. Then, go ahead and click on the **TRY OUT** button." in
en/docs/get-started/api-manager-quick-start-guide.md and remove the extra space
between "to" and "the" so it reads "redirected to the API overview page." while
keeping the rest of the sentence unchanged.

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.

1 participant