From 19306110557243a8c5153c79036cb950fb2fa615 Mon Sep 17 00:00:00 2001 From: Rachael Thomas Date: Thu, 2 Jan 2025 13:37:10 -0700 Subject: [PATCH 1/4] First pass through for initial clean up --- content/reference.mdx | 214 +++++++++++++++++++++--------------------- 1 file changed, 106 insertions(+), 108 deletions(-) diff --git a/content/reference.mdx b/content/reference.mdx index 96db7da8..1eb72fd4 100644 --- a/content/reference.mdx +++ b/content/reference.mdx @@ -310,7 +310,7 @@ Resources that return multiple entities support the same cursor-based pagination /> @@ -585,29 +585,30 @@ The workflow trigger endpoint enforces the following payload size limits: @@ -675,27 +676,28 @@ The workflow trigger endpoint enforces the following payload size limits: @@ -834,27 +836,27 @@ A message is a notification delivered on a particular channel to a user. /> @@ -1290,7 +1292,7 @@ Returns a `404 Not Found` error for a message outside the account's retention wi /> @@ -1432,7 +1434,7 @@ Returns a `404 Not Found` error for a message outside the account's retention wi @@ -1761,42 +1763,42 @@ For in-app channels, messages can be updated indefinitely via this operation. Fo @@ -2048,37 +2050,37 @@ along with a user token to make this request** /> @@ -2103,14 +2105,15 @@ A user represents an individual who may need to receive a notification from Knoc name="id" type="string" description="Unique identifier for the user" + isRequired /> - - - - + + + + The locale of the user. Used for @@ -2121,7 +2124,7 @@ A user represents an individual who may need to receive a notification from Knoc /> @@ -2226,29 +2229,21 @@ Identifying a user will create or update a user in Knock, merging the properties ### Body parameters - - + + The locale of the user. Used for @@ -2259,7 +2254,7 @@ Identifying a user will create or update a user in Knock, merging the properties /> @@ -2276,13 +2271,13 @@ Identifying a user will create or update a user in Knock, merging the properties /> @@ -2482,63 +2477,63 @@ Messages outside the account's retention window will not be included in the resu /> @@ -2832,7 +2827,7 @@ when sending [Slack notifications](/integrations/slack). /> The locale of the object. Used for @@ -2843,7 +2838,7 @@ when sending [Slack notifications](/integrations/slack). /> @@ -3118,63 +3113,63 @@ Messages outside the account's retention window will not be included in the resu /> @@ -3271,7 +3266,7 @@ Sets an object within a collection, performing an upsert operation. Any existing The locale of the object. Used for @@ -3282,7 +3277,7 @@ Sets an object within a collection, performing an upsert operation. Any existing /> @@ -3300,13 +3295,13 @@ Sets an object within a collection, performing an upsert operation. Any existing /> @@ -3868,7 +3863,7 @@ Adds one or more recipients as subscribers to the object by creating subscriptio /> @@ -5138,13 +5133,13 @@ A schedule allows you to automatically trigger a workflow at a given time for on description="A list of one or more repeat definitions that determine when this schedule should run." /> @@ -5246,8 +5241,9 @@ Returns a paginated list of schedules in descending order. /> Date: Thu, 2 Jan 2025 13:51:15 -0700 Subject: [PATCH 2/4] Add required tag for cancellation_key --- content/reference.mdx | 1 + content/send-notifications/canceling-workflows.mdx | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/content/reference.mdx b/content/reference.mdx index 1eb72fd4..1a4defe3 100644 --- a/content/reference.mdx +++ b/content/reference.mdx @@ -763,6 +763,7 @@ The workflow cancellation endpoint enforces the following payload size limits: name="cancellation_key" type="string" description="The cancellation key unique to the trigger call" + isRequired /> Date: Fri, 3 Jan 2025 15:09:10 -0700 Subject: [PATCH 3/4] Add missing required tags --- content/reference.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/content/reference.mdx b/content/reference.mdx index 1a4defe3..4892ff4f 100644 --- a/content/reference.mdx +++ b/content/reference.mdx @@ -2663,6 +2663,7 @@ Merges the two users together, merging the user specified in the `from_user_id` name="from_user_id" type="string" description="Unique identifier of the user to merge from" + isRequired /> @@ -2712,6 +2713,7 @@ Identifies up to 1000 users at a time. Returns a `BulkOperation` that executes t type="User[]" description="A list of users to upsert" typeSlug="#users" + isRequired /> @@ -2770,6 +2772,7 @@ Deletes up to 1000 users at a time. Returns a `BulkOperation` that executes the name="user_ids" type="string[]" description="Unique identifiers of the users to delete" + isRequired /> @@ -3420,6 +3423,7 @@ Bulk sets up to 1000 objects at a time within a collection. Returns a `BulkOpera name="objects[].id" type="string" description="The id of the object to set." + isRequired /> @@ -3861,6 +3866,7 @@ Adds one or more recipients as subscribers to the object by creating subscriptio type="RecipientIdentifier[]" description="A list of recipient identifiers. You can subscribe up to 100 recipients to an object at a time." typeSlug="/concepts/recipients#recipientidentifier-definition" + isRequired /> @@ -4036,6 +4043,7 @@ Removes one or more recipients as subscribers to the object. type="RecipientIdentifier[]" description="A list of recipient identifiers" typeSlug="/concepts/recipients#recipientidentifier-definition" + isRequired /> @@ -4738,6 +4746,7 @@ Please note: This is a destructive operation and will replace any existing users name="user_ids" type="string[]" description="A list of user ids to set preferences for" + isRequired /> + From be74b33b7911509548987993bd8135399da5a6c4 Mon Sep 17 00:00:00 2001 From: Rachael Thomas Date: Thu, 9 Jan 2025 17:29:49 -0700 Subject: [PATCH 4/4] Update --- content/reference.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/content/reference.mdx b/content/reference.mdx index 4892ff4f..3afff426 100644 --- a/content/reference.mdx +++ b/content/reference.mdx @@ -5555,6 +5555,7 @@ Creates new schedules for the recipients provided. Up to 100 recipients may be s type="RecipientIdentifier[]" description="A list of recipient identifiers" typeSlug="/concepts/recipients#recipientidentifier-definition" + isRequired /> @@ -6019,6 +6024,7 @@ If no user exists in the current environment for the given :user_id, Knock will .

} + isRequired /> @@ -6193,6 +6199,7 @@ If no object exists in the current environment for the given :collection and :ob .

} + isRequired /> @@ -6444,6 +6451,7 @@ A `BulkOperation` name="access_token_object" type="AccessTokenObject" description="An object containing the `object_id` and `collection` of the Object or Tenant that contains the access token for Slack." + isRequired /> @@ -6542,6 +6550,7 @@ Get a list of the Slack channels for the access token stored in the given access name="access_token_object" type="AccessTokenObject" description="An object containing the `object_id` and `collection` of the Object or Tenant that contains the access token for Slack." + isRequired /> @@ -6855,6 +6865,7 @@ Adds members to an audience. The same user can be added to the audience multiple name="members" type="object[]" description="Members to add to the audience. The `tenant` field is optional. Max length is 1000." + isRequired /> @@ -6933,6 +6944,7 @@ Removes members from an audience. If a member was added with a tenant ID, that t name="members" type="object[]" description="Members to remove from the audience. The `tenant` field is optional. Max length is 1000." + isRequired />