Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid phoneNumber as query param - Blockchains Retrieval #60

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions code/API_definitions/blockchain-public-address.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ tags:
- name: Blockchain Public Address
description: API operations to manage Blockchain Public Addresses
paths:
/blockchain-public-addresses:
get:
/blockchain-public-addresses/retrieve-blockchains:
post:
tags:
- Blockchain Public Address
summary: Retrieves Blockchain Public Address associated with a mobile phone number.
Expand All @@ -60,8 +60,13 @@ paths:
- openId:
- blockchain-public-address:read
parameters:
- $ref: "#/components/parameters/PhoneNumber"
- $ref: "#/components/parameters/x-correlator"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PhoneNumber"
required: true
responses:
"200":
description: OK
Expand Down Expand Up @@ -104,6 +109,7 @@ paths:
$ref: "#/components/responses/Generic503"
"504":
$ref: "#/components/responses/Generic504"
/blockchain-public-addresses:
post:
tags:
- Blockchain Public Address
Expand All @@ -122,6 +128,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/BindBlockchainPublicAddressRequest"
required: true
responses:
"201":
description: Created
Expand Down Expand Up @@ -223,6 +230,15 @@ components:
schema:
type: string
schemas:
PhoneNumber:
type: object
description: Payload to retrieve the Blockchain Public Address(es) associated to a given Phone Number
required:
- phoneNumber
properties:
phoneNumber:
type: string
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 '+'.
BindBlockchainPublicAddressRequest:
type: object
description: Payload to request the Bind of the Blockchain Public Address
Expand Down Expand Up @@ -252,6 +268,7 @@ components:
- `ethereum` blockchain would be identified by `evm:1` value (i.e. ethereum mainnet).
- `polygon` blockchain would be identified by `evm:137` value (i.e. polygon mainnet).
- `celo` blockchain would be identified by `evm:42220` value (i.e. celo mainnet).
- `aleph zero` blockchain would be identified by `evm:41455` value (i.e. aleph zero evm).
- `bitcoin`: Representing Bitcoin L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
- `solana`: Representing Solana L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
- `cardano`: Representing Cardano L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
Expand Down Expand Up @@ -303,6 +320,7 @@ components:
- `ethereum` blockchain would be identified by `evm:1` value (i.e. ethereum mainnet).
- `polygon` blockchain would be identified by `evm:137` value (i.e. polygon mainnet).
- `celo` blockchain would be identified by `evm:42220` value (i.e. celo mainnet).
- `aleph zero` blockchain would be identified by `evm:41455` value (i.e. aleph zero evm).
- `bitcoin`: Representing Bitcoin L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
- `solana`: Representing Solana L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
- `cardano`: Representing Cardano L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
Expand Down