reflected the recent standard changes in the doc

This commit is contained in:
Luxferre
2024-11-01 07:47:58 +02:00
parent 374be3b9af
commit 2f04542cf6
4 changed files with 23 additions and 15 deletions
+10 -11
View File
@@ -61,6 +61,11 @@ Response: newline-separated message ID list
When a new message is posted to the echo, it gets appended to the end of the
corresponding message ID list for this echo.
The message order in an echo does not always match the timestamp ordering;
it is fully up to the client on how to sort the messages internally. The
messages are only guaranteed to be saved by the server in the order they
arrive onto the server.
- Listing messages in any amount of echos -
Request: GET /u/e/echo.1.name/echo.2.name/...
@@ -77,7 +82,10 @@ msgid2fromecho2
...
In case of limited request, the offset can be negative. E.g. -10:10 means
requesting last 10 messages from the index.
requesting last 10 messages from the index. If the offset:limit pair is not
valid for a particular echo, all message IDs from this echo are returned.
The same message ID ordering rule as for /e applies to /u/e as well.
- Fetching a single message by its ID -
@@ -90,6 +98,7 @@ Request: GET /u/m/msgid1/msgid2/...
Response: newline-separated list of msgid:base64_msgtext
Here, base64_msgtext is a Base64-encoded Node-to-Point Message (see below).
The standardized ID count limit is at most 40 messages per bundle.
- Posting a message (via POST) -
@@ -171,14 +180,4 @@ This algorithm must be implemented by every station to generate message IDs:
4. Replace all occurrences of + or - with A, and / or _ with z.
5. The result of these operations is your ii message ID.
Implementation notes
--------------------
* Most HTTP servers are configured to reject long GET lines, so tii passes a
limited amount of message IDs to the /u/m endpoints. This behaviour can be
configured in the stations.txt file.
* The message order in an echo does not always match the timestamp ordering;
it is fully up to the client on how to sort the messages internally. The
messages are only guaranteed to be saved by the server in the order they
arrive onto the server.
--- Luxferre ---