Add support for resources with mock implementations in API Products

[ashanhr]

Purpose

• Currently, API Products do not support resources with mock implementations. To enable this functionality, it is necessary to check for the availability of the mediation script in the api_product_template.xml.
• Resolves: Mock endpoints not working when used in API products api-manager#3436

Approach

• Syncing Mediation Scripts: The mediation script of the original API resource is not currently synced with the corresponding product resource (only when the original API endpoint type is INLINE). This has been fixed to ensure that mediation scripts are properly synced and can be accessed within the api_product_template.xml.
• Fixing Mediation Script Setting During Aggregation: Mediation scripts were not being set properly when aggregating resources based on the resource key. This issue has also been resolved in this PR.

[coderabbitai]

📝 Walkthrough

Walkthrough

The update modifies method signatures and internal logic for generating gateway API DTOs. The SynapseArtifactGenerator now includes an additional parameter (the API definition) in the call to the TemplateBuilderUtil.retrieveGatewayAPIDto method. Consequently, the TemplateBuilderUtil method has been updated to parse the API definition, retrieve URI templates, and update mediation scripts accordingly. Additionally, the ResourceConfigContext class has been enhanced to set mediation scripts alongside HTTP verbs when configuring URI templates.

Changes

File(s)	Change Summary
components/apimgt/.../SynapseArtifactGenerator.java components/apimgt/.../TemplateBuilderUtil.java	Updated method signature and call to include an additional parameter for the API definition. In SynapseArtifactGenerator, the call to retrieveGatewayAPIDto now passes openApiDefinition as a fifth parameter. In TemplateBuilderUtil, the method now parses the API definition, retrieves URI templates, and updates mediation scripts based on the API implementation type.
components/apimgt/.../template/ResourceConfigContext.java	Modified the getContext() method to replace the call that only set HTTP verbs with a call that sets both HTTP verbs and mediation scripts for the URI templates.

Sequence Diagram(s)

sequenceDiagram
    participant S as SynapseArtifactGenerator
    participant T as TemplateBuilderUtil
    participant P as APIDefinition Parser
    S->>T: Call retrieveGatewayAPIDto(apiProduct, environment, tenantDomain, extractedFolderPath, openApiDefinition)
    T->>P: Parse openApiDefinition to obtain URI templates
    P-->>T: Return URI templates
    T->>T: Update mediation scripts based on URI templates and API implementation type
    T-->>S: Return GatewayAPIDTO

Loading

sequenceDiagram
    participant R as ResourceConfigContext
    participant U as URITemplate
    R->>U: setMediationScripts(httpVerbs, mediationScript)

Loading

Possibly related PRs

• Fix migration issues with AI APIs #13030: The changes in the main PR and the retrieved PR both modify the TemplateBuilderUtil class, specifically the retrieveGatewayAPIDto method, but they address different aspects of the method's functionality, indicating they are related but not directly modifying the same logic.

Suggested reviewers

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

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e39ccda and 15f2fd7.

📒 Files selected for processing (3)

• components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/SynapseArtifactGenerator.java (1 hunks)
• components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/TemplateBuilderUtil.java (3 hunks)
• components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/template/ResourceConfigContext.java (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/template/ResourceConfigContext.java
• components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/SynapseArtifactGenerator.java
• components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/TemplateBuilderUtil.java

---

🪧 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 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.