Merge pull request #4737 from ashanthamara/actions

Update the action management APIs with new action retrieval by action id API.
wso2 · Sep 6, 2024 · 8dd49f9 · 8dd49f9
2 parents 5e5be2b + 738d8ec
commit 8dd49f9
Show file tree

Hide file tree

Showing 2 changed files with 208 additions and 0 deletions.
diff --git a/en/asgardeo/docs/apis/restapis/actions.yaml b/en/asgardeo/docs/apis/restapis/actions.yaml
@@ -88,6 +88,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -148,13 +154,81 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
             curl --location 'https://api.asgardeo.io/t/{organization-name}/api/server/v1/actions/{actionType}' \
             -H 'Authorization: Bearer {bearer_token}'
 
   /actions/{actionType}/{actionId}:
+    get:
+      tags:
+        - Actions Endpoint
+      operationId: getActionByActionId
+      summary: Retrieve Action by ID
+      description: "This API provides the capability to retrieve the action by action Id. \n\n
+        <b>Scope (Permission) required:</b> ``internal_action_mgt_view``\n\n"
+      parameters:
+        - name: actionType
+          in: path
+          description: Name of the Action Type.
+          required: true
+          schema:
+            enum:
+              - preIssueAccessToken
+        - name: actionId
+          in: path
+          description: Unique identifier of the action.
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Action is found for the given action type and id.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ActionResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      x-codeSamples:
+        - lang: Curl
+          source: |
+            curl --location 'https://api.asgardeo.io/t/{organization-name}/api/server/v1/actions/{actionType}/{actionId}' \
+            -H 'Authorization: Bearer {bearer_token}'
+                
     patch:
       tags:
         - Actions Endpoint
@@ -212,6 +286,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -282,6 +362,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -339,6 +425,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -396,6 +488,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -470,6 +568,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl(Bearer)
           source: |

diff --git a/en/identity-server/next/docs/apis/restapis/actions.yaml b/en/identity-server/next/docs/apis/restapis/actions.yaml
@@ -93,6 +93,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -153,13 +159,81 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
             curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}' \
             -H 'Authorization: Basic YWRtaW46YWRtaW4='
 
   /actions/{actionType}/{actionId}:
+    get:
+      tags:
+        - Actions Endpoint
+      operationId: getActionByActionId
+      summary: Retrieve Action by ID
+      description: "This API provides the capability to retrieve the action by action Id. \n\n
+        <b>Scope (Permission) required:</b> ``internal_action_mgt_view``\n\n"
+      parameters:
+        - name: actionType
+          in: path
+          description: Name of the Action Type.
+          required: true
+          schema:
+            enum:
+              - preIssueAccessToken
+        - name: actionId
+          in: path
+          description: Unique identifier of the action.
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Action is found for the given action type and id.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ActionResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      x-codeSamples:
+        - lang: Curl
+          source: |
+            curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}' \
+            -H 'Authorization: Basic YWRtaW46YWRtaW4='
+                
     patch:
       tags:
         - Actions Endpoint
@@ -217,6 +291,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -287,6 +367,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -344,6 +430,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -401,6 +493,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl
           source: |
@@ -475,6 +573,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        '501':
+          description: Not Implemented
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
       x-codeSamples:
         - lang: Curl(Bearer)
           source: |