From 69c30ef15675fa3ece4a55c2ad1233022fcfa9b0 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 31 Aug 2018 21:11:11 +0100 Subject: [PATCH] spec the format of a client_secret --- api/identity/definitions/request_email_validation.yaml | 6 +++++- api/identity/definitions/request_msisdn_validation.yaml | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/api/identity/definitions/request_email_validation.yaml b/api/identity/definitions/request_email_validation.yaml index 805cd123..c8653456 100644 --- a/api/identity/definitions/request_email_validation.yaml +++ b/api/identity/definitions/request_email_validation.yaml @@ -20,7 +20,11 @@ example: { properties: client_secret: type: string - description: A unique string used to identify the validation attempt. + description: | + A unique string generated by the client, and used to identify the + validation attempt. It must be a string consisting of the characters + ``[0-9a-zA-Z.=_-]``. Its length must not exceed 255 characters and it + must not be empty. example: "monkeys_are_GREAT" email: type: string diff --git a/api/identity/definitions/request_msisdn_validation.yaml b/api/identity/definitions/request_msisdn_validation.yaml index f8e37d39..ee131660 100644 --- a/api/identity/definitions/request_msisdn_validation.yaml +++ b/api/identity/definitions/request_msisdn_validation.yaml @@ -21,7 +21,11 @@ example: { properties: client_secret: type: string - description: A unique string used to identify the validation attempt. + description: | + A unique string generated by the client, and used to identify the + validation attempt. It must be a string consisting of the characters + ``[0-9a-zA-Z.=_-]``. Its length must not exceed 255 characters and it + must not be empty. example: "monkeys_are_GREAT" country: type: string