Merge pull request #5761 from Thisara-Welmilla/add-action-versioning-docs-asgardeo-1

Add action versioning documentation for Asgardeo

Author: Thisara-Welmilla

en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api-contract.md

@@ -2,7 +2,7 @@ openapi: 3.0.1
 info:
   title: API contract for pre-issue access token action
   description: This API defines the REST API contract for a service that implements logic to extend the access token issuance flow of Asgardeo.
-  version: v1
+  version: v1.0
 security:
 - BasicAuth: []
 - BearerAuth: []
@@ -77,8 +77,6 @@ components:
           $ref: '#/components/schemas/Request'
         tenant:
           $ref: '#/components/schemas/Tenant'
-        organization:
-          $ref: '#/components/schemas/IssuerOrganization'
         user:
           $ref: '#/components/schemas/User'
         userStore:
@@ -139,53 +137,16 @@ components:
           example: 
             bar.com
       description: This property represents the tenant under which the token request is being processed. 
-    IssuerOrganization:
-      type: object
-      required:
-        - id
-        - name
-      properties:
-        id:
-          type: string
-          description: The unique identifier of the organization.
-          example:
-            f14962ba-e198-4261-88dd-ea0e25121f83
-        name:
-          type: string
-          description: The name of the organization.
-          example:
-            bar.com
-      description: This property represents the organization which is issuing the access token.
     User:
       type: object
       required:
         - id
-        - organization
       properties:
         id:
           type: string
           description: Defines the unique identifier of the user.
           example: e204849c-4ec2-41f1-8ff7-ec1ebff02821
-        organization:
-          $ref: '#/components/schemas/UserOrganization'
       description: Contains information about the authenticated user associated with the token request.
-    UserOrganization:
-      type: object
-      required:
-        - id
-        - name
-      properties:
-        id:
-          type: string
-          description: The unique identifier of the organization.
-          example:
-            f14962ba-e198-4261-88dd-ea0e25121f83
-        name:
-          type: string
-          description: The name of the organization.
-          example:
-            bar.com
-      description: This property represents the organization in which the user has been authenticated.
     UserStore:
       type: object
       required:
@@ -209,7 +170,7 @@ components:
       properties:
         tokenType:
           type: string
-          example: HASH
+          example: JWT
           enum:
             - JWT
           description: Defines the type of token.

…pi/pre-issue-access-token-action-v1.yaml …/pre-issue-access-token-action-v1.0.yamlen/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.yaml renamed to en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.0.yaml en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.yaml renamed to en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.0.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.1
 info:
   title: API contract for pre-issue access token action
   description: This API defines the REST API contract for a service that implements logic to extend the access token issuance flow of WSO2 Identity Server.
-  version: v1
+  version: v1.1
   contact:
     name: WSO2
     url: 'https://wso2.com/identity-server/'
@@ -91,6 +91,8 @@ components:
           $ref: '#/components/schemas/Request'
         tenant:
           $ref: '#/components/schemas/Tenant'
+        organization:
+          $ref: "#/components/schemas/Organization"
         user:
           $ref: '#/components/schemas/User'
         userStore:
@@ -152,7 +154,28 @@ components:
           description: The domain name of the tenant.
           example: 
             bar.com
-      description: This property represents the tenant under which the token request is being processed. 
+      description: This property represents the tenant under which the token request is being processed.
+    Organization:
+      type: object
+      required:
+        - id
+        - name
+        - orgHandle
+        - depth
+      properties:
+        id:
+          type: string
+          example: eb1115f6-274f-4bb7-9b6d-d31f678e81f7
+        name:
+          type: string
+          example: Example
+        orgHandle:
+          type: string
+          example: example.com
+        depth:
+          type: integer
+          example: 0
+      description: This property represents the organization context.
     User:
       type: object
       required:
@@ -162,6 +185,8 @@ components:
           type: string
           description: Defines the unique identifier of the user.
           example: e204849c-4ec2-41f1-8ff7-ec1ebff02821
+        organization:
+          $ref: "#/components/schemas/Organization"
       description: Contains information about the authenticated user associated with the token request.
     UserStore:
       type: object

…pi/pre-issue-access-token-action-v1.yaml …/pre-issue-access-token-action-v1.1.yamlen/identity-server/next/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.yaml renamed to en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.1.yaml en/identity-server/next/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.yaml renamed to en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.1.yaml

@@ -0,0 +1,5 @@
+---
+template: templates/redoc.html
+---
+
+<redoc id="pre-issue-access-token-v1.0" spec-url="{{base_path}}/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.0.yaml" theme='{{redoc_theme}}'></redoc>

en/asgardeo/docs/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/pre-issue-access-token-action-v1.0.md

@@ -0,0 +1,5 @@
+---
+template: templates/redoc.html
+---
+
+<redoc id="pre-issue-access-token-v1.1" spec-url="{{base_path}}/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api/pre-issue-access-token-action-v1.1.yaml" theme='{{redoc_theme}}'></redoc>