Skip to content

Commit

Permalink
feat: Update offset description to display correct limit value (#361)
Browse files Browse the repository at this point in the history 
* feat: Update offset description with correct limit

* Auto generate API docs

---------

Co-authored-by: Siva <[email protected]>
  • Loading branch information
@RoshanMhatre @snarayanank2
RoshanMhatre and snarayanank2 authored Sep 28, 2023
1 parent 708b0c0 commit e6aa59e
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions admin.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,11 @@ components:
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return
first 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return
first 200 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return
next 1000 objects. <br>
The second request will have offset as 200 and limit as 200 to return
next 200 objects. <br>
type: integer
example: 10
id_integer:
Expand Down
4 changes: 2 additions & 2 deletions reference/accountant.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
org_id:
Expand Down
4 changes: 2 additions & 2 deletions reference/admin.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
id_integer:
Expand Down
4 changes: 2 additions & 2 deletions reference/approver.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
id_string:
Expand Down
4 changes: 2 additions & 2 deletions reference/common.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
place_out_minimal:
Expand Down
4 changes: 2 additions & 2 deletions reference/hod.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
id_string:
Expand Down
4 changes: 2 additions & 2 deletions reference/hop.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
id_string:
Expand Down
4 changes: 2 additions & 2 deletions reference/spender.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ components:
description: |
offset is used to skip that many number of objects before counting. <br>
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000 objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next 1000 objects. <br>
The first request will have offset as 0 and limit as 200 to return first 200 objects. <br>
The second request will have offset as 200 and limit as 200 to return next 200 objects. <br>
type: integer
example: 10
id_integer:
Expand Down
6 changes: 3 additions & 3 deletions src/components/schemas/offset.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ description: >
For example, if there are 2000 objects, <br>
The first request will have offset as 0 and limit as 1000 to return first 1000
The first request will have offset as 0 and limit as 200 to return first 200
objects. <br>
The second request will have offset as 1000 and limit as 1000 to return next
1000 objects. <br>
The second request will have offset as 200 and limit as 200 to return next
200 objects. <br>
type: integer
example: 10

0 comments on commit e6aa59e

Please sign in to comment.