From c888f3f080a12393abae7577eea1038fe1d44c79 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Thu, 31 Jan 2019 00:09:30 -0700
Subject: [PATCH] Make example strings more legible

---
 api/server-server/definitions/pdu.yaml               |  6 +++---
 api/server-server/definitions/pdu_v3.yaml            | 10 +++++-----
 api/server-server/definitions/unsigned_pdu_base.yaml |  8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/api/server-server/definitions/pdu.yaml b/api/server-server/definitions/pdu.yaml
index d86b85384..93de20e66 100644
--- a/api/server-server/definitions/pdu.yaml
+++ b/api/server-server/definitions/pdu.yaml
@@ -26,13 +26,13 @@ allOf:
         description: |-
           Content hashes of the PDU, following the algorithm specified in `Signing Events`_.
         example: {
-          "sha256": "thishashcoversallfieldsincasethisisredacted"
+          "sha256": "ThisHashCoversAllFieldsInCaseThisIsRedacted"
         }
         properties:
           sha256:
             type: string
             description: The hash.
-            example: thishashcoversallfieldsincasthisisredacted
+            example: ThisHashCoversAllFieldsInCaseThisIsRedacted
         required: ['sha256']
       signatures:
         type: object
@@ -40,7 +40,7 @@ allOf:
           Signatures for the PDU, following the algorithm specified in `Signing Events`_.
         example: {
           "example.com": {
-            "ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus"
+            "ed25519:key_version:": "86BytesOfUnpaddedBase64ToCoverAllFieldsIncludingHashes"
           }
         }
         additionalProperties:
diff --git a/api/server-server/definitions/pdu_v3.yaml b/api/server-server/definitions/pdu_v3.yaml
index 97747ca8c..40093962c 100644
--- a/api/server-server/definitions/pdu_v3.yaml
+++ b/api/server-server/definitions/pdu_v3.yaml
@@ -28,7 +28,7 @@ allOf:
         description: |-
           Event IDs and reference hashes for the authorization events that would
           allow this event to be in the room.
-        example: ["$abase64encodedhash", "$anotherevent"]
+        example: ["$base64EncodedHash", "$AnotherEvent"]
       prev_events:
         type: array
         items:
@@ -37,20 +37,20 @@ allOf:
         description: |-
           Event IDs and reference hashes for the most recent events in the room
           that the homeserver was aware of when it made this event.
-        example: ["$abase64encodedhash", "$anotherevent"]
+        example: ["$base64EncodedHash", "$AnotherEvent"]
       hashes:
         type: object
         title: Event Hash
         description: |-
           Content hashes of the PDU, following the algorithm specified in `Signing Events`_.
         example: {
-          "sha256": "thishashcoversallfieldsincasethisisredacted"
+          "sha256": "ThisHashCoversAllFieldsInCaseThisIsRedacted"
         }
         properties:
           sha256:
             type: string
             description: The hash.
-            example: thishashcoversallfieldsincasthisisredacted
+            example: ThisHashCoversAllFieldsInCaseThisIsRedacted
         required: ['sha256']
       signatures:
         type: object
@@ -58,7 +58,7 @@ allOf:
           Signatures for the PDU, following the algorithm specified in `Signing Events`_.
         example: {
           "example.com": {
-            "ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus"
+            "ed25519:key_version:": "86BytesOfUnpaddedBase64ToCoverAllFieldsIncludingHashes"
           }
         }
         additionalProperties:
diff --git a/api/server-server/definitions/unsigned_pdu_base.yaml b/api/server-server/definitions/unsigned_pdu_base.yaml
index d447b3a3d..283e4fed6 100644
--- a/api/server-server/definitions/unsigned_pdu_base.yaml
+++ b/api/server-server/definitions/unsigned_pdu_base.yaml
@@ -64,13 +64,13 @@ properties:
         - type: object
           title: Event Hash
           example: {
-            "sha256": "abase64encodedsha256hashshouldbe43byteslong"
+            "sha256": "Base64EncodedSha256HashesShouldBe43BytesLong"
           }
           properties:
             sha256:
               type: string
               description: The event hash.
-              example: abase64encodedsha256hashshouldbe43byteslong
+              example: Base64EncodedSha256HashesShouldBe43BytesLong
           required: ['sha256']
   depth:
     type: integer
@@ -95,13 +95,13 @@ properties:
         - type: object
           title: Event Hash
           example: {
-            "sha256": "abase64encodedsha256hashshouldbe43byteslong"
+            "sha256": "Base64EncodedSha256HashesShouldBe43BytesLong"
           }
           properties:
             sha256:
               type: string
               description: The event hash.
-              example: abase64encodedsha256hashshouldbe43byteslong
+              example: Base64EncodedSha256HashesShouldBe43BytesLong
           required: ['sha256']
   redacts:
     type: string