Merge 6183f2410f into fca171427f

.github/workflows/main.yml

@@ -2,7 +2,6 @@ name: "Spec"
 
 env:
   HUGO_VERSION: 0.139.0
-  PYTHON_VERSION: 3.13
 
 on:
   push:
@@ -41,7 +40,7 @@ jobs:
       - name: "➕ Setup Python"
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: '3.9'
           cache: 'pip'
           cache-dependency-path: scripts/requirements.txt
       - name: "➕ Install dependencies"
@@ -60,7 +59,7 @@ jobs:
       - name: "➕ Setup Python"
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: '3.9'
           cache: 'pip'
           cache-dependency-path: scripts/requirements.txt
       - name: "➕ Install dependencies"
@@ -79,7 +78,7 @@ jobs:
       - name: "➕ Setup Python"
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: '3.9'
           cache: 'pip'
           cache-dependency-path: scripts/requirements.txt
       - name: "➕ Install dependencies"
@@ -121,7 +120,7 @@ jobs:
       - name: "➕ Setup Python"
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: '3.9'
           cache: 'pip'
           cache-dependency-path: scripts/requirements.txt
       - name: "➕ Install dependencies"
@@ -173,7 +172,7 @@ jobs:
       - name: "➕ Setup Python"
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
+          python-version: '3.9'
       - name: "➕ Install towncrier"
         run: "pip install 'towncrier'"
       - name: "Generate changelog"

changelogs/client_server/newsfragments/2140.clarification

@@ -1 +0,0 @@
-Clarify that Well-Known URIs are available on the server name's hostname. Contributed by @HarHarLinks.

changelogs/internal/newsfragments/2088.clarification

@@ -1 +0,0 @@
-Replace Hugo shortcodes in OpenAPI output.

changelogs/server_server/newsfragments/2067.clarification

@@ -1 +0,0 @@
-Add a note to the invite endpoints that invites to local users may be received twice over federation if the homeserver is already in the room.

changelogs/server_server/newsfragments/2140.clarification

@@ -1 +0,0 @@
-Clarify that Well-Known URIs are available on the server name's hostname. Contributed by @HarHarLinks.

content/client-server-api/_index.md

@@ -371,23 +371,15 @@ valid data was obtained, but no server is available to serve the client.
 No further guess should be attempted and the user should make a
 conscientious decision what to do next.
 
