Skip to content

Commit 1f1834c

Browse files
committed
openapi: remove long descriptions
1 parent c8d576d commit 1f1834c

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

openapi/clientapi.yaml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,7 @@ paths:
7171
summary: List Activity
7272
security:
7373
- basic_auth: []
74-
description: >
75-
The `from` field does not work as you would expect, since this endpoint is meant for pagination on the home page, Classcharts only returns a 50 points from the `to` field.
76-
77-
78-
To get more points you will need to make use of the `last_id` field. Our [JavaScript Library](https://github.com/classchartsapi/classcharts-api-js) provides a `client.getFullActivity()` helper function to do this for you.
74+
description: Lists up to 50 activity points
7975

8076
parameters:
8177
- name: studentId
@@ -90,11 +86,13 @@ paths:
9086
format: date
9187
- name: to
9288
in: query
89+
description: This endpoint is meant for pagination so the response will not include up to this date (unless there is less than 50 points)
9390
schema:
9491
type: string
9592
format: date
9693
- name: last_id
9794
in: query
95+
description: This endpoint is meant for pagination so this field is used to start as a specific id onwards
9896
schema:
9997
type: string
10098
responses:

0 commit comments

Comments
 (0)