Skip to content

Commit e585cca

Browse files
swapnil-cometchatswapnil-cometchat
authored
Merge pull request #109 from cometchat/docs/restapi-chatapi-agentic-list-conversations
Added hideAgentic and onlyAgentic to list conversations OAS
2 parents d90728f + bceff3c commit e585cca

File tree

3 files changed

+72
-43
lines changed

3 files changed

+72
-43
lines changed

‎chat-apis.json‎

Lines changed: 62 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1432,8 +1432,8 @@
14321432
"type": "object"
14331433
},
14341434
"example": {
1435-
"data": {
1436-
"0": {
1435+
"data": [
1436+
{
14371437
"guid": "project-group",
14381438
"name": "Project Group",
14391439
"description": "project related discussions between members",
@@ -1449,38 +1449,38 @@
14491449
"tags": [
14501450
"friends",
14511451
"project"
1452-
],
1453-
"0": {
1454-
"guid": "project-group-2",
1455-
"name": "Project Group 2",
1456-
"description": "project related discussions between members",
1457-
"icon": "http://placehold.it/120x120&text=image1",
1458-
"type": "public",
1459-
"scope": "admin",
1460-
"membersCount": 1,
1461-
"joinedAt": 1638440784,
1462-
"conversationId": "group_project-group",
1463-
"hasJoined": true,
1464-
"createdAt": 1638440784,
1465-
"owner": "superhero4",
1466-
"tags": [
1467-
"friends",
1468-
"project"
1469-
]
1470-
}
1452+
]
14711453
},
1472-
"meta": {
1473-
"pagination": {
1474-
"total": 0,
1475-
"count": 5,
1476-
"per_page": 100,
1477-
"current_page": 1,
1478-
"total_pages": 1
1479-
},
1480-
"cursor": {
1481-
"updatedAt": 1638354799,
1482-
"affix": "prepend"
1483-
}
1454+
{
1455+
"guid": "project-group-2",
1456+
"name": "Project Group 2",
1457+
"description": "project related discussions between members",
1458+
"icon": "http://placehold.it/120x120&text=image1",
1459+
"type": "public",
1460+
"scope": "admin",
1461+
"membersCount": 1,
1462+
"joinedAt": 1638440784,
1463+
"conversationId": "group_project-group",
1464+
"hasJoined": true,
1465+
"createdAt": 1638440784,
1466+
"owner": "superhero4",
1467+
"tags": [
1468+
"friends",
1469+
"project"
1470+
]
1471+
}
1472+
],
1473+
"meta": {
1474+
"pagination": {
1475+
"total": 0,
1476+
"count": 5,
1477+
"per_page": 100,
1478+
"current_page": 1,
1479+
"total_pages": 1
1480+
},
1481+
"cursor": {
1482+
"updatedAt": 1638354799,
1483+
"affix": "prepend"
14841484
}
14851485
}
14861486
}
@@ -3669,6 +3669,35 @@
36693669
"type": "integer",
36703670
"default": "1"
36713671
}
3672+
},
3673+
{
3674+
"name": "hideAgentic",
3675+
"in": "query",
3676+
"description": "Hides agentic conversations from the list.",
3677+
"schema": {
3678+
"type": "boolean"
3679+
}
3680+
},
3681+
{
3682+
"name": "onlyAgentic",
3683+
"in": "query",
3684+
"description": "Shows only agentic conversations in the list.",
3685+
"schema": {
3686+
"type": "boolean"
3687+
}
3688+
},
3689+
{
3690+
"name": "useCursoredIndex",
3691+
"in": "query",
3692+
"description": "Enables cursor-based pagination for more efficient conversations listing.",
3693+
"schema": {
3694+
"type": "integer",
3695+
"default": 1,
3696+
"enum": [
3697+
0,
3698+
1
3699+
]
3700+
}
36723701
}
36733702
],
36743703
"responses": {

‎data-import-apis.json‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
],
5252
"properties": {
5353
"<muid>": {
54-
"description": "Wraps a single message object. The <b>&lt;muid&gt;</b> will be a primary key/unique Identifier of the message.",
54+
"description": "Wraps a single message object. The **&lt;muid&gt;** will be a primary key/unique Identifier of the message.",
5555
"required": [
5656
"muid",
5757
"sender",
@@ -61,7 +61,7 @@
6161
],
6262
"properties": {
6363
"muid": {
64-
"description": "The value should be the same as value of the placeholder <b>&lt;muid&gt;</b> which wraps the message object.",
64+
"description": "The value should be the same as value of the placeholder **&lt;muid&gt;** which wraps the message object.",
6565
"type": "string"
6666
},
6767
"sender": {
@@ -664,14 +664,14 @@
664664
],
665665
"properties": {
666666
"<uid>": {
667-
"description": "Wraps a user object. The <b>&lt;uid&gt;</b> will be a primary key/unique Identifier of the user.",
667+
"description": "Wraps a user object. The **&lt;uid&gt;** will be a primary key/unique Identifier of the user.",
668668
"required": [
669669
"uid",
670670
"name"
671671
],
672672
"properties": {
673673
"uid": {
674-
"description": "The value should be the same as value of the placeholder <b>&lt;uid&gt;</b> which wraps the user object.",
674+
"description": "The value should be the same as value of the placeholder **&lt;uid&gt;** which wraps the user object.",
675675
"type": "string"
676676
},
677677
"name": {
@@ -818,15 +818,15 @@
818818
],
819819
"properties": {
820820
"<guid>": {
821-
"description": "Wraps a group object. The <b>&lt;guid&gt;</b> will be a primary key/unique Identifier of the group.",
821+
"description": "Wraps a group object. The **&lt;guid&gt;** will be a primary key/unique Identifier of the group.",
822822
"required": [
823823
"guid",
824824
"name",
825825
"type"
826826
],
827827
"properties": {
828828
"guid": {
829-
"description": "The value should be the same as value of the placeholder <b>&lt;guid&gt;</b> which wraps the group object.",
829+
"description": "The value should be the same as value of the placeholder **&lt;guid&gt;** which wraps the group object.",
830830
"type": "string"
831831
},
832832
"name": {
@@ -1018,15 +1018,15 @@
10181018
],
10191019
"properties": {
10201020
"<guid>_member_<uid>": {
1021-
"description": "Wraps a single member object. The <b>&lt;guid&gt;&#95member&#95&lt;uid&gt;</b> will will be a primary key/unique Identifier of the member.",
1021+
"description": "Wraps a single member object. The **&lt;guid&gt;&#95member&#95&lt;uid&gt;** will will be a primary key/unique Identifier of the member.",
10221022
"required": [
10231023
"memberId",
10241024
"guid",
10251025
"uid"
10261026
],
10271027
"properties": {
10281028
"memberId": {
1029-
"description": "The value should be the same as value of the placeholder <b>&lt;guid&gt;&#95member&#95&lt;uid&gt;</b> which wraps the member object.",
1029+
"description": "The value should be the same as value of the placeholder **&lt;guid&gt;&#95member&#95&lt;uid&gt;** which wraps the member object.",
10301030
"type": "string"
10311031
},
10321032
"guid": {

‎rest-api/constraints-rate-limits-and-errors.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ title: "Constraints, Rate Limits And Errors"
9595

9696
**API**
9797

98-
1. API calls for core operations are rate limited to 10000 requests per min. Core operations include user connection, create/delete user, create/join group cumulatively.
99-
2. API calls for standard operations are rate limited to 20000 requests per min. Standard operations include all other operations cumulatively.
98+
1. API calls for core operations are rate limited to 10,000 requests per min. Core operations include user connection, create/delete user, create/join group cumulatively.
99+
2. API calls for standard operations are rate limited to 20,000 requests per min. Standard operations include all other operations cumulatively.
100100

101101
**Bots**
102102

0 commit comments

Comments
 (0)