Skip to content

[Devportal] Update quick start and other docs - #2756

Merged
lasanthaS merged 3 commits into
wso2:mainfrom
Piumal1999:main
Jul 20, 2026
Merged

[Devportal] Update quick start and other docs#2756
lasanthaS merged 3 commits into
wso2:mainfrom
Piumal1999:main

Conversation

@Piumal1999

Copy link
Copy Markdown
Contributor

Purpose

Update quick start guide and other docs

Goals

Preparing for the release

Approach

Updated the docs
Included details about setup script

…eld names

- Replace the config-file copy step with ./scripts/setup.sh, which generates
  certs, secrets, config-platform-api.toml, and prompts for admin credentials
- Drop hardcoded admin/admin login credentials across docs; reference the
  credentials set during setup instead
- Fix API create/update multipart field names to match the handler and spec:
  api -> metadata, apiDefinition/schemaDefinition -> definition,
  apiMetadata -> metadata (was causing "Missing or invalid fields in the
  request payload")
Document ./scripts/seed-samples.sh as an optional step: how to run it,
its credential prompt, prerequisites (curl/jq/zip, running portal), and
URL overrides. Reword the catalog note to point at it.
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 59208172-abb1-46fc-86ab-0ed6679793b8

📥 Commits

Reviewing files that changed from the base of the PR and between 7969135 and d9c8749.

📒 Files selected for processing (19)
  • portals/developer-portal/README.md
  • portals/developer-portal/docs/administer/design-mode.md
  • portals/developer-portal/docs/administer/key-manager-integration.md
  • portals/developer-portal/docs/administer/manage-organizations.md
  • portals/developer-portal/docs/administer/manage-views.md
  • portals/developer-portal/docs/administer/subscription-plans.md
  • portals/developer-portal/docs/introduction/quick-start.md
  • portals/developer-portal/docs/publish-apis/api-content-and-docs.md
  • portals/developer-portal/docs/publish-apis/manage-api-workflows.md
  • portals/developer-portal/docs/publish-apis/publishing-apis.md
  • portals/developer-portal/samples/apis/booking-api/api.yaml
  • portals/developer-portal/samples/apis/catalog-api/api.yaml
  • portals/developer-portal/samples/apis/countries-graphql-v1.0/api.yaml
  • portals/developer-portal/samples/apis/navigation-ws-v1.0/api.yaml
  • portals/developer-portal/samples/apis/ping-api/api.yaml
  • portals/developer-portal/samples/apis/swagger-petstore-v1.0.7/api.yaml
  • portals/developer-portal/samples/applications.yaml
  • portals/developer-portal/samples/mcps/travel-assistant-mcp-v1/api.yaml
  • tests/integration-e2e/steps_devportal_test.go

📝 Walkthrough

Walkthrough

Updated Developer Portal documentation, tutorials, sample manifests, and integration fixtures to use v1alpha2, parameterized credentials, the setup.sh workflow, and revised multipart upload field names.

Changes

Developer Portal contract and setup alignment

Layer / File(s) Summary
Quick-start setup and publishing flow
portals/developer-portal/docs/introduction/quick-start.md
Documents setup.sh, sample seeding, configured credentials, and metadata/definition upload fields.
Publishing contract examples and validation
portals/developer-portal/README.md, portals/developer-portal/docs/publish-apis/*, tests/integration-e2e/steps_devportal_test.go
Updates publishing examples and generated fixtures to use v1alpha2 manifests, parameterized credentials, and revised multipart names.
Administrator guide examples
portals/developer-portal/docs/administer/*
Updates administrator authentication examples, manifest versions, and Local Auth setup instructions.
Bundled sample manifest versions
portals/developer-portal/samples/apis/*, portals/developer-portal/samples/mcps/*, portals/developer-portal/samples/applications.yaml
Changes bundled sample manifests from v1alpha1 to v1alpha2.

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

Possibly related PRs

  • wso2/api-platform#2660: Related updates to Devportal publishing contracts, multipart fields, and manifest schema expectations.

Suggested reviewers: renuka-fernando, chamilaadhi, ashera96

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description only covers Purpose, Goals, and Approach; most required template sections are missing or too sparse. Add the missing sections: User stories, Documentation, Automation tests, Security checks, Samples, Related PRs, and Test environment.
Title check ❓ Inconclusive The title is related to the docs update, but it's too generic to identify the main change. Make it more specific, e.g. mention the quick-start setup flow, credential changes, and API version updates.
✅ Passed checks (3 passed)
Check name Status Explanation
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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

level=error msg="[linters_context] typechecking error: pattern ./...: directory prefix . does not contain modules listed in go.work or their selected dependencies"


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.

@lasanthaS
lasanthaS merged commit 981d87b into wso2:main Jul 20, 2026
9 checks passed
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