Skip to content

Commit 588aa89

Browse files
authored
Update quizzes answers parameter skippable documentation (#222)
1 parent 243c51a commit 588aa89

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

cspell.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
"searchabilities",
4444
"forcesync",
4545
"forcedelta",
46-
"forcepatchdelta"
46+
"forcepatchdelta",
47+
"skippable"
4748
]
4849
}

src/modules/quizzes.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class Quizzes {
108108
* @description Retrieve quiz question from Constructor.io API
109109
* @param {string} quizId - The identifier of the quiz
110110
* @param {string} parameters - Additional parameters to refine result set
111-
* @param {array} parameters.answers - An array of answers in the format [[1,2],[1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true", "false", "seen" or empty string ("") if skipped
111+
* @param {array} parameters.answers - An array of answers in the format [[1,2],[1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true", "false", "seen" or empty string ("") if the question is skippable: i.e., configured as `is_skippable:true`.
112112
* @param {string} [parameters.section] - Product catalog section
113113
* @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
114114
* @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
@@ -186,7 +186,7 @@ class Quizzes {
186186
* @description Retrieve quiz recommendation and filter expression from Constructor.io API
187187
* @param {string} quizId - The identifier of the quiz
188188
* @param {string} parameters - Additional parameters to refine result set
189-
* @param {array} parameters.answers - An array of answers in the format [[1,2],[1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true", "false", "seen" or empty string ("") if skipped
189+
* @param {array} parameters.answers - An array of answers in the format [[1,2],[1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true", "false", "seen" or empty string ("") if the question is skippable: i.e., configured as `is_skippable:true`.
190190
* @param {string} [parameters.section] - Product catalog section
191191
* @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
192192
* @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}

0 commit comments

Comments
 (0)