wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Make example strings more legible

Browse source
This commit is contained in:
Travis Ralston 2019-01-31 00:09:30 -07:00
parent ff75996524
commit c888f3f080
3 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

6
api/server-server/definitions/pdu.yaml
View file

@ -26,13 +26,13 @@ allOf:
description: |- description: |-
Content hashes of the PDU, following the algorithm specified in `Signing Events`_. Content hashes of the PDU, following the algorithm specified in `Signing Events`_.
example: { example: {
"sha256": "thishashcoversallfieldsincasethisisredacted" "sha256": "ThisHashCoversAllFieldsInCaseThisIsRedacted"
} }
properties: properties:
sha256: sha256:
type: string type: string
description: The hash. description: The hash.
example: thishashcoversallfieldsincasthisisredacted example: ThisHashCoversAllFieldsInCaseThisIsRedacted
required: ['sha256'] required: ['sha256']
signatures: signatures:
type: object type: object
@ -40,7 +40,7 @@ allOf:
Signatures for the PDU, following the algorithm specified in `Signing Events`_. Signatures for the PDU, following the algorithm specified in `Signing Events`_.
example: { example: {
"example.com": { "example.com": {
"ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus" "ed25519:key_version:": "86BytesOfUnpaddedBase64ToCoverAllFieldsIncludingHashes"
} }
} }
additionalProperties: additionalProperties:

10
api/server-server/definitions/pdu_v3.yaml
View file

@ -28,7 +28,7 @@ allOf:
description: |- description: |-
Event IDs and reference hashes for the authorization events that would Event IDs and reference hashes for the authorization events that would
allow this event to be in the room. allow this event to be in the room.
example: ["$abase64encodedhash", "$anotherevent"] example: ["$base64EncodedHash", "$AnotherEvent"]
prev_events: prev_events:
type: array type: array
items: items:
@ -37,20 +37,20 @@ allOf:
description: |- description: |-
Event IDs and reference hashes for the most recent events in the room Event IDs and reference hashes for the most recent events in the room
that the homeserver was aware of when it made this event. that the homeserver was aware of when it made this event.
example: ["$abase64encodedhash", "$anotherevent"] example: ["$base64EncodedHash", "$AnotherEvent"]
hashes: hashes:
type: object type: object
title: Event Hash title: Event Hash
description: |- description: |-
Content hashes of the PDU, following the algorithm specified in `Signing Events`_. Content hashes of the PDU, following the algorithm specified in `Signing Events`_.
example: { example: {
"sha256": "thishashcoversallfieldsincasethisisredacted" "sha256": "ThisHashCoversAllFieldsInCaseThisIsRedacted"
} }
properties: properties:
sha256: sha256:
type: string type: string
description: The hash. description: The hash.
example: thishashcoversallfieldsincasthisisredacted example: ThisHashCoversAllFieldsInCaseThisIsRedacted
required: ['sha256'] required: ['sha256']
signatures: signatures:
type: object type: object
@ -58,7 +58,7 @@ allOf:
Signatures for the PDU, following the algorithm specified in `Signing Events`_. Signatures for the PDU, following the algorithm specified in `Signing Events`_.
example: { example: {
"example.com": { "example.com": {
"ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus" "ed25519:key_version:": "86BytesOfUnpaddedBase64ToCoverAllFieldsIncludingHashes"
} }
} }
additionalProperties: additionalProperties:

8
api/server-server/definitions/unsigned_pdu_base.yaml
View file

@ -64,13 +64,13 @@ properties:
- type: object - type: object
title: Event Hash title: Event Hash
example: { example: {
"sha256": "abase64encodedsha256hashshouldbe43byteslong" "sha256": "Base64EncodedSha256HashesShouldBe43BytesLong"
} }
properties: properties:
sha256: sha256:
type: string type: string
description: The event hash. description: The event hash.
example: abase64encodedsha256hashshouldbe43byteslong example: Base64EncodedSha256HashesShouldBe43BytesLong
required: ['sha256'] required: ['sha256']
depth: depth:
type: integer type: integer
@ -95,13 +95,13 @@ properties:
- type: object - type: object
title: Event Hash title: Event Hash
example: { example: {
"sha256": "abase64encodedsha256hashshouldbe43byteslong" "sha256": "Base64EncodedSha256HashesShouldBe43BytesLong"
} }
properties: properties:
sha256: sha256:
type: string type: string
description: The event hash. description: The event hash.
example: abase64encodedsha256hashshouldbe43byteslong example: Base64EncodedSha256HashesShouldBe43BytesLong
required: ['sha256'] required: ['sha256']
redacts: redacts:
type: string type: string