API aligment with Commonalities

code/API_definitions/blockchain_public_address.yaml → code/API_definitions/blockchain-public-address.yaml

@@ -21,25 +21,20 @@ info:
     # Further Info and Support
 
     (FAQs will be added in a later version of the documentation)
-  termsOfService: http://swagger.io/terms/
-  contact:
-    email: [email protected]
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.2.0-wip
+  version: wip
+  x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/
 servers:
-  - url: "{apiRoot}/{basePath}"
+  - url: "{apiRoot}/blockchain-public-address/vwip"
     variables:
       apiRoot:
         default: http://localhost:9091
-        description: API root
-      basePath:
-        default: blockchain-public-address/v0
-        description: Base path for the Blockchain Public Address API
+        description: API root, defined by the service provider
 tags:
   - name: Blockchain Public Address
     description: API operations to manage Blockchain Public Addresses
@@ -215,7 +210,7 @@ components:
     PhoneNumber:
       name: phoneNumber
       in: query
-      description: A mobile phone number belonging to the user. In order to be globally unique it has to be formatted in international format, according to E.164 standard, optionally prefixed with '+'.
+      description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
       required: true
       schema:
         type: string
@@ -230,7 +225,7 @@ components:
       properties:
         phoneNumber:
           type: string
-          description: Mobile phone number to which the Blockchain Public Address will be bound. In order to be globally unique it has to be formatted in international format, according to E.164 standard, optionally prefixed with '+'.
+          description: Mobile phone number to which the Blockchain Public Address will be bound. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
         blockchainPublicAddress:
           type: string
           description: User's Blockchain Public Address to bind to the mobile `phoneNumber`