Add improvement to show in which revision the scoped resource is used

Author: msm1992

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java

@@ -16398,19 +16398,37 @@ public SharedScopeUsage getSharedScopeUsage(String uuid, int tenantId) throws AP
                     API usedApi = new API(apiIdentifier);
                     usedApi.setContext(apiUsageResultSet.getString("CONTEXT"));
 
+                    //in case the record is for an API revision set isRevision to true
+                    String revisionUuid = apiUsageResultSet.getString("REVISION_UUID");
+                    String GET_SHARED_SCOPE_URI_USAGE_BY_TENANT = SQLConstants.GET_SHARED_SCOPE_URI_USAGE_IN_CURRENT_APIS_BY_TENANT;
+                    if (StringUtils.isNotEmpty(revisionUuid)) {
+                        usedApi.setRevision(true);
+                        GET_SHARED_SCOPE_URI_USAGE_BY_TENANT = SQLConstants.GET_SHARED_SCOPE_URI_USAGE_IN_REVISIONS_BY_TENANT;
+                    }
+
                     try (PreparedStatement psForUriUsage = connection
-                            .prepareStatement(SQLConstants.GET_SHARED_SCOPE_URI_USAGE_BY_TENANT)) {
+                            .prepareStatement(GET_SHARED_SCOPE_URI_USAGE_BY_TENANT)) {
                         int apiId = apiUsageResultSet.getInt("API_ID");
                         Set<URITemplate> usedUriTemplates = new LinkedHashSet<>();
                         psForUriUsage.setString(1, uuid);
                         psForUriUsage.setInt(2, tenantId);
                         psForUriUsage.setInt(3, apiId);
+
+                        if (usedApi.isRevision()) {
+                            psForUriUsage.setString(4, revisionUuid);
+                        }
+
                         try (ResultSet uriUsageResultSet = psForUriUsage.executeQuery()) {
                             while (uriUsageResultSet.next()) {
                                 URITemplate usedUriTemplate = new URITemplate();
                                 usedUriTemplate.setUriTemplate(uriUsageResultSet.getString("URL_PATTERN"));
                                 usedUriTemplate.setHTTPVerb(uriUsageResultSet.getString("HTTP_METHOD"));
                                 usedUriTemplates.add(usedUriTemplate);
+
+                                if (usedApi.isRevision()) {
+                                    APIRevision revision = getRevisionByRevisionUUID(connection, revisionUuid);
+                                    usedApi.setRevisionId(revision.getId());
+                                }
                             }
                         }
                         usedApi.setUriTemplates(usedUriTemplates);

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/constants/SQLConstants.java

@@ -3522,17 +3522,28 @@ public static class RevokedJWTConstants {
                     + "FROM AM_SHARED_SCOPE SS "
                     + "WHERE SS.TENANT_ID = ?";
     public static final String GET_SHARED_SCOPE_API_USAGE_BY_TENANT =
-            "SELECT AA.API_ID, AA.API_NAME, AA.CONTEXT, AA.API_VERSION, AA.API_PROVIDER "
+            "SELECT AA.API_ID, AA.API_NAME, AA.CONTEXT, AA.API_VERSION, AA.API_PROVIDER, AAUM.REVISION_UUID  "
                     + "FROM AM_SHARED_SCOPE ASSC, AM_API_RESOURCE_SCOPE_MAPPING AARSM, "
                     + "AM_API_URL_MAPPING AAUM, AM_API AA "
                     + "WHERE ASSC.NAME=AARSM.SCOPE_NAME AND "
                     + "AARSM.URL_MAPPING_ID=AAUM.URL_MAPPING_ID AND "
-                    + "AAUM.API_ID=AA.API_ID AND AAUM.REVISION_UUID IS NULL AND "
+                    + "AAUM.API_ID=AA.API_ID AND "
                     + "ASSC.UUID=? AND "
                     + "AARSM.TENANT_ID=? "
-                    + "GROUP BY AA.API_ID, AA.API_NAME, AA.CONTEXT, AA.API_VERSION, AA.API_PROVIDER";
+                    + "GROUP BY AA.API_ID, AA.API_NAME, AA.CONTEXT, AA.API_VERSION, AA.API_PROVIDER, AAUM.REVISION_UUID";
+
+    public static final String GET_SHARED_SCOPE_URI_USAGE_IN_REVISIONS_BY_TENANT =
+            "SELECT AAUM.URL_PATTERN, AAUM.HTTP_METHOD "
+                    + "FROM AM_SHARED_SCOPE ASSC, AM_API_RESOURCE_SCOPE_MAPPING AARSM, "
+                    + "AM_API_URL_MAPPING AAUM, AM_API AA "
+                    + "WHERE ASSC.NAME=AARSM.SCOPE_NAME AND "
+                    + "AARSM.URL_MAPPING_ID=AAUM.URL_MAPPING_ID AND "
+                    + "AAUM.API_ID=AA.API_ID AND "
+                    + "ASSC.UUID=? AND "
+                    + "AARSM.TENANT_ID=? AND "
+                    + "AA.API_ID=? AND AAUM.REVISION_UUID=?";
 
-    public static final String GET_SHARED_SCOPE_URI_USAGE_BY_TENANT =
+    public static final String GET_SHARED_SCOPE_URI_USAGE_IN_CURRENT_APIS_BY_TENANT =
             "SELECT AAUM.URL_PATTERN, AAUM.HTTP_METHOD "
                     + "FROM AM_SHARED_SCOPE ASSC, AM_API_RESOURCE_SCOPE_MAPPING AARSM, "
                     + "AM_API_URL_MAPPING AAUM, AM_API AA "

components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/publisher-api.yaml

@@ -11097,6 +11097,9 @@ components:
           description: |
             If the provider value is not given user invoking the api will be used as the provider.
           example: admin
+        revisionID:
+          type: string
+          example: Revision 1
         usedResourceList:
           type: array
           description: |

components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/gen/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/dto/SharedScopeUsedAPIInfoDTO.java

@@ -27,6 +27,7 @@ public class SharedScopeUsedAPIInfoDTO   {
     private String context = null;
     private String version = null;
     private String provider = null;
+    private String revisionID = null;
     private List<SharedScopeUsedAPIResourceInfoDTO> usedResourceList = new ArrayList<SharedScopeUsedAPIResourceInfoDTO>();
 
   /**
@@ -101,6 +102,23 @@ public void setProvider(String provider) {
     this.provider = provider;
   }
 
+  /**
+   **/
+  public SharedScopeUsedAPIInfoDTO revisionID(String revisionID) {
+    this.revisionID = revisionID;
+    return this;
+  }
+
+  
+  @ApiModelProperty(example = "Revision 1", value = "")
+  @JsonProperty("revisionID")
+  public String getRevisionID() {
+    return revisionID;
+  }
+  public void setRevisionID(String revisionID) {
+    this.revisionID = revisionID;
+  }
+
   /**
    * Resource list which have used the shared scope within this API 
    **/
@@ -134,12 +152,13 @@ public boolean equals(java.lang.Object o) {
         Objects.equals(context, sharedScopeUsedAPIInfo.context) &&
         Objects.equals(version, sharedScopeUsedAPIInfo.version) &&
         Objects.equals(provider, sharedScopeUsedAPIInfo.provider) &&
+        Objects.equals(revisionID, sharedScopeUsedAPIInfo.revisionID) &&
         Objects.equals(usedResourceList, sharedScopeUsedAPIInfo.usedResourceList);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(name, context, version, provider, usedResourceList);
+    return Objects.hash(name, context, version, provider, revisionID, usedResourceList);
   }
 
   @Override
@@ -151,6 +170,7 @@ public String toString() {
     sb.append("    context: ").append(toIndentedString(context)).append("\n");
     sb.append("    version: ").append(toIndentedString(version)).append("\n");
     sb.append("    provider: ").append(toIndentedString(provider)).append("\n");
+    sb.append("    revisionID: ").append(toIndentedString(revisionID)).append("\n");
     sb.append("    usedResourceList: ").append(toIndentedString(usedResourceList)).append("\n");
     sb.append("}");
     return sb.toString();

components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/mappings/SharedScopeMappingUtil.java

@@ -75,6 +75,9 @@ public static SharedScopeUsageDTO fromSharedScopeUsageToDTO(SharedScopeUsage sha
             usedAPIInfoDTO.setProvider(apiIdentifier.getProviderName());
             usedAPIInfoDTO.setContext(api.getContext());
 
+            String revisionName = api.getRevisionId() != 0 ? "Revision " + api.getRevisionId() : "Current API";
+            usedAPIInfoDTO.setRevisionID(revisionName);
+
             List<SharedScopeUsedAPIResourceInfoDTO> usedAPIResourceInfoDTOList = new ArrayList<>();
             for (URITemplate uriTemplate : api.getUriTemplates()) {
                 SharedScopeUsedAPIResourceInfoDTO usedAPIResourceInfoDTO = new SharedScopeUsedAPIResourceInfoDTO();

components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1/src/main/resources/publisher-api.yaml

@@ -11097,6 +11097,9 @@ components:
           description: |
             If the provider value is not given user invoking the api will be used as the provider.
           example: admin
+        revisionID:
+          type: string
+          example: Revision 1
         usedResourceList:
           type: array
           description: |