Dreamspace/adventures
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update api client

holo
2025-06-18 23:17:28 +10:00
parent 251e03bafc
commit 487b37c5a7
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api-client.md

@@ -12,7 +12,7 @@ This API very loosely follows an HTTP API architectural standard known as 'REST'
- https://restfulapi.net/http-methods/ - https://restfulapi.net/http-methods/
- https://en.wikipedia.org/wiki/Query_string - https://en.wikipedia.org/wiki/Query_string
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Overview - https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Overview
- Note that libraries do 90% of the communication layer work described here. - Note that libraries such as `aiohttp` in python and `HTTPRequest` in godot do 90% of the communication layer work described here.
Now that you have read that, you need to know the design of this API actually deviates in the following significant ways from the REST standard: Now that you have read that, you need to know the design of this API actually deviates in the following significant ways from the REST standard:
- The `PUT` method is meant to be an idempotent version of the creation method `POST`, used to update an existing resource or create a resource with a given ID. We do ***not*** follow this. We currently only use `PUT` in one route, which is to upload a list of stamps (e.g. adding multiple stamps to a document at once). - The `PUT` method is meant to be an idempotent version of the creation method `POST`, used to update an existing resource or create a resource with a given ID. We do ***not*** follow this. We currently only use `PUT` in one route, which is to upload a list of stamps (e.g. adding multiple stamps to a document at once).