Skip to content

Update sample apis and mcps - #3137

Open
Piumal1999 wants to merge 4 commits into
wso2:mainfrom
Piumal1999:samples-update
Open

Update sample apis and mcps#3137
Piumal1999 wants to merge 4 commits into
wso2:mainfrom
Piumal1999:samples-update

Conversation

@Piumal1999

Copy link
Copy Markdown
Contributor

Purpose

$subject
Updated the samples with apis/mcps publicly available as wso2 samples

Approach

Removed the previous ws and graphql samples and added new samples
Corrected the path in seed script

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Piumal1999, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 51 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 5400449f-44cb-4f8d-ba53-7b3c26fc533c

📥 Commits

Reviewing files that changed from the base of the PR and between 9f7d4bd and 1089d3b.

📒 Files selected for processing (32)
  • portals/api-portal/distribution/README.md
  • portals/api-portal/docs/administer/api-token-curl.md
  • portals/api-portal/docs/administer/design-mode.md
  • portals/api-portal/docs/administer/key-manager-integration.md
  • portals/api-portal/docs/administer/manage-organizations.md
  • portals/api-portal/docs/administer/manage-views.md
  • portals/api-portal/docs/administer/subscription-plans.md
  • portals/api-portal/docs/administer/webhook-integration.md
  • portals/api-portal/docs/introduction/quick-start.md
  • portals/api-portal/docs/publish-apis/api-content-and-docs.md
  • portals/api-portal/docs/publish-apis/manage-api-workflows.md
  • portals/api-portal/docs/publish-apis/publishing-apis.md
  • portals/api-portal/samples/apis/chat-service-api-v1.0/api.yaml
  • portals/api-portal/samples/apis/chat-service-api-v1.0/definition.yml
  • portals/api-portal/samples/apis/chat-service-api-v1.0/docs/getting-started.md
  • portals/api-portal/samples/apis/countries-api-v1.0/api.yaml
  • portals/api-portal/samples/apis/countries-api-v1.0/definition.graphql
  • portals/api-portal/samples/apis/countries-api-v1.0/docs/getting-started.md
  • portals/api-portal/samples/apis/countries-graphql-v1.0/api.yaml
  • portals/api-portal/samples/apis/countries-graphql-v1.0/definition.graphql
  • portals/api-portal/samples/apis/countries-graphql-v1.0/docs/getting-started.md
  • portals/api-portal/samples/apis/navigation-ws-v1.0/api.yaml
  • portals/api-portal/samples/apis/navigation-ws-v1.0/definition.yml
  • portals/api-portal/samples/apis/navigation-ws-v1.0/docs/getting-started.md
  • portals/api-portal/samples/mcps/everything-mcp-server-v1.0/api.yaml
  • portals/api-portal/samples/mcps/everything-mcp-server-v1.0/definition.yaml
  • portals/api-portal/samples/mcps/everything-mcp-server-v1.0/docs/getting-started.md
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/api.yaml
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/definition.yaml
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/docs/getting-started.md
  • portals/api-portal/scripts/seed-samples.ps1
  • portals/api-portal/scripts/seed-samples.sh
📝 Walkthrough

Walkthrough

The change updates API Portal documentation and sample-seeding scripts to use the /api-portal path. It adds Chat Service, Countries, and Everything MCP Server samples and removes older Countries GraphQL, Navigation WebSocket, and Travel Assistant MCP samples.

Changes

API Portal paths and documentation

