Merge pull request #5107 from HasiniSama/application-management-api

Fix example filter value to match the filtering capability of the /scopes API
wso2 · Feb 24, 2025 · c6f5547 · c6f5547
2 parents 9c9c691 + 9cca0dd
commit c6f5547
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 5 deletions.
diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/api-resources.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/api-resources.yaml
@@ -137,7 +137,7 @@ paths:
 
         <b>Scope(Permission) required:</b> `internal_org_api_resource_view`
       parameters:
-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/scopeFilter'
       responses:
         200:
           description: OK
@@ -252,6 +252,16 @@ components:
         type: string
       example: identifier+eq+greetings
 
+    scopeFilter:
+      name: filter
+      in: query
+      required: false
+      description: |
+        Condition to filter the retrieval of scopes by name. Supports 'sw', 'co', 'ew' and 'eq' operations.
+      schema:
+        type: string
+      example: name+co+greetings
+
     collectionFilter:
       name: filter
       in: query

diff --git a/en/asgardeo/docs/apis/restapis/api-resources.yaml b/en/asgardeo/docs/apis/restapis/api-resources.yaml
@@ -435,7 +435,7 @@ paths:
 
         <b>Scope(Permission) required:</b> `internal_api_resource_view`
       parameters:
-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/scopeFilter'
       responses:
         200:
           description: OK
@@ -620,6 +620,16 @@ components:
       schema:
         type: string
       example: identifier+eq+greetings
+
+    scopeFilter:
+      name: filter
+      in: query
+      required: false
+      description: |
+        Condition to filter the retrieval of scopes by name. Supports 'sw', 'co', 'ew' and 'eq' operations.
+      schema:
+        type: string
+      example: name+co+greetings
 
     collectionFilter:
       name: filter

diff --git a/en/identity-server/7.0.0/docs/apis/restapis/api-resources.yaml b/en/identity-server/7.0.0/docs/apis/restapis/api-resources.yaml
@@ -489,7 +489,7 @@ paths:
 
         <b>Scope(Permission) required:</b> `internal_api_resource_view`
       parameters:
-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/scopeFilter'
       responses:
         200:
           description: OK
@@ -674,6 +674,16 @@ components:
       schema:
         type: string
       example: identifier+eq+greetings
+
+    scopeFilter:
+      name: filter
+      in: query
+      required: false
+      description: |
+        Condition to filter the retrieval of scopes by name. Supports 'sw', 'co', 'ew' and 'eq' operations.
+      schema:
+        type: string
+      example: name+co+greetings
 
     collectionFilter:
       name: filter

diff --git a/en/identity-server/next/docs/apis/organization-apis/restapis/api-resources.yaml b/en/identity-server/next/docs/apis/organization-apis/restapis/api-resources.yaml
@@ -144,7 +144,7 @@ paths:
 
         <b>Scope(Permission) required:</b> `internal_org_api_resource_view`
       parameters:
-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/scopeFilter'
       responses:
         200:
           description: OK
@@ -259,6 +259,16 @@ components:
         type: string
       example: identifier+eq+greetings
 
+    scopeFilter:
+      name: filter
+      in: query
+      required: false
+      description: |
+        Condition to filter the retrieval of scopes by name. Supports 'sw', 'co', 'ew' and 'eq' operations.
+      schema:
+        type: string
+      example: name+co+greetings
+
     collectionFilter:
       name: filter
       in: query

diff --git a/en/identity-server/next/docs/apis/restapis/api-resources.yaml b/en/identity-server/next/docs/apis/restapis/api-resources.yaml
@@ -489,7 +489,7 @@ paths:
 
         <b>Scope(Permission) required:</b> `internal_api_resource_view`
       parameters:
-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/scopeFilter'
       responses:
         200:
           description: OK
@@ -675,6 +675,16 @@ components:
         type: string
       example: identifier+eq+greetings
 
+    scopeFilter:
+      name: filter
+      in: query
+      required: false
+      description: |
+        Condition to filter the retrieval of scopes by name. Supports 'sw', 'co', 'ew' and 'eq' operations.
+      schema:
+        type: string
+      example: name+co+greetings
+
     collectionFilter:
       name: filter
       in: query