Merge branch 'main' of https://github.com/polyphony-chat/docs

Author: bitfl0wer

docs/Protocol Specifications/core.md

@@ -184,6 +184,8 @@ appearing on ID-Certs managed by that server **if all the following conditions a
    the domain components of the *visible domain name*, the server hosted under the *actual domain name*
    must not be treated as a polyproto server for the *visible domain name*.
 
+Every polyproto home server must have a `.well-known` URI, accessible via an HTTP GET request.
+
 Should a client not be able to access the polyproto API endpoints located at `[visible domain name]/.p2/core/`,
 the client must query `[visible domain name]/.well-known/polyproto-core` with an HTTP GET request and
 try to verify the above-mentioned conditions. If all the above-mentioned conditions can be fulfilled,
@@ -386,7 +388,8 @@ A service channel event payload has the following structure:
 | `service` | string | The name of a polyproto service.                                                           |
 
 The server must respond with a `Service Channel ACK` event payload, indicating whether the action
-was successful or not.
+was successful or not. Clients should expect that the server sends a `Service Channel` payload indicating
+the closing of a channel.
 
 !!! example "Example service channel ACK event payload - failure"
 
@@ -398,7 +401,7 @@ was successful or not.
         "action": "subscribe",
         "service": "service_name",
         "success": false,
-        "errorMessage": "Service not found"
+        "error": "Service not found"
       },
       "s": 1
     }
@@ -424,7 +427,7 @@ was successful or not.
 | `action`  | string  | The action to perform on the service channel. Must be either `subscribe` or `unsubscribe`. |
 | `service` | string  | The polyproto service that was specified in the opcode 8 request                           |
 | `success` | boolean | Whether the action was successful or not.                                                  |
-| `message` | string? | Only present if `success` is `false`. A message indicating why the action failed.          |
+| `error`   | string? | Only present if `success` is `false`. A message indicating why the action failed.          |
 
 If a successful subscription to a service channel is acknowledged, all logic and further event on
 this channel are defined by the service's specification.
@@ -675,8 +678,8 @@ A heartbeat ACK contains events that the client has re-requested as part of thei
     }
     ```
 
-As such, the field `d` in a heartbeat ack is optional (`?`) and, if present, contains an array of
-other gateway events. Heartbeat ACK payloads must not be present in this array, making recursion
+As such, the field `d` in a heartbeat ack may be empty, but never not present. The `d` field contains
+an array of other gateway events. Heartbeat ACK payloads must not be present in this array, making recursion
 impossible.
 
 #### 3.2.4 Establishing a connection
@@ -993,7 +996,7 @@ FIDs consist of the following parts:
 | `@`                            | <a name="def-separator" id="separator"></a>"Separator"                         | Separates local name from domain name                                                                                         |
 | `optionalsubdomain.domain.tld` | <a name="def-domain-name" id="def-domain-name"></a>"Domain Name"               | Includes top-level domain, second-level domain and other subdomains. Address which the actors' home server can be reached at. |
 
-The following regular expression can be used to validate actor IDs: `\b([a-z0-9._%+-]+)@([a-z0-9-]+(\.[a-z0-9-]+)*)`.
+The following regular expression can be used to validate actor IDs: `\b([a-z0-9._%+-]+)@([a-z0-9-]+(\.[a-z0-9-]+)*)$`.
 
 !!! info
 

requirements.txt

@@ -1,5 +1,5 @@
-Babel==2.16.0
-certifi==2024.12.14
+Babel==2.17.0
+certifi==2025.1.31
 charset-normalizer==3.4.1
 click==8.1.8
 colorama==0.4.6
@@ -13,7 +13,7 @@ MarkupSafe==3.0.2
 mergedeep==1.3.4
 mkdocs==1.6.1
 mkdocs-git-revision-date-localized-plugin==1.3.0
-mkdocs-material==9.5.50
+mkdocs-material==9.6.1
 mkdocs-material-extensions==1.3.1
 mkdocs-nav-weight==0.2.0
 mkdocs-rss-plugin==1.17.1
@@ -22,9 +22,9 @@ paginate==0.5.7
 pathspec==0.12.1
 platformdirs==4.3.6
 Pygments==2.19.1
-pymdown-extensions==10.14.1
+pymdown-extensions==10.14.3
 python-dateutil==2.9.0.post0
-pytz==2024.2
+pytz==2025.1
 PyYAML==6.0.2
 pyyaml_env_tag==0.1
 regex==2024.11.6