Layer / File(s) Summary
Portal access and Design Mode documentation
portals/api-portal/distribution/README.md, portals/api-portal/docs/introduction/quick-start.md, portals/api-portal/docs/administer/design-mode.md
Portal URLs, Design Mode endpoints, and MCP sample references use the updated paths and names.
Administration API examples
portals/api-portal/docs/administer/*.md
Administration examples use /api-portal/api/v0.9 endpoints.
API publishing documentation
portals/api-portal/docs/publish-apis/*.md
Publishing examples use /api-portal-prefixed endpoints.

API and MCP samples

Layer / File(s) Summary
WebSocket and GraphQL samples
portals/api-portal/samples/apis/chat-service-api-v1.0/*, portals/api-portal/samples/apis/countries-api-v1.0/*
Adds published Chat Service and Countries API definitions with usage documentation.
Everything MCP Server sample
portals/api-portal/samples/mcps/mcp-everything-server-v1.0/*
Adds MCP metadata, tools, resources, prompts, and getting-started documentation.
Sample seeding path updates
portals/api-portal/scripts/seed-samples.*
Centralizes the API Portal REST base path for resource creation and documentation uploads.

Estimated code review effort: 3 (Moderate) | ~30 minutes

Possibly related PRs

Suggested reviewers: lasanthas, virajsalaka, renuka-fernando

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states the purpose and approach but omits most required sections, including goals, tests, security checks, documentation, and test environment. Complete the required template sections and provide details for goals, user stories, documentation, tests, security checks, samples, related PRs, and test environment.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the primary change: updating sample APIs and MCPs.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 `@portals/api-portal/docs/publish-apis/publishing-apis.md`:
- Around line 125-128: Update the MCP publishing example’s explanatory text and
curl command to consistently reference definition.yaml instead of
schemaDefinition.yaml, including the -F definition upload argument, while
leaving the metadata upload unchanged.

In `@portals/api-portal/samples/apis/chat-service-api-v1.0/definition.yml`:
- Around line 34-44: Update
portals/api-portal/samples/apis/chat-service-api-v1.0/definition.yml lines 34-44
to require both payload properties, type and message, when every frame must
include them; then update
portals/api-portal/samples/apis/chat-service-api-v1.0/docs/getting-started.md
lines 18-23 to accurately describe that required schema.
🪄 Autofix

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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0fa9ea85-2340-4d2d-98c6-99bab7734226

📥 Commits

Reviewing files that changed from the base of the PR and between 9f7d4bd and eded987.

📒 Files selected for processing (32)
  • portals/api-portal/distribution/README.md
  • portals/api-portal/docs/administer/api-token-curl.md
  • portals/api-portal/docs/administer/design-mode.md
  • portals/api-portal/docs/administer/key-manager-integration.md
  • portals/api-portal/docs/administer/manage-organizations.md
  • portals/api-portal/docs/administer/manage-views.md
  • portals/api-portal/docs/administer/subscription-plans.md
  • portals/api-portal/docs/administer/webhook-integration.md
  • portals/api-portal/docs/introduction/quick-start.md
  • portals/api-portal/docs/publish-apis/api-content-and-docs.md
  • portals/api-portal/docs/publish-apis/manage-api-workflows.md
  • portals/api-portal/docs/publish-apis/publishing-apis.md
  • portals/api-portal/samples/apis/chat-service-api-v1.0/api.yaml
  • portals/api-portal/samples/apis/chat-service-api-v1.0/definition.yml
  • portals/api-portal/samples/apis/chat-service-api-v1.0/docs/getting-started.md
  • portals/api-portal/samples/apis/countries-api-v1.0/api.yaml
  • portals/api-portal/samples/apis/countries-api-v1.0/definition.graphql
  • portals/api-portal/samples/apis/countries-api-v1.0/docs/getting-started.md
  • portals/api-portal/samples/apis/countries-graphql-v1.0/api.yaml
  • portals/api-portal/samples/apis/countries-graphql-v1.0/definition.graphql
  • portals/api-portal/samples/apis/countries-graphql-v1.0/docs/getting-started.md
  • portals/api-portal/samples/apis/navigation-ws-v1.0/api.yaml
  • portals/api-portal/samples/apis/navigation-ws-v1.0/definition.yml
  • portals/api-portal/samples/apis/navigation-ws-v1.0/docs/getting-started.md
  • portals/api-portal/samples/mcps/mcp-everything-server-v1.0/api.yaml
  • portals/api-portal/samples/mcps/mcp-everything-server-v1.0/definition.yaml
  • portals/api-portal/samples/mcps/mcp-everything-server-v1.0/docs/getting-started.md
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/api.yaml
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/definition.yaml
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/docs/getting-started.md
  • portals/api-portal/scripts/seed-samples.ps1
  • portals/api-portal/scripts/seed-samples.sh
💤 Files with no reviewable changes (9)
  • portals/api-portal/samples/apis/countries-graphql-v1.0/docs/getting-started.md
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/docs/getting-started.md
  • portals/api-portal/samples/apis/navigation-ws-v1.0/docs/getting-started.md
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/api.yaml
  • portals/api-portal/samples/apis/countries-graphql-v1.0/api.yaml
  • portals/api-portal/samples/apis/navigation-ws-v1.0/api.yaml
  • portals/api-portal/samples/apis/countries-graphql-v1.0/definition.graphql
  • portals/api-portal/samples/mcps/travel-assistant-mcp-v1/definition.yaml
  • portals/api-portal/samples/apis/navigation-ws-v1.0/definition.yml

Comment thread portals/api-portal/docs/publish-apis/publishing-apis.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.

1 participant