Move various e2e defintions out to yaml files #1166
Conversation
We have code to generate tables, which we should use in the e2e section.
richvdh
force-pushed
the
rav/clean_up_e2e_definitions
branch
from
964cf6c to
f8e3220
Compare
| @@ -323,7 +323,6 @@ footer { | |||
| table { | |||
| table-layout: fixed; | |||
| width: 100%; | |||
| margin: 4rem 0; | |||
There was a problem hiding this comment.
I did this because otherwise I ended up with a huge gap of whitespace above the new tables. I can't find anywhere else that it has changed anything.
There was a problem hiding this comment.
See the 200 response of https://pr1166--matrix-spec-previews.netlify.app/client-server-api/#getwell-knownmatrixclient for an example where this visually merges two adjacent tables one visual blob.
(xref: ea42cd3#r79081346)
There was a problem hiding this comment.
Here's a quick prototype. WDYT?
| type: string | ||
| description: |- | ||
| The curve25519 public key used to encrypt the backups, encoded in unpadded base64. | ||
| example: "abcdefg" |
There was a problem hiding this comment.
examples in this file were taken from https://github.com/uhoreg/matrix-doc/blob/e2e_backup/proposals/1219-storing-megolm-keys-serverside.md.
| example: { | ||
| "algorithm": "m.megolm.v1.aes-sha2", | ||
| "forwarding_curve25519_key_chain": [ | ||
| "hPQNcabIABgGnx3/ACv/jmMmiQHoeFfuLB17tzWp6Hw" | ||
| ], | ||
| "sender_key": "RF3s+E7RkTQTGF2d8Deol0FkQvgII2aJDf3/Jp5mxVU", | ||
| "sender_claimed_keys": { | ||
| "ed25519": "aj40p+aw64yPIdsxoog8jhPu9i7l7NcFRecuOQblE3Y", | ||
| }, | ||
| "session_key": "AgAAAADxKHa9uFxcXzwYoNueL5Xqi69IkD4sni8Llf..." | ||
| } |
There was a problem hiding this comment.
examples in this file were based on the old example for the export format, but the ed25519 key has been replaced with something realistic as the angle brackets in the old example didn't render correctly.
| algorithm: | ||
| type: string | ||
| description: |- | ||
| The end-to-end message encryption algorithm that the key is for. Must be `m.megolm.v1.aes-sha2`. |
There was a problem hiding this comment.
Descriptions in this file have been inspired by the changes in #1088
| {{ if not $definition }} | ||
| {{ errorf "site data %s not found" $path }} | ||
| {{ end }} |
There was a problem hiding this comment.
I spent ages wondering why I was getting an obscure error. Turns out I had the filename wrong...
We have code to generate tables, which we should use in the e2e section.
Preview: https://pr1166--matrix-spec-previews.netlify.app