Ensure more uniqueness for generated HTML IDs (#1881)

* Include method in all API endpoint children's IDs

Avoids duplicate IDs for object of endpoints
that use the same path but a different method.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Differentiate API endpoints' request and response children's IDs

Ensures that the objects have a unique ID compared to other parts of the endpoint.
Mostly useful for the Error type that can be used for responses with different status codes.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Differentiate the names of both SessionData formats

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2024-06-20 17:36:33 +02:00 committed by GitHub
parent 8ef84d1cc7
commit 094e25b6cd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 11 additions and 7 deletions

View file

@ -1349,7 +1349,7 @@ the following format:
The `session_data` field in the backups is constructed as follows:
1. Encode the session key to be backed up as a JSON object using the
`SessionData` format defined below.
`BackedUpSessionData` format defined below.
2. Generate an ephemeral curve25519 key, and perform an ECDH with the
ephemeral key and the backup's public key to generate a shared
@ -1427,7 +1427,7 @@ user-supplied passphrase, and is created as follows:
###### Key export format
The exported sessions are formatted as a JSON array of `SessionData`
The exported sessions are formatted as a JSON array of `ExportedSessionData`
objects described as follows:
{{% definition path="api/client-server/definitions/megolm_export_session_data" %}}