From fea9cddf74524f25bd078e09ddfb28c281a2a60e Mon Sep 17 00:00:00 2001
From: tzuge <47162374+tzuge@users.noreply.github.com>
Date: Thu, 30 Nov 2023 10:14:20 -0700
Subject: [PATCH] fix(tenant-management-api): correct the response body schema
 in API docs

Also making correction to comment service pages docs.
---
 .../src/tenant/router/tenant.swagger.yml       | 18 +++++++++++++++---
 docs/services/comment-service.md               |  2 +-
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/apps/tenant-management-api/src/tenant/router/tenant.swagger.yml b/apps/tenant-management-api/src/tenant/router/tenant.swagger.yml
index bcbd72713c..345eda8688 100644
--- a/apps/tenant-management-api/src/tenant/router/tenant.swagger.yml
+++ b/apps/tenant-management-api/src/tenant/router/tenant.swagger.yml
@@ -121,9 +121,21 @@ components:
         content:
           application/json:
             schema:
-              type: array
-              items:
-                $ref: "#/components/schemas/Tenant"
+              type: object
+              properties:
+                results:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/Tenant"
+                page:
+                  type: object
+                  properties:
+                    after:
+                      type: string
+                    next:
+                      type: string
+                    size:
+                      type: number
       401:
         description: Unauthorized
   post:
diff --git a/docs/services/comment-service.md b/docs/services/comment-service.md
index 49b1e07636..53504165ad 100644
--- a/docs/services/comment-service.md
+++ b/docs/services/comment-service.md
@@ -8,7 +8,7 @@ parent: Services
 # Comment service
 Comment service allows users to create topics and post comments against the topics. Topics are of a particular topic type, and the type determines the roles permitted to administer, read, or comment on a topic.
 
-Topics are intended an aggregate root for comments, and should be associated to an entity that is the subject of the comments. Topic includes a `recordId` property for referencing the associated entity. For example, in a case management use case, a topic references a case using the case ID, and comments regarding the case are children of that topic.
+A topic is intended to be an aggregate root for comments, and should be associated to an entity that is the subject of the comments. Topic includes a `resourceId` property for referencing the associated entity. For example, in a case management use case, a topic references a case using the case ID, and comments regarding the case are children of that topic.
 
 ## Client roles
 client `urn:ads:platform:comment-service`