Change QR ID to Offer ID

Author: JamesMBligh

open-qr-standard.md

@@ -33,8 +33,8 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
 |Code Provider|The system that represents the initiating side of the user journey.  This is the system that creates and publishes the QR Code.  For a point-of-sale payment this would be the merchant checkout system.|
 |Code Consumer|The system that represents the acceptance, or client, side of the user journey.  This is the system that scans and processes the QR Code.  For a point-of-sale payment this would be the customer’s mobile wallet application.|
 |QR Profile|A profile for defining the format of the various actions and meta data that can be transferred using this standard for a specific type of use case or user journey.|
-|Offer|The information about the profiles and capabilities associated with a specific QR Code.|
-|Session|An established connection between a QR Provider and a QR Consumer.|
+|Offer|Details about an offer that may be claimed by a QR Consumer.  Includes information about the profiles and capabilities associated with a specific QR Code.|
+|Session|An established connection (a claim on an Offer) between a QR Provider and a QR Consumer.|
 
 ## Generic Sequence Diagram
 
@@ -120,11 +120,11 @@ The Code Provider will publish a QR Code that MUST conform with the requirements
 
 This QR Code MUST contain a URL in the following format:
 
-`https://<provider base>/<QR ID>`
+`https://<provider base>/<Offer ID>`
 
 The Code Provider MUST provide a valid web page at the location specified by `<provider base>` with instructions for a user how the QR Code can be successfully used.
 
-The `<QR ID>` is used to obtain access to a data entity held by the Code Provider referred to in this standard as an `Offer`.  QR IDs MAY be single or multiple use depending on the use case being supported.
+The `<Offer ID>` is used to obtain access to a data entity held by the Code Provider referred to in this standard as an `Offer`.  Offer IDs MAY be single or multiple use depending on the use case being supported.
 
 The Code Provider SHOULD superimpose a logo on the QR code to help Customers recognise trusted brands.  This logo SHOULD be tested to ensure the logo does not introduce too much error to the QR Code and the QR Code remains readable. In situations where the effect of scanning a QR code is unclear the Code Provider SHOULD provide guidance as to how the QR Code can be successfully used.
 
@@ -142,9 +142,9 @@ Sessions MUST be single use.
 
 ## Offer and Session Endpoints
 
-The Code Provider MUST support an Offer Info endpoint that the Code Consumer can call to obtain information about the Offer using the QR ID obtained from the QR Code.  This endpoint SHOULD be idempotent and should not have side effects on the underlying Offer.
+The Code Provider MUST support an Offer Info endpoint that the Code Consumer can call to obtain information about the Offer using the Offer ID obtained from the QR Code.  This endpoint SHOULD be idempotent and should not have side effects on the underlying Offer.
 
-The Code Provider MUST support an Offer Claim endpoint that the Code Consumer can use to claim a Offer for use using a QR ID and thus establishing a Session.  This endpoint MUST provide a unique Session ID that can be used for subsequent interactions.
+The Code Provider MUST support an Offer Claim endpoint that the Code Consumer can use to claim a Offer for use using a Offer ID and thus establishing a Session.  This endpoint MUST provide a unique Session ID that can be used for subsequent interactions.
 
 The Code Provider MUST support a Session Status endpoint to identify the status of a Session using a Session ID.
 

profiles/core-profile.md

@@ -37,7 +37,7 @@ The supported discovery properties are:
 
 ### Offer Info Endpoint
 
-An API used to obtain information about the Offer associated with a nominated QR ID.
+An API used to obtain information about the Offer associated with a nominated Offer ID.
 
 #### HTTP Method
 
@@ -47,13 +47,13 @@ GET
 
 | Parameter | Optionality | Description |
 |-----------|-------------|-------------|
-|qr-id|REQUIRED|The QR ID that information is requested for.|
+|offer-id|REQUIRED|The Offer ID that information is requested for.|
 
 #### Error Responses
 
 HTTP Status: 401, Validation of the provided authorisation JWT failed
 
-HTTP Status: 422, The provided QR ID is not known
+HTTP Status: 422, The provided Offer ID is not known
 
 #### Successful Response
 
@@ -85,7 +85,7 @@ Successful response schema [JSONSchema]:
          "properties": {
             "qrId": {
                "type": "string",
-               "description": "The qr-id that the information was requested for"
+               "description": "The offer-id that the information was requested for"
             },
             "provider": {
                "type": "string",
@@ -107,11 +107,11 @@ Successful response schema [JSONSchema]:
             "expiryTime": {
                "type": "string",
                "format": "date-time",
-               "description": "The expiry time of the QR code.  After this time the qr-id cannot be used to claim a session "
+               "description": "The expiry time of the QR code.  After this time the offer-id cannot be used to claim a session "
             },
             "profiles": {
                "type": "object",
-               "description": "An object with details for each of the qr profiles supported by this qr-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
+               "description": "An object with details for each of the qr profiles supported by this offer-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
                "additionalProperties": false,
                "patternProperties": {
                   "^urn:.*$": {
@@ -133,7 +133,7 @@ Successful response schema [JSONSchema]:
 
 ### Offer Claim Endpoint
 
-An API used to claim an offer and establish a session under a specific QR Profile using a nominated QR ID.
+An API used to claim an offer and establish a session under a specific QR Profile using a nominated Offer ID.
 
 #### HTTP Method
 
@@ -143,7 +143,7 @@ POST
 
 | Parameter | Optionality | Description |
 |-----------|-------------|-------------|
-|qr-id|REQUIRED|The QR ID that an offer is to be claimed for.|
+|offer-id|REQUIRED|The Offer ID that an offer is to be claimed for.|
 
 #### Request
 
@@ -182,7 +182,7 @@ Request schema [JSONSchema]:
             },
             "profiles": {
                "type": "object",
-               "description": "An object with details for each of the qr profiles supported by this qr-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
+               "description": "An object with details for each of the qr profiles supported by this offer-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
                "additionalProperties": false,
                "patternProperties": {
                   "^urn:.*$": {
@@ -204,11 +204,11 @@ Request schema [JSONSchema]:
 
 #### Error Responses
 
-HTTP Status: 400, The specified QR Profile is not supported for this QR ID or the data provided was not valid
+HTTP Status: 400, The specified QR Profile is not supported for this Offer ID or the data provided was not valid
 
 HTTP Status: 401, Validation of the provided authorisation JWT failed
 
-HTTP Status: 422, The provided QR ID is not known
+HTTP Status: 422, The provided Offer ID is not known
 
 #### Successful Response
 
@@ -248,7 +248,7 @@ Successful response schema [JSONSchema]:
             },
             "profiles": {
                "type": "object",
-               "description": "An object with details for each of the qr profiles supported by this qr-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
+               "description": "An object with details for each of the qr profiles supported by this offer-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
                "additionalProperties": false,
                "patternProperties": {
                   "^urn:.*$": {
@@ -286,7 +286,7 @@ GET
 
 HTTP Status: 401, Validation of the provided authorisation JWT failed
 
-HTTP Status: 422, The provided QR ID is not known
+HTTP Status: 422, The provided Offer ID is not known
 
 #### Successful Response
 
@@ -326,7 +326,7 @@ Successful response schema [JSONSchema]:
             },
             "profiles": {
                "type": "object",
-               "description": "An object with details for each of the qr profiles supported by this qr-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
+               "description": "An object with details for each of the qr profiles supported by this offer-id.  Each property of this object uses the urn of the profile and contains properties defined by the qr profile that the urn denotes",
                "additionalProperties": false,
                "patternProperties": {
                   "^urn:.*$": {