Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: DDOC-871: add info on params for mappings #343

Merged
merged 5 commits into from
Aug 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,5 @@ period
uri
url
dropdown
special
special
org
14 changes: 11 additions & 3 deletions content/schemas/integration_mapping_partner_item_slack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

properties:
type:
Expand All @@ -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 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
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

required:
Expand Down