From 130082910af07ab0ef46ddb62aa7eac6f389e338 Mon Sep 17 00:00:00 2001 From: Barbara Czyz Date: Thu, 10 Aug 2023 12:47:16 +0200 Subject: [PATCH 1/4] fix: DDOC-871: add info on params for mappings --- .../integration_mapping_partner_item_slack.yml | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/content/schemas/integration_mapping_partner_item_slack.yml b/content/schemas/integration_mapping_partner_item_slack.yml index 09ffeee9..ae4d385c 100644 --- a/content/schemas/integration_mapping_partner_item_slack.yml +++ b/content/schemas/integration_mapping_partner_item_slack.yml @@ -4,7 +4,11 @@ title: Integration mapping mapped item schema for type Slack type: object description: |- - The schema for an integration mapping mapped item object for type Slack + The schema for an integration mapping mapped item object for type Slack. + + Depending if Slack is installed at the organization or team level, + provide **either** `slack_org_id` **or** `slack_workspace_id`. + Do not use both parameters at the same time. properties: type: @@ -21,12 +25,16 @@ properties: slack_workspace_id: type: string example: 'T12352314' - description: ID of the Slack workspace with which the item is associated + description: ID of the Slack workspace with which the item is associated. + Use this parameter if Slack is installed at a team level. Do not + use `slack_org_id` at the same time. nullable: true slack_org_id: type: string example: 'E1234567' - description: ID of the Slack organization with which the item is associated + description: ID of the Slack organization with which the item is associated. + Use this parameter if Slack is installed at the organization level. + Do not use `slack_workspace_id` at the same time. nullable: true required: From 026d5db0fbeaf66f8abf50f18a0ab79bfc57d40f Mon Sep 17 00:00:00 2001 From: Barbara Czyz Date: Thu, 10 Aug 2023 15:04:26 +0200 Subject: [PATCH 2/4] review fixes --- content/schemas/integration_mapping_partner_item_slack.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/schemas/integration_mapping_partner_item_slack.yml b/content/schemas/integration_mapping_partner_item_slack.yml index ae4d385c..2db462ad 100644 --- a/content/schemas/integration_mapping_partner_item_slack.yml +++ b/content/schemas/integration_mapping_partner_item_slack.yml @@ -6,7 +6,7 @@ type: object description: |- The schema for an integration mapping mapped item object for type Slack. - Depending if Slack is installed at the organization or team level, + Depending if Box for Slack is installed at the org or workspace level, provide **either** `slack_org_id` **or** `slack_workspace_id`. Do not use both parameters at the same time. @@ -26,14 +26,14 @@ properties: type: string example: 'T12352314' description: ID of the Slack workspace with which the item is associated. - Use this parameter if Slack is installed at a team level. Do not + Use this parameter if Box for Slack is installed at a workspace level. Do not use `slack_org_id` at the same time. nullable: true slack_org_id: type: string example: 'E1234567' description: ID of the Slack organization with which the item is associated. - Use this parameter if Slack is installed at the organization level. + Use this parameter if Box for Slack is installed at the org level. Do not use `slack_workspace_id` at the same time. nullable: true From 30a5317d2a13e0dc8bc81d61a78ae237bb4caaf7 Mon Sep 17 00:00:00 2001 From: Barbara Czyz Date: Thu, 10 Aug 2023 15:09:09 +0200 Subject: [PATCH 3/4] rename organization > org --- content/schemas/integration_mapping_partner_item_slack.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/schemas/integration_mapping_partner_item_slack.yml b/content/schemas/integration_mapping_partner_item_slack.yml index 2db462ad..3adf065e 100644 --- a/content/schemas/integration_mapping_partner_item_slack.yml +++ b/content/schemas/integration_mapping_partner_item_slack.yml @@ -32,7 +32,7 @@ properties: slack_org_id: type: string example: 'E1234567' - description: ID of the Slack organization with which the item is associated. + description: ID of the Slack org with which the item is associated. Use this parameter if Box for Slack is installed at the org level. Do not use `slack_workspace_id` at the same time. nullable: true From 5b4ab5088df3b4c9fbfaa74d6c3a3a9cdb264c7f Mon Sep 17 00:00:00 2001 From: Barbara Czyz Date: Thu, 10 Aug 2023 15:58:49 +0200 Subject: [PATCH 4/4] Fix linter issues --- .spelling | 3 ++- content/schemas/integration_mapping_partner_item_slack.yml | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.spelling b/.spelling index c84505b9..1e693202 100644 --- a/.spelling +++ b/.spelling @@ -58,4 +58,5 @@ period uri url dropdown -special \ No newline at end of file +special +org \ No newline at end of file diff --git a/content/schemas/integration_mapping_partner_item_slack.yml b/content/schemas/integration_mapping_partner_item_slack.yml index 3adf065e..3ae20839 100644 --- a/content/schemas/integration_mapping_partner_item_slack.yml +++ b/content/schemas/integration_mapping_partner_item_slack.yml @@ -26,8 +26,8 @@ properties: type: string example: 'T12352314' description: ID of the Slack workspace with which the item is associated. - Use this parameter if Box for Slack is installed at a workspace level. Do not - use `slack_org_id` at the same time. + Use this parameter if Box for Slack is installed at a workspace level. + Do not use `slack_org_id` at the same time. nullable: true slack_org_id: type: string