Document unofficial `_separate_replies` search query param that we use

c2d86ec8 · Robert Knight · d95b36f3 · c2d86ec8
Commit c2d86ec8 authored Mar 12, 2021 by Robert Knight
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 1 deletion

api.js src/types/api.js +4 -1

No files found.
--- a/src/types/api.js
+++ b/src/types/api.js
@@ -152,6 +152,8 @@
 * @prop {number} [limit]
 * @prop {string} [order]
 * @prop {string} [sort]
+ * @prop {boolean} [_separate_replies] - Unofficial param that causes replies
+ *   to be returned in a separate `replies` field
 */
 /**
@@ -162,7 +164,8 @@
 * @typedef SearchResult
 * @prop {number} total
 * @prop {Annotation[]} rows
- * @prop {Annotation[]} [replies]
+ * @prop {Annotation[]} [replies] - Unofficial property that is populated if
+ *   `_separate_replies` query param was specified
 */
 // Make TypeScript treat this file as a module.