Skip to content

Commit 7dd0403

Browse files
committed
fix: add paging.next changes
1 parent 7dc6379 commit 7dd0403

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/migrate-to-3.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
on creation or rotation. See [Tokens are only shown once](#tokens-are-only-shown-once).
1414
- If you have scripts hitting client-token endpoints, they may now need
1515
[elevation](#step-up-authentication).
16+
- The `paging.next` URL in message list responses is now a relative path.
17+
See [Paging next URL is relative](#paging-next-url-is-relative).
1618

1719
## Config Changes
1820

@@ -98,6 +100,22 @@ update endpoint (`PUT /application/{id}/security`).
98100
Existing tokens (starting with `A` and `C`) will continue to work.
99101
Plugin tokens (starting with `P`) used to access web resources are not affected by this change.
100102

103+
### Paging next URL is relative
104+
105+
The `paging.next` URL returned by `GET /message` and
106+
`GET /application/{id}/message` is now a relative path instead of an absolute
107+
URL.
108+
109+
```json
110+
// before
111+
{"paging": {"next": "https://example.com/message?limit=100&since=23"}}
112+
// after
113+
{"paging": {"next": "/message?limit=100&since=23"}}
114+
```
115+
116+
Clients that follow `next` directly must now prepend the Gotify base URL,
117+
e.g. `https://example.com/gotify` + `/message?limit=100&since=23`.
118+
101119
### Step-up Authentication
102120

103121
Introduces step-up authentication via time-limited [session

0 commit comments

Comments
 (0)