Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 146863b

Browse files
committed
Add Code Snippets to Spec Files
1 parent bda3a2a commit 146863b

File tree

2 files changed

+174
-304
lines changed

2 files changed

+174
-304
lines changed

site/specs/messaging.yml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -887,6 +887,7 @@ paths:
887887
- $ref: '#/components/parameters/sort'
888888
- $ref: '#/components/parameters/pageToken'
889889
- $ref: '#/components/parameters/limit'
890+
- $ref: '#/components/parameters/trackTotalCount'
890891
responses:
891892
'200':
892893
$ref: '#/components/responses/listMessagesResponse'
@@ -1529,6 +1530,18 @@ components:
15291530
schema:
15301531
type: integer
15311532
example: 50
1533+
trackTotalCount:
1534+
in: query
1535+
name: trackTotalCount
1536+
required: false
1537+
default: true
1538+
description: >-
1539+
When set to false, the response's totalCount field will have a maximum
1540+
value of 10,000. When set to true, or excluded, this will give an
1541+
accurate totalCount of all messages that match the provided filters.
1542+
schema:
1543+
type: boolean
1544+
example: true
15321545
schemas:
15331546
priorityEnum:
15341547
type: string
@@ -1593,7 +1606,10 @@ components:
15931606
properties:
15941607
totalCount:
15951608
type: integer
1596-
description: Total number of messages matched by the search.
1609+
description: >-
1610+
The total count of objects returned in the response. When the
1611+
request has trackTotalCount set to false this value is limited to
1612+
10,000.
15971613
example: 100
15981614
pageInfo:
15991615
$ref: '#/components/schemas/pageInfo'

0 commit comments

Comments
 (0)