-### Well-known URIs
+### Well-known URI
-
-Matrix facilitates automatic discovery for the Client-Server API base URL and more via the
-[RFC 8615](https://datatracker.ietf.org/doc/html/rfc8615) "Well-Known URI" method.
-This method uses JSON files at a predetermined location on the root path `/.well-known/` to
-specify parameter values.
 
 {{% boxes/note %}}
-Diverging from the rest of the endpoints in the Client-Server spec, these files can not be provided
-on the base URL that the Client-Server API is reachable on, as it is yet to be discovered.
-Instead, they can be reached via HTTPS on the [server name](/appendices/#server-name)'s hostname as domain.
-
 Servers hosting the `.well-known` JSON file SHOULD offer CORS headers,
 as per the [CORS](#web-browser-clients) section in this specification.
 {{% /boxes/note %}}
 
-The flow for auto-discovery is as follows:
+The `.well-known` method uses a JSON file at a predetermined location to
+specify parameter values. The flow for this method is as follows:
 
 1.  Extract the [server name](/appendices/#server-name) from the user's Matrix ID by splitting the
     Matrix ID at the first colon.
@@ -423,17 +415,10 @@ The flow for auto-discovery is as follows:
 
 {{% http-api spec="client-server" api="wellknown" %}}
 
-{{% http-api spec="client-server" api="support" %}}
-
-### API Versions
-
-Upon connecting, the Matrix client and server need to negotiate which version of the specification
-they commonly support, as the API evolves over time. The server advertises its supported versions
-and optionally unstable features to the client, which can then go on to make requests to the
-endpoints it supports.
-
 {{% http-api spec="client-server" api="versions" %}}
 
+{{% http-api spec="client-server" api="support" %}}
+
 ## Client Authentication
 
 Most API endpoints require the user to identify themselves by presenting

content/server-server-api.md

@@ -119,8 +119,7 @@ to send. The process overall is as follows:
     server must present a valid certificate for the hostname.
 
 3.  If the hostname is not an IP literal, a regular HTTPS request is
-    made to `https://<hostname>/.well-known/matrix/server` (according to 
+    made to `https://<hostname>/.well-known/matrix/server`, expecting
-    [RFC 8615](https://datatracker.ietf.org/doc/html/rfc8615)), expecting
     the schema defined later in this section. 30x redirects should be
     followed, however redirection loops should be avoided. Responses
     (successful or otherwise) to the `/.well-known` endpoint should be

data/api/client-server/support.yaml

@@ -22,12 +22,9 @@ paths:
       description: |-
         Gets server admin contact and support page of the domain.
 
-        {{% boxes/note %}}
+        Like the [well-known discovery URI](/client-server-api/#well-known-uri),
-        Like the [well-known discovery URI](/client-server-api/#well-known-uris),
+        this should be accessed with the hostname of the homeserver by making a
-        this endpoint should be accessed with the hostname of the homeserver's
-        [server name](/appendices/#server-name) by making a
         GET request to `https://hostname/.well-known/matrix/support`.
-        {{% /boxes/note %}}
 
         Note that this endpoint is not necessarily handled by the homeserver.
         It may be served by another webserver, used for discovering support

data/api/client-server/wellknown.yaml

@@ -26,12 +26,6 @@ paths:
         suitably namespaced for each application and reduces the risk of
         clashes.
 
-        {{% boxes/note %}}
-        This endpoint should be accessed with the hostname of the homeserver's
-        [server name](/appendices/#server-name) by making a
-        GET request to `https://hostname/.well-known/matrix/client`.
-        {{% /boxes/note %}}
-
         Note that this endpoint is not necessarily handled by the homeserver,
         but by another webserver, to be used for discovering the homeserver URL.
       operationId: getWellknown

data/api/server-server/invites-v1.yaml

@@ -20,7 +20,7 @@ paths:
     put:
       summary: Invites a remote user to a room
       description: |-
-        Invites a remote user to a room. Once the event has been signed by both the inviting
+        Invites a remote user to a room. Once the event has been  signed by both the inviting
         homeserver and the invited homeserver, it can be sent to all of the servers in the
         room by the inviting homeserver.
 
@@ -32,10 +32,6 @@ paths:
         [room version specification](/rooms) for precise event formats. **The request and response
         bodies here describe the common event fields in more detail and may be missing other
         required fields for a PDU.**
-
-        Also note that if the remote homeserver is already in the room, it will receive the
-        invite event twice; once through this endpoint, and again through a [federation
-        transaction](/server-server-api/#transactions).
       operationId: sendInviteV1
       security:
         - signedRequest: []

data/api/server-server/invites-v2.yaml

@@ -24,7 +24,7 @@ paths:
         This API is nearly identical to the v1 API with the exception of the request
         body being different, and the response format fixed.
 
-        Invites a remote user to a room. Once the event has been signed by both the inviting
+        Invites a remote user to a room. Once the event has been  signed by both the inviting
         homeserver and the invited homeserver, it can be sent to all of the servers in the
         room by the inviting homeserver.
 
@@ -36,10 +36,6 @@ paths:
         [room version specification](/rooms) for precise event formats. **The request and response
         bodies here describe the common event fields in more detail and may be missing other
         required fields for a PDU.**
-
-        Also note that if the remote homeserver is already in the room, it will receive the
-        invite event twice; once through this endpoint, and again through a [federation
-        transaction](/server-server-api/#transactions).
       operationId: sendInviteV2
       security:
         - signedRequest: []

data/api/server-server/wellknown.yaml

@@ -24,12 +24,6 @@ paths:
         Gets information about the delegated server for server-server communication
         between Matrix homeservers. Servers should follow 30x redirects, carefully
         avoiding redirect loops, and use normal X.509 certificate validation.
-
-        {{% boxes/note %}}
-        This endpoint should be accessed with the hostname of the homeserver's
-        [server name](/appendices/#server-name) by making a
-        GET request to `https://hostname/.well-known/matrix/server`.
-        {{% /boxes/note %}}
       operationId: getWellKnown
       responses:
         "200":

scripts/dump-openapi.py

@@ -32,35 +32,6 @@ import yaml
 scripts_dir = os.path.dirname(os.path.abspath(__file__))
 api_dir = os.path.join(os.path.dirname(scripts_dir), "data", "api")
 
-# Finds a Hugo shortcode in a string.
-#
-# A shortcode is defined as (newlines and whitespaces for presentation purpose):
-#
-# {{%
-#     <zero or more whitespaces>
-#     <name of shortcode>
-#     (optional <one or more whitespaces><list of parameters>)
-#     <zero or more whitespaces>
-# %}}
-#
-# With:
-#
-# * <name of shortcode>: any word character and `-` and `/`. `re.ASCII` is used to only match
-#   ASCII characters in the name.
-# * <list of parameters>: any character except `}`, must not start or end with a
-#   whitespace.
-shortcode_regex = re.compile(r"""\{\{\%                                   # {{%
-                                 \s*                                      # zero or more whitespaces
-                                 (?P<name>[\w/-]+)                        # name of shortcode
-                                 (?:\s+(?P<params>[^\s\}][^\}]+[^\s\}]))? # optional list of parameters
-                                 \s*                                      # zero or more whitespaces
-                                 \%\}\}                                   # %}}""", re.ASCII | re.VERBOSE)
-
-# Parses the parameters of a Hugo shortcode.
-#
-# For simplicity, this currently only supports the `key="value"` format.
-shortcode_params_regex = re.compile(r"(?P<key>\w+)=\"(?P<value>[^\"]+)\"", re.ASCII)
-
 def prefix_absolute_path_references(text, base_url):
     """Adds base_url to absolute-path references.
 
@@ -73,90 +44,17 @@ def prefix_absolute_path_references(text, base_url):
     """
     return text.replace("](/", "]({}/".format(base_url))
 
-def replace_match(match, replacement):
+def edit_links(node, base_url):
-    """Replaces the regex match by the replacement in the text."""
+    """Finds description nodes and makes any links in them absolute."""
-    return match.string[:match.start()] + replacement + match.string[match.end():]
-
-def replace_shortcode(shortcode):
-    """Replaces the shortcode by a Markdown fallback in the text.
-
-    The supported shortcodes are:
-
-    * boxes/note, boxes/rationale, boxes/warning
-    * added-in, changed-in
-    
-    All closing tags (`{{ /shortcode }}`) are replaced with the empty string.
-    """
-
-    if shortcode['name'].startswith("/"):
-        # This is the end of the shortcode, just remove it.
-        return replace_match(shortcode, "")
-
-    # Parse the parameters of the shortcode
-    params = {}
-    if shortcode['params']:
-        for param in shortcode_params_regex.finditer(shortcode['params']):
-            if param['key']:
-                params[param['key']] = param['value']
-
-    match shortcode['name']:
-        case "boxes/note":
-            return replace_match(shortcode, "**NOTE:** ")
-        case "boxes/rationale":
-            return replace_match(shortcode, "**RATIONALE:** ")
-        case "boxes/warning":
-            return replace_match(shortcode, "**WARNING:** ")
-        case "added-in":
-            version = params['v']
-            if not version:
-                raise ValueError("Missing parameter `v` for `added-in` shortcode")
-
-            return replace_match(shortcode, f"**[Added in `v{version}`]** ")
-        case "changed-in":
-            version = params['v']
-            if not version:
-                raise ValueError("Missing parameter `v` for `changed-in` shortcode")
-
-            return replace_match(shortcode, f"**[Changed in `v{version}`]** ")
-        case _:
-            raise ValueError("Unknown shortcode", shortcode['name'])
-
-
-def find_and_replace_shortcodes(text):
-    """Finds Hugo shortcodes and replaces them by a Markdown fallback.
-
-    The supported shortcodes are:
-
-    * boxes/note, boxes/rationale, boxes/warning
-    * added-in, changed-in
-    """
-    # We use a `while` loop with `search` instead of a `for` loop with
-    # `finditer`, because as soon as we start replacing text, the
-    # indices of the match are invalid.
-    while shortcode := shortcode_regex.search(text):
-        text = replace_shortcode(shortcode)
-
-    return text
-
-def edit_descriptions(node, base_url):
-    """Finds description nodes and apply fixes to them.
-
-    The fixes that are applied are:
-
-    * Make links absolute
-    * Replace Hugo shortcodes
-    """
     if isinstance(node, dict):
         for key in node:
             if isinstance(node[key], str):
                 node[key] = prefix_absolute_path_references(node[key], base_url)
-                node[key] = find_and_replace_shortcodes(node[key])
             else:
-                edit_descriptions(node[key], base_url)
+                edit_links(node[key], base_url)
     elif isinstance(node, list):
         for item in node:
-            edit_descriptions(item, base_url)
+            edit_links(item, base_url)
-
 
 parser = argparse.ArgumentParser(
     "dump-openapi.py - assemble the OpenAPI specs into a single JSON file"
@@ -266,7 +164,7 @@ for filename in os.listdir(selected_api_dir):
 if untagged != 0:
     print("{} untagged operations, you may want to look into fixing that.".format(untagged))
 
-edit_descriptions(output, base_url)
+edit_links(output, base_url)
 
 print("Generating %s" % output_file)