Merge pull request #71 from NHSDigital/mm-mesh-967-typos

mesh-967: fix a some small typographic errors

Author: matt-mercer

.github/CODEOWNERS

@@ -1 +1 @@
-* @alisonkinloch-nhs @mattmercer-nhs @nhsdigital/mesh-to-cloud-admins
+* @alisonkinloch-nhs @matt-mercer @nhsdigital/mesh-to-cloud-admins

specification/mesh-api.yaml

@@ -104,7 +104,7 @@ info:
 
     In the Digital Onboarding Service there are specific sections to be completed to show your solution meets our non-functional requirements and technical conformance.
 
-    You would need to organise a date with the assurance team for the witness testing to take place. The witness testing should take half a day. In some cases you will be asked to prepare test data a few days before the day of the witness testing.
+    You will need to organise a date with the assurance team for the witness testing to take place. The witness testing should take half a day. In some cases you will be asked to prepare test data a few days before the day of the witness testing.
 
     Once the witness test is complete, you will be issued with a technical conformance certificate.
 
@@ -114,7 +114,7 @@ info:
 
     Now that we know that your software is safe and secure, you will need to sign a connection agreement.
 
-    We will send you a customised connection agreemen to sign.
+    We will send you a customised connection agreement to sign.
 
     Once you’ve signed the connection agreement, you need to upload it to your developer account in the ‘Legal agreement’ section.
 
@@ -212,7 +212,7 @@ info:
 
     **Notes**
     - the API rejects the request if the `timestamp` supplied is not within 2 hours of the server time
-    - in the example below `HMACSECRETKEY` has been `[REDACTED]`, this is the 'environment shared secret' which you received as part of creating your mailbox
+    - in the example below `SHARED_KEY` has been `[REDACTED]`, this is the 'environment shared secret' which you received as part of creating your mailbox
 
     ### Example implementation
     Here is an implementation of the above in `python3`.
@@ -222,11 +222,11 @@ info:
     import uuid
     import datetime from hashlib
     import sha256
-
+    
     AUTHSCHEMANAME = "NHSMESH " # Note: Space at the end of the schema.
-    HMACSECRETKEY = "[REDACTED]" # Note: Don't hard code your passwords in a real implementation.
-
-    def buildmeshauthorizationheader(mailboxid: str, password: str = "password", nonce: str = None, noncecount: int = 0):
+    SHARED_KEY = "[REDACTED]" # Note: Don't hard code your passwords in a real implementation.
+    
+    def build_auth_header(mailbox_id: str, password: str = "password", nonce: str = None, noncecount: int = 0):
       """ Generate MESH Authorization header for mailboxid. """
       #Generate a GUID if required.
       if not nonce:
@@ -239,15 +239,15 @@ info:
       hmac_msg = mailbox_id + ":" + nonce + ":" + str(nonce_count) + ":" + password + ":" + timestamp
       
       #HMAC is a standard crypto hash method built in the python standard library.
-      hash_code = hmac.HMAC(HMAC_SECRET_KEY.encode(), hmac_msg.encode(), sha256).hexdigest()
+      hash_code = hmac.HMAC(SHARED_KEY.encode(), hmac_msg.encode(), sha256).hexdigest()
       return (
         AUTH_SCHEMA_NAME # Note: No colon between 1st and 2nd elements.
         + mailbox_id + ":"
         + nonce + ":"
         + str(nonce_count) + ":"
         + timestamp+ ":"
         + hash_code
-    )
+      )
     ```
 
     ## MESH API pseudocode