From f4fad5f764b06fc7652a3004cbb8f25a2a08159b Mon Sep 17 00:00:00 2001 From: Sahil Aujla Date: Mon, 1 Apr 2024 14:47:38 -0400 Subject: [PATCH] add context on signedturnkey request object to accounts api --- accounts/accounts.yaml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/accounts/accounts.yaml b/accounts/accounts.yaml index 57fffe80..0243cd36 100644 --- a/accounts/accounts.yaml +++ b/accounts/accounts.yaml @@ -312,26 +312,29 @@ components: type: string SignedTurnkeyRequest: type: object - description: The signed request object containing session information + description: > + The signed request object containing session information. It is used to ensure the integrity and authenticity of requests to our API. For detailed steps on how to create a stamped request refer to the [Turnkey Stamps Documentation](https://docs.turnkey.com/api-design/stamps). required: true properties: url: type: string - description: Generated by the turnkey client, but will be ignored on our end + description: Generated by the turnkey client, but will be ignored on our end. required: true body: type: string - description: JSON stringified request body + description: JSON stringified request body. required: true stamp: type: object + description: > + A JSON-encoded object containing stamping information. required: true properties: stampHeaderName: type: string - description: A header name of the approved authentication request + description: Header name of the approved authentication request. required: true stampHeaderValue: type: string - description: A header value of the approved authentication request + description: Header value of the approved authentication request. required: true