GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

[breaking] Include /v1/ in the sync-server paths

Browse source 
This is an incompatible change to the sync-server protocol.
This commit is contained in:
Dustin J. Mitchell 2021-05-14 12:51:24 -04:00
parent febe6d8b68
commit 373cef9d33
4 changed files with 16 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/src/sync-protocol.md
View file

@ -73,7 +73,7 @@ This value is passed with every request in the `X-Client-Id` header, in its dash
### AddVersion
The request is a `POST` to `<origin>/client/add-version/<parentVersionId>`.
The request is a `POST` to `<origin>/v1/client/add-version/<parentVersionId>`.
The request body contains the history segment, optionally encoded using any encoding supported by actix-web.
The content-type must be `application/vnd.taskchampion.history-segment`.
@ -87,7 +87,7 @@ Other error responses (4xx or 5xx) may be returned and should be treated appropr
### GetChildVersion
The request is a `GET` to `<origin>/client/get-child-version/<parentVersionId>`.
The request is a `GET` to `<origin>/v1/client/get-child-version/<parentVersionId>`.
The response is 404 NOT FOUND if no such version exists.
Otherwise, the response is a 200 OK.
The version's history segment is returned in the response body, with content-type `application/vnd.taskchampion.history-segment`.