From b6f029b87ba23033c8bfdf37639aee5aefb794d7 Mon Sep 17 00:00:00 2001 From: Tim Hawbaker Date: Sun, 22 Oct 2023 12:57:09 -0700 Subject: [PATCH] update swagger spec --- .../public/v1/public_api.swagger.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/http/src/__generated__/services/coordinator/public/v1/public_api.swagger.json b/packages/http/src/__generated__/services/coordinator/public/v1/public_api.swagger.json index 6f725040b..f62f3d673 100644 --- a/packages/http/src/__generated__/services/coordinator/public/v1/public_api.swagger.json +++ b/packages/http/src/__generated__/services/coordinator/public/v1/public_api.swagger.json @@ -24,15 +24,15 @@ }, { "name": "Wallets", - "description": "Wallets contain collections of deterministically generated cryptographic public / private key pairs that share a common seed. Turnkey securely holds the common seed, but only you can access it. In most cases, Wallets should be preferred over Private Keys since they can be represented by a mnemonic phrase, used across a variety of cryptographic curves, and can derive many addresses." + "description": "Wallets contain collections of deterministically generated cryptographic public / private key pairs that share a common seed. Turnkey securely holds the common seed, but only you can access it. In most cases, Wallets should be preferred over Private Keys since they can be represented by a mnemonic phrase, used across a variety of cryptographic curves, and can derive many addresses.\n\nDerived addresses can be used to create digital signatures using the corresponding underlying private key. See [Signers](./api#tag/Signers) for more information" }, { - "name": "Signatures", - "description": "Signatures are used to validate the authenticity and integrity of a digital message. Signatures are a fundamental building block in blockchains. Turnkey makes it easy to produce signatures by allowing you to sign with an address. If Turnkey doesn't yet support an address format you need, you can generate and sign with the public key instead by using the address format `ADDRESS_FORMAT_COMPRESSED`." + "name": "Signers", + "description": "Signers allow you to create digitial signatures. Signatures are used to validate the authenticity and integrity of a digital message. Turnkey makes it easy to produce signatures by allowing you to sign with an address. If Turnkey doesn't yet support an address format you need, you can generate and sign with the public key instead by using the address format `ADDRESS_FORMAT_COMPRESSED`." }, { "name": "Private Keys", - "description": "Private Keys are cryptographic public / private key pairs that can be used for cryptocurrency needs or more generalized encryption. Turnkey securely holds all Private Key materials for you, but only you can access them." + "description": "Private Keys are cryptographic public / private key pairs that can be used for cryptocurrency needs or more generalized encryption. Turnkey securely holds all private key materials for you, but only you can access them.\n\nThe Private Key ID or any derived address can be used to create digital signatures. See [Signers](./api#tag/Signers) for more information" }, { "name": "Private Key Tags", @@ -449,7 +449,7 @@ } } ], - "tags": ["Who am I?"] + "tags": ["Sessions"] } }, "/public/v1/submit/approve_activity": { @@ -1249,7 +1249,7 @@ } } ], - "tags": ["Signatures"] + "tags": ["Signers"] } }, "/public/v1/submit/sign_transaction": { @@ -1281,7 +1281,7 @@ } } ], - "tags": ["Signatures"] + "tags": ["Signers"] } }, "/public/v1/submit/update_allowed_origins": { @@ -5777,7 +5777,7 @@ }, { "name": "PRIVATE KEYS", - "tags": ["Wallets", "Signatures", "Private Keys", "Private Key Tags"] + "tags": ["Wallets", "Signers", "Private Keys", "Private Key Tags"] }, { "name": "USERS", @@ -5785,7 +5785,7 @@ }, { "name": "CREDENTIALS", - "tags": ["Authenticators", "API Keys", "Who am I?"] + "tags": ["Authenticators", "API Keys", "Sessions"] }, { "name": "ACTIVITIES",