From 487b37c5a715888272a0239eb6c567795626e897 Mon Sep 17 00:00:00 2001 From: holo Date: Wed, 18 Jun 2025 23:17:28 +1000 Subject: [PATCH] Update api client --- api-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-client.md b/api-client.md index db2b66d..28a452d 100644 --- a/api-client.md +++ b/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://en.wikipedia.org/wiki/Query_string - 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: - 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).