From 8099d97917244fad970aa53c2a6df0a1605f4784 Mon Sep 17 00:00:00 2001 From: William Godfrey Date: Wed, 13 Apr 2022 21:52:57 +0100 Subject: [PATCH 1/2] Fixing Subjects YAML Formatting --- docs/runner/events_list.rst | 2 +- docs/runner/subjects_count.rst | 4 ++-- docs/runner/subjects_create.rst | 20 ++++++++--------- docs/runner/subjects_create_b64.rst | 35 +++++++++++++++-------------- docs/runner/subjects_list.rst | 2 +- docs/runner/subjects_read.rst | 4 ++-- docs/runner/subjects_update.rst | 22 +++++++++--------- 7 files changed, 45 insertions(+), 44 deletions(-) diff --git a/docs/runner/events_list.rst b/docs/runner/events_list.rst index 3335189b..bacfffee 100644 --- a/docs/runner/events_list.rst +++ b/docs/runner/events_list.rst @@ -9,7 +9,7 @@ for which the authorised Application Registration has Event write access If :code:`asset_label` is not set, data for all assets is output. -:code:`props`, :code:`attrs` and :code:`asset_attrs`` are optional. +:code:`props`, :code:`attrs` and :code:`asset_attrs` are optional. This example lists all 'open door' events for the Courts of Justice Front Door. diff --git a/docs/runner/subjects_count.rst b/docs/runner/subjects_count.rst index 351e2137..81b29f34 100644 --- a/docs/runner/subjects_count.rst +++ b/docs/runner/subjects_count.rst @@ -5,9 +5,9 @@ Subjects Count Story Runner YAML Count all subjects that have the required signature. -The display_name is optional. +The :code:`display_name` is optional. -The 'print_response' setting should be specified as True in order to see the results. +The :code:`print_response` setting should be specified as :code:`True` in order to see the results. .. code-block:: yaml diff --git a/docs/runner/subjects_create.rst b/docs/runner/subjects_create.rst index 575f6563..5677b73f 100644 --- a/docs/runner/subjects_create.rst +++ b/docs/runner/subjects_create.rst @@ -3,7 +3,7 @@ Subjects Create Story Runner YAML ......................................... -'subject_label' is not required but if unspecified the created subject will +:code:`subject_label` is not required but if unspecified the created subject will not be accessible to later actions in the story. .. code-block:: yaml @@ -11,12 +11,12 @@ not be accessible to later actions in the story. --- steps: - step: - action: SUBJECTS_CREATE - description: Create a subjects entity. - print_response: true - subject_label: A subject - display_name: A subject - wallet_pub_keys: - - wallet_pub_key1 - tessera_pub_keys: - - tessera_pub_key2 + action: SUBJECTS_CREATE + description: Create a subjects entity. + print_response: true + subject_label: A subject + display_name: A subject + wallet_pub_keys: + - wallet_pub_key1 + tessera_pub_keys: + - tessera_pub_key2 diff --git a/docs/runner/subjects_create_b64.rst b/docs/runner/subjects_create_b64.rst index 02c12396..9daa78c3 100644 --- a/docs/runner/subjects_create_b64.rst +++ b/docs/runner/subjects_create_b64.rst @@ -3,7 +3,7 @@ Subjects Create From base64 Story Runner YAML ............................................. -'subject_label' is not required but if unspecified the created subject will +:code:`subject_label` is not required but if unspecified the created subject will not be accessible to later actions in the story. .. code-block:: yaml @@ -11,20 +11,21 @@ not be accessible to later actions in the story. --- steps: - step: - action: SUBJECTS_CREATE_FROM_B64 - description: Import a subjects entity. - print_response: true - subject_label: An imported subject - display_name: An imported subject - subject_string: eyJpZGVudGl0eSI6ICJzdWJqZWN0cy8wMDAwMDAwMC0wMDAwLTAwMDAtMDA - wMC0wMDAwMDAwMDAwMDAiLCAiZGlzcGxheV9uYW1lIjogIlNlbGYiLCAid2 - FsbGV0X3B1Yl9rZXkiOiBbIjA0YzExNzNiZjc4NDRiZjFjNjA3Yjc5YzE4Z - GIwOTFiOTU1OGZmZTU4MWJmMTMyYjhjZjNiMzc2NTcyMzBmYTMyMWEwODgw - YjU0YTc5YTg4YjI4YmM3MTBlZGU2ZGNmM2Q4MjcyYzUyMTBiZmQ0MWVhODM - xODhlMzg1ZDEyYzE4OWMiXSwgIndhbGxldF9hZGRyZXNzIjogWyIweDk5Rm - E0QUFCMEFGMkI1M2YxNTgwODNEOGYyNDRiYjQ1MjMzODgxOTciXSwgInRlc - 3NlcmFfcHViX2tleSI6IFsiZWZkZzlKMFFoU0IyZzRJeEtjYVhnSm1OS2J6 - cHhzMDNGRllJaVlZdWVraz0iXSwgInRlbmFudCI6ICIiLCAiY29uZmlybWF - 0aW9uX3N0YXR1cyI6ICJDT05GSVJNQVRJT05fU1RBVFVTX1VOU1BFQ0lGSU - VEIn0= + action: SUBJECTS_CREATE_FROM_B64 + description: Import a subjects entity. + print_response: true + subject_label: An imported subject + display_name: An imported subject + subject_string: >- + eyJpZGVudGl0eSI6ICJzdWJqZWN0cy8wMDAwMDAwMC0wMDAwLTAwMDAtMDA + wMC0wMDAwMDAwMDAwMDAiLCAiZGlzcGxheV9uYW1lIjogIlNlbGYiLCAid2 + FsbGV0X3B1Yl9rZXkiOiBbIjA0YzExNzNiZjc4NDRiZjFjNjA3Yjc5YzE4Z + GIwOTFiOTU1OGZmZTU4MWJmMTMyYjhjZjNiMzc2NTcyMzBmYTMyMWEwODgw + YjU0YTc5YTg4YjI4YmM3MTBlZGU2ZGNmM2Q4MjcyYzUyMTBiZmQ0MWVhODM + xODhlMzg1ZDEyYzE4OWMiXSwgIndhbGxldF9hZGRyZXNzIjogWyIweDk5Rm + E0QUFCMEFGMkI1M2YxNTgwODNEOGYyNDRiYjQ1MjMzODgxOTciXSwgInRlc + 3NlcmFfcHViX2tleSI6IFsiZWZkZzlKMFFoU0IyZzRJeEtjYVhnSm1OS2J6 + cHhzMDNGRllJaVlZdWVraz0iXSwgInRlbmFudCI6ICIiLCAiY29uZmlybWF + 0aW9uX3N0YXR1cyI6ICJDT05GSVJNQVRJT05fU1RBVFVTX1VOU1BFQ0lGSU + VEIn0= diff --git a/docs/runner/subjects_list.rst b/docs/runner/subjects_list.rst index a25f8071..78c56d1c 100644 --- a/docs/runner/subjects_list.rst +++ b/docs/runner/subjects_list.rst @@ -5,7 +5,7 @@ Subjects List Story Runner YAML List all subjects that have the required signature. -The 'print_response' setting should be specified as True in order to see the results. +The :code:`print_response` setting should be specified as :code:`True` in order to see the results. .. code-block:: yaml diff --git a/docs/runner/subjects_read.rst b/docs/runner/subjects_read.rst index 06df3cef..85e3b907 100644 --- a/docs/runner/subjects_read.rst +++ b/docs/runner/subjects_read.rst @@ -5,9 +5,9 @@ Subjects Read Story Runner YAML Read the specified subject. -'subject_label' is required. +:code:`subject_label` is required. -The 'print_response' setting should be specified as True in order to see the results. +The :code:`print_response` setting should be specified as :code:`True` in order to see the results. .. code-block:: yaml diff --git a/docs/runner/subjects_update.rst b/docs/runner/subjects_update.rst index c64ae333..31f664d0 100644 --- a/docs/runner/subjects_update.rst +++ b/docs/runner/subjects_update.rst @@ -13,14 +13,14 @@ optional but at least one must be specified. --- steps: - step: - action: SUBJECTS_UPDATE - description: Update a subjects entity. - print_response: true - subject_label: A subject - display_name: A subject - wallet_pub_keys: - - wallet_pub_key1 - - wallet_pub_key2 - tessera_pub_keys: - - tessera_pub_key1 - - tessera_pub_key2 + action: SUBJECTS_UPDATE + description: Update a subjects entity. + print_response: true + subject_label: A subject + display_name: A subject + wallet_pub_keys: + - wallet_pub_key1 + - wallet_pub_key2 + tessera_pub_keys: + - tessera_pub_key1 + - tessera_pub_key2 From 7623539a905cf17c137b542cd683244c4b35a970 Mon Sep 17 00:00:00 2001 From: William Godfrey Date: Thu, 14 Apr 2022 10:20:00 +0100 Subject: [PATCH 2/2] Fixing Multiline YAML --- functests/test_resources/subjects_story.yaml | 23 ++++++++++---------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/functests/test_resources/subjects_story.yaml b/functests/test_resources/subjects_story.yaml index 02405f78..2b08f533 100644 --- a/functests/test_resources/subjects_story.yaml +++ b/functests/test_resources/subjects_story.yaml @@ -17,17 +17,18 @@ steps: print_response: true subject_label: An imported subject display_name: An imported subject - subject_string: eyJpZGVudGl0eSI6ICJzdWJqZWN0cy8wMDAwMDAwMC0wMDAwLTAwMDAtMDA - wMC0wMDAwMDAwMDAwMDAiLCAiZGlzcGxheV9uYW1lIjogIlNlbGYiLCAid2 - FsbGV0X3B1Yl9rZXkiOiBbIjA0YzExNzNiZjc4NDRiZjFjNjA3Yjc5YzE4Z - GIwOTFiOTU1OGZmZTU4MWJmMTMyYjhjZjNiMzc2NTcyMzBmYTMyMWEwODgw - YjU0YTc5YTg4YjI4YmM3MTBlZGU2ZGNmM2Q4MjcyYzUyMTBiZmQ0MWVhODM - xODhlMzg1ZDEyYzE4OWMiXSwgIndhbGxldF9hZGRyZXNzIjogWyIweDk5Rm - E0QUFCMEFGMkI1M2YxNTgwODNEOGYyNDRiYjQ1MjMzODgxOTciXSwgInRlc - 3NlcmFfcHViX2tleSI6IFsiZWZkZzlKMFFoU0IyZzRJeEtjYVhnSm1OS2J6 - cHhzMDNGRllJaVlZdWVraz0iXSwgInRlbmFudCI6ICIiLCAiY29uZmlybWF - 0aW9uX3N0YXR1cyI6ICJDT05GSVJNQVRJT05fU1RBVFVTX1VOU1BFQ0lGSU - VEIn0= + subject_string: >- + eyJpZGVudGl0eSI6ICJzdWJqZWN0cy8wMDAwMDAwMC0wMDAwLTAwMDAtMDA + wMC0wMDAwMDAwMDAwMDAiLCAiZGlzcGxheV9uYW1lIjogIlNlbGYiLCAid2 + FsbGV0X3B1Yl9rZXkiOiBbIjA0YzExNzNiZjc4NDRiZjFjNjA3Yjc5YzE4Z + GIwOTFiOTU1OGZmZTU4MWJmMTMyYjhjZjNiMzc2NTcyMzBmYTMyMWEwODgw + YjU0YTc5YTg4YjI4YmM3MTBlZGU2ZGNmM2Q4MjcyYzUyMTBiZmQ0MWVhODM + xODhlMzg1ZDEyYzE4OWMiXSwgIndhbGxldF9hZGRyZXNzIjogWyIweDk5Rm + E0QUFCMEFGMkI1M2YxNTgwODNEOGYyNDRiYjQ1MjMzODgxOTciXSwgInRlc + 3NlcmFfcHViX2tleSI6IFsiZWZkZzlKMFFoU0IyZzRJeEtjYVhnSm1OS2J6 + cHhzMDNGRllJaVlZdWVraz0iXSwgInRlbmFudCI6ICIiLCAiY29uZmlybWF + 0aW9uX3N0YXR1cyI6ICJDT05GSVJNQVRJT05fU1RBVFVTX1VOU1BFQ0lGSU + VEIn0= - step: action: SUBJECTS_COUNT