Modify default rulesets. Remove unnecessary rules.

[Oshanath]

Fixes wso2/api-manager#3658

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the API guidelines rules by removing one rule and modifying two existing rules in the API management guidelines. In the management guidelines, the alphabetical tag sorting rule is removed, the throttling policy rule is reformatted and extended with new fields, and the security rule is restructured. Additionally, several server-related validation rules are removed from the REST API design guidelines. These changes adjust the static validation criteria without introducing new runtime control flows.

Changes

File Path	Change Summary
features/apimgt/.../wso2_api_management_guidelines.yaml	• Removed rule api-tags-alphabetical. • Updated api-no-unlimited-throttling-policy (added quotes in its description and severity; introduced given and then fields). • Restructured api-resources-security-required (changed field from throttlingPolicy to authType and modified its pattern function).
features/apimgt/.../wso2_rest_api_design_guidelines.yaml	• Removed multiple server-related rules: API_Server_URL, API_Server, api-servers, server-trailing-slash, server-lowercase, oas2-api-schemes, and server-not-example.

Suggested reviewers

• tgtshanika
• chamilaadhi
• tharindu1st
• dushaniw
• Arshardh
• AnuGayan

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83cefb5 and f986af5.

📒 Files selected for processing (2)

• features/apimgt/org.wso2.carbon.apimgt.governance.feature/src/main/resources/default-rulesets/wso2_api_management_guidelines.yaml (1 hunks)
• features/apimgt/org.wso2.carbon.apimgt.governance.feature/src/main/resources/default-rulesets/wso2_rest_api_design_guidelines.yaml (0 hunks)

💤 Files with no reviewable changes (1)

• features/apimgt/org.wso2.carbon.apimgt.governance.feature/src/main/resources/default-rulesets/wso2_rest_api_design_guidelines.yaml

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (2, group2)
• GitHub Check: build-product (1, group1)
• GitHub Check: build-carbon
• GitHub Check: run-benchmark-test

🔇 Additional comments (2)

features/apimgt/org.wso2.carbon.apimgt.governance.feature/src/main/resources/default-rulesets/wso2_api_management_guidelines.yaml (2)

290-299: Review the Updated Unlimited Throttling Policy Rule

The modified api-no-unlimited-throttling-policy rule now clearly validates that the API throttling policy does not exactly equal "Unlimited". The changes include:

• A reformulated description and message.
• Updating the severity to "warn", which appears aligned with a softer enforcement.
• Checking the $.data.apiThrottlingPolicy field against a regex pattern to ensure an exact match rejection.

These updates meet the PR objectives for streamlining rulesets. Please verify that all documentation and downstream validations expecting the previous structure have been updated accordingly.

---

300-310: Review the Updated Security Required Rule for API Resources

The api-resources-security-required rule has been restructured to enhance clarity and focus. Key changes include:

• Updating the description and message to reflect that every operation must have security enabled.
• Transitioning the check from a possibly legacy field to specifically evaluating the authType field.
• Using a regex pattern that ensures the value is not "None".

This update appears to align well with the intended security verification for API operations. It may be beneficial to double-check that the pattern check is case-sensitive as intended and that the authType field is universally defined in your API operations schema.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.