From 7ff79245c70fc86aa32122e1d25f1f0f771df720 Mon Sep 17 00:00:00 2001 From: Ken Date: Thu, 16 Nov 2023 18:30:52 +0800 Subject: [PATCH] chore: add wording for period inclusion of unstable fields --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7577d4f..354c434 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ of the returned object. Note that due to end-to-end encryption, FormSG servers are unable to verify the data format. However, the `decrypt` function exposed by this library [validates](https://github.com/opengovsg/formsg-javascript-sdk/blob/master/src/util/validate.ts) the decrypted content and will **return `null` if the -decrypted content does not fit the schema displayed below.** +decrypted content does not contain all of the fields displayed in the schema below.** | Key | Type | Description | | ----------- | -------- | -------------------------------------------------------------------------------------------------------- | @@ -146,6 +146,8 @@ decrypted content does not fit the schema displayed below.** | fieldType | string | The type of field for the question. | | \_id | string | A unique identifier of the form field. WARNING: Changes when new fields are created/removed in the form. | +Additional internal fields may be included from time to time, which will then be published above once it is stable for public consumption. + The full schema can be viewed in [`validate.ts`](https://github.com/opengovsg/formsg-javascript-sdk/tree/master/src/util/validate.ts).