Skip to content

Commit 84e756e

Browse files
committed
CCM-11580: add limit parameter to list letters endpoint
1 parent 8d9896e commit 84e756e

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

specification/api/components/endpoints/listLetters.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ operationId: listLetters
33
tags:
44
- letter
55
# We have disabled pagination and will only return PENDING letters via this endpoint for now
6-
#parameters:
6+
parameters:
77
# - $ref: "../parameters/letterStatus.yml"
88
# - $ref: "../parameters/pageNumber.yml"
9+
- $ref: "../parameters/limit.yml"
910
description: The key use of this endpoint is to query letters which are ready to be printed
1011
responses:
1112
'200':
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
name: limit
2+
in: query
3+
description: |-
4+
The maximum number of items to return in a single request
5+
schema:
6+
type: number
7+
example: 100

0 commit comments

Comments
 (0)