Skip to content

Update build-gateway-with-custom-policies.md.#350

Open
VirajSalaka wants to merge 1 commit into
mainfrom
VirajSalaka-patch-1
Open

Update build-gateway-with-custom-policies.md.#350
VirajSalaka wants to merge 1 commit into
mainfrom
VirajSalaka-patch-1

Conversation

@VirajSalaka

Copy link
Copy Markdown

ap --version does not work
ap version is the correct command.

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Checklist

  • Verified that llms.txt (located at en/docs/llms.txt) is updated for AI readiness content.
  • Ensured meaningful alt text for images and that the information contained in an image also appears in text so the relevant info exists in the body of the document.
  • Added or updated frontmatter for the respective pages.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

ap --version does not work
ap version is the correct command.
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Updated the macOS/Linux AP CLI installation instructions to use the correct ap version verification command.

Walkthrough

The macOS/Linux “Verify the installation” step in the AP CLI documentation now uses ap version instead of ap --version.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The template is present, but the sections are not filled in beyond a brief note, so it lacks the required purpose, goals, and other details. Fill in the required sections with concrete details, including purpose, goals, approach, release note, docs, tests, and related links.
Title check ❓ Inconclusive The title names the file but does not describe the actual change, so it is too generic to convey the main update. Use a specific title such as “Fix AP CLI version command in build-gateway-with-custom-policies.md”.
✅ Passed checks (3 passed)
Check name Status Explanation
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
  • Commit unit tests in branch VirajSalaka-patch-1

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

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/cloud/api-platform-gateway/build-gateway-with-custom-policies.md`:
- Line 56: Update the version-check command in
build-gateway-with-custom-policies.md to use the same syntax as the matching
guides, replacing ap version with ap --version unless ap version is explicitly
the intended command; if retaining ap version, update all remaining
version-check occurrences consistently.
🪄 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: 98240500-b382-40af-83c3-2cbfffe3a685

📥 Commits

Reviewing files that changed from the base of the PR and between 8bf43b4 and 9e617f2.

📒 Files selected for processing (1)
  • en/docs/cloud/api-platform-gateway/build-gateway-with-custom-policies.md


```bash
ap --version
ap version

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

set -euo pipefail

printf '\n## Target file\n'
sed -n '45,70p' en/docs/cloud/api-platform-gateway/build-gateway-with-custom-policies.md

printf '\n## Related guide\n'
sed -n '1,120p' en/docs/api-gateway/next/policies/custom-policies/building-gateway-with-custom-policies.md

printf '\n## Search for version command variants\n'
rg -n --no-heading -S 'ap --version|ap version' en/docs | sed -n '1,200p'

Repository: wso2/docs-api-platform

Length of output: 5103


🏁 Script executed:

set -euo pipefail

printf '\nTarget file excerpt:\n'
nl -ba en/docs/cloud/api-platform-gateway/build-gateway-with-custom-policies.md | sed -n '50,62p'

printf '\nRelated guide excerpt:\n'
nl -ba en/docs/api-gateway/next/policies/custom-policies/building-gateway-with-custom-policies.md | sed -n '50,70p'

printf '\nAll occurrences:\n'
rg -n --no-heading -S 'ap --version|ap version' en/docs

Repository: wso2/docs-api-platform

Length of output: 222


Keep the version-check command consistent. This page mixes ap version and ap --version, and the matching guides still use ap --version. If ap version is the intended syntax, update the remaining occurrences as well.

🤖 Prompt for 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.

In `@en/docs/cloud/api-platform-gateway/build-gateway-with-custom-policies.md` at
line 56, Update the version-check command in
build-gateway-with-custom-policies.md to use the same syntax as the matching
guides, replacing ap version with ap --version unless ap version is explicitly
the intended command; if retaining ap version, update all remaining
version-check occurrences consistently.

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