Google AIP
The WaaS APIs follow the conventions established by Google's API Improvement Proposals (AIPs). This means that WaaS APIs exhibit resource-oriented design per AIP-121, providing individually-named resources (nouns) and the relationships and hierarchy that exist between them.
The resources provided by WaaS APIs are composable and interoperable. For example:
- The
Network
resource provided by the Blockchain Service is an argument to APIs in the Protocol Service and WalletService. - The
Key
resource provided by the Key Service is used by Wallet Service APIs.
Terminology
Consider the following string, which represents a BIP-32 HD Wallet in Wallet Service:
pools/{pool-identifier}/wallets/{wallet-identifier}
We parse this string as follows:
String | Resource | AIP Component |
---|---|---|
pools/{pool-identifier} | pool | resource name |
{pool-identifier} | pool | resource ID |
pools/{pool-identifier}/wallets/{wallet-identifier} | wallet | resource name |
{pool-identifier}/wallets/{wallet-identifier} | wallet | resource ID |
pools/{pool-identifier} | wallet | parent resource |
We use this terminology throughout our API documentation to disambiguate between different segments of a resource name.
info
Customers can set an identifier (as in pool-identifier
) to an arbitrary string. If not set, it defaults to a UUID.