Fixed typos

Addresses: #411
ConsumerDataStandardsAustralia · Aug 27, 2024 · 1237677 · 1237677
1 parent db35c06
commit 1237677
Show file tree

Hide file tree

Showing 12 changed files with 144 additions and 146 deletions.
diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md
@@ -17,7 +17,7 @@ Release notes for version v1.32.0 of the [CDR Standards](../../index.html).
 
 This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues):
 
-- [Standards Staging #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/XXX)
+- [Standards Staging #411 - Title](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/411)
 
 This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
 
@@ -33,9 +33,7 @@ This release addresses the following Decision Proposals published on [Standards]
 ## General Changes
 |Change|Description|Link|
 |------|-----------|----|
-| Change summary | [**Standards Staging #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/XXX): Change detail | [Standards section](../../#section)
-| Change summary | [**Standards Maintenance #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/XXX): Change detail | [Standards section](../../#section)
-| Change summary | [**Decision Proposal #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX): Change detail | [Standards section](../../#section)
+| Fix typos | [**Standards Staging #411**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/411): Fixed typos and formatting in multiple specification files (documentation) | N/A
 
 
 ## Introduction

diff --git a/swagger-gen/api/cds_admin.json b/swagger-gen/api/cds_admin.json
diff --git a/swagger-gen/api/cds_banking.json b/swagger-gen/api/cds_banking.json
diff --git a/swagger-gen/api/cds_banking_dp306.json b/swagger-gen/api/cds_banking_dp306.json
diff --git a/swagger-gen/api/cds_banking_non_bank_lending.json b/swagger-gen/api/cds_banking_non_bank_lending.json
diff --git a/swagger-gen/api/cds_common.json b/swagger-gen/api/cds_common.json
@@ -58,7 +58,7 @@
           {
             "name": "x-fapi-auth-date",
             "in": "header",
-            "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**.  Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
+            "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
             "schema": {
               "type": "string",
               "x-conditional": true
@@ -76,7 +76,7 @@
           {
             "name": "x-cds-client-headers",
             "in": "header",
-            "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.",
+            "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.",
             "schema": {
               "type": "string",
               "x-conditional": true,
@@ -192,7 +192,7 @@
           {
             "name": "x-fapi-auth-date",
             "in": "header",
-            "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**.  Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
+            "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
             "schema": {
               "type": "string",
               "x-conditional": true
@@ -210,7 +210,7 @@
           {
             "name": "x-cds-client-headers",
             "in": "header",
-            "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.",
+            "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.",
             "schema": {
               "type": "string",
               "x-conditional": true,
@@ -639,7 +639,7 @@
         "properties": {
           "lastUpdateTime": {
             "type": "string",
-            "description": "The date and time that this record was last updated by the customer.  If no update has occurred then this date should reflect the initial creation date for the data",
+            "description": "The date and time that this record was last updated by the customer. If no update has occurred then this date should reflect the initial creation date for the data",
             "x-cds-type": "DateTimeString"
           },
           "firstName": {
@@ -659,7 +659,7 @@
           },
           "prefix": {
             "type": "string",
-            "description": "Also known as title or salutation.  The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc)"
+            "description": "Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc)"
           },
           "suffix": {
             "type": "string",
@@ -740,15 +740,15 @@
           },
           "agentFirstName": {
             "type": "string",
-            "description": "The first name of the individual providing access on behalf of the organisation. For people with single names this field need not be present.  The single name should be in the lastName field"
+            "description": "The first name of the individual providing access on behalf of the organisation. For people with single names this field need not be present. The single name should be in the lastName field"
           },
           "agentLastName": {
             "type": "string",
             "description": "The last name of the individual providing access on behalf of the organisation. For people with single names the single name should be in this field"
           },
           "agentRole": {
             "type": "string",
-            "description": "The role of the individual identified as the agent who is providing authorisation.  Expected to be used for display. Default to Unspecified if the role is not known"
+            "description": "The role of the individual identified as the agent who is providing authorisation. Expected to be used for display. Default to Unspecified if the role is not known"
           },
           "businessName": {
             "type": "string",
@@ -772,7 +772,7 @@
           },
           "isACNCRegistered": {
             "type": "boolean",
-            "description": "True if registered with the ACNC.  False if not. Absent or null if not confirmed.",
+            "description": "True if registered with the ACNC. False if not. Absent or null if not confirmed.",
             "x-cds-type": "Boolean"
           },
           "industryCode": {
@@ -803,7 +803,7 @@
           },
           "registeredCountry": {
             "type": "string",
-            "description": "Enumeration with values from [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country codes.  Assumed to be AUS if absent",
+            "description": "Enumeration with values from [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country codes. Assumed to be AUS if absent",
             "x-cds-type": "ExternalRef"
           },
           "establishmentDate": {
@@ -1027,7 +1027,7 @@
         "properties": {
           "dpid": {
             "type": "string",
-            "description": "Unique identifier for an address as defined by Australia Post.  Also known as Delivery Point Identifier"
+            "description": "Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier"
           },
           "thoroughfareNumber1": {
             "type": "integer",
@@ -1036,7 +1036,7 @@
           },
           "thoroughfareNumber1Suffix": {
             "type": "string",
-            "description": "Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated"
+            "description": "Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated"
           },
           "thoroughfareNumber2": {
             "type": "integer",
@@ -1045,7 +1045,7 @@
           },
           "thoroughfareNumber2Suffix": {
             "type": "string",
-            "description": "Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated"
+            "description": "Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated"
           },
           "flatUnitType": {
             "type": "string",
@@ -1218,7 +1218,7 @@
       "RequestHeader_x-fapi-auth-date": {
         "name": "x-fapi-auth-date",
         "in": "header",
-        "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**.  Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
+        "description": "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
         "schema": {
           "type": "string",
           "x-conditional": true
@@ -1236,7 +1236,7 @@
       "RequestHeader_x-cds-client-headers": {
         "name": "x-cds-client-headers",
         "in": "header",
-        "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.",
+        "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.",
         "schema": {
           "type": "string",
           "x-conditional": true,

diff --git a/swagger-gen/api/cds_dcr.json b/swagger-gen/api/cds_dcr.json
@@ -550,7 +550,7 @@
               },
               "iat": {
                 "type": "integer",
-                "description": "The time at which the request was issued by the Data Recipient  expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC",
+                "description": "The time at which the request was issued by the Data Recipient expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC",
                 "example": 1571808167,
                 "x-cds-type": "ExternalRef"
               },

diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json
@@ -3995,7 +3995,7 @@
                   },
                   "thoroughfareNumber1Suffix": {
                     "type": "string",
-                    "description": "Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated"
+                    "description": "Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated"
                   },
                   "thoroughfareNumber2": {
                     "type": "integer",
@@ -4004,7 +4004,7 @@
                   },
                   "thoroughfareNumber2Suffix": {
                     "type": "string",
-                    "description": "Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated"
+                    "description": "Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated"
                   },
                   "flatUnitType": {
                     "type": "string",
@@ -4367,7 +4367,7 @@
 			},
 			"x-cds-client-headers": {
 				"name": "x-cds-client-headers",
-				"description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.",
+				"description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.",
 				"in": "header",
 				"required": false,
 				"x-conditional": true,

diff --git a/swagger-gen/api/cds_energy_sdh.json b/swagger-gen/api/cds_energy_sdh.json
@@ -1043,7 +1043,7 @@
                   },
                   "thoroughfareNumber1Suffix": {
                     "type": "string",
-                    "description": "Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated"
+                    "description": "Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated"
                   },
                   "thoroughfareNumber2": {
                     "type": "integer",
@@ -1052,7 +1052,7 @@
                   },
                   "thoroughfareNumber2Suffix": {
                     "type": "string",
-                    "description": "Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated"
+                    "description": "Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated"
                   },
                   "flatUnitType": {
                     "type": "string",

diff --git a/swagger-gen/api/cds_register.json b/swagger-gen/api/cds_register.json
@@ -507,7 +507,7 @@
           {
             "name": "x-v",
             "in": "header",
-            "description": "The version of the API end point requested by the client. Must be set to a positive integer.  For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained",
+            "description": "The version of the API end point requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained",
             "schema": {
               "type": "string",
               "default": "1"
@@ -1008,7 +1008,7 @@
           },
           "response_types_supported": {
             "type": "array",
-            "description": "JSON array containing a list of the OAuth 2.0 response_type values that the CDR Registrer supports",
+            "description": "JSON array containing a list of the OAuth 2.0 _response_type_ values that the CDR Register supports.",
             "items": {
               "type": "string"
             }
@@ -1298,7 +1298,7 @@
           "arbn": {
             "maxLength": 9,
             "type": "string",
-            "description": "Australian Registered Body Number.  ARBNs are issued to registrable Australian bodies and foreign companies"
+            "description": "Australian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies"
           }
         }
       },
@@ -1679,7 +1679,7 @@
           "arbn": {
             "maxLength": 9,
             "type": "string",
-            "description": "Australian Registered Body Number.  ARBNs are issued to registrable Australian bodies and foreign companies"
+            "description": "Australian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies"
           },
           "anzsicDivision": {
             "maxLength": 100,

diff --git a/swagger-gen/api/cds_register_banking_non_bank_lending.json b/swagger-gen/api/cds_register_banking_non_bank_lending.json
@@ -306,7 +306,7 @@
           {
             "name": "x-v",
             "in": "header",
-            "description": "The version of the API end point requested by the client. Must be set to a positive integer.  For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained",
+            "description": "The version of the API end point requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained",
             "schema": {
               "type": "string",
               "default": "1"
@@ -590,7 +590,7 @@
           "arbn": {
             "maxLength": 9,
             "type": "string",
-            "description": "Australian Registered Body Number.  ARBNs are issued to registrable Australian bodies and foreign companies"
+            "description": "Australian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies"
           }
         }
       },
@@ -693,7 +693,7 @@
           "arbn": {
             "maxLength": 9,
             "type": "string",
-            "description": "Australian Registered Body Number.  ARBNs are issued to registrable Australian bodies and foreign companies"
+            "description": "Australian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies"
           },
           "anzsicDivision": {
             "maxLength": 100,