update external tools API documentation for resource_selection

clarify the interaction between it and not_selectable

closes #LA-100

Change-Id: I90f9e2cda08c8b443801ed093a6183f39cbb04a1
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/228340
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Clint Furse <cfurse@instructure.com>
QA-Review: James Williams <jamesw@instructure.com>
Product-Review: James Williams <jamesw@instructure.com>
This commit is contained in:
James Williams 2020-02-28 09:13:07 -07:00
parent 6f4226498c
commit 27abcefdb3
1 changed files with 5 additions and 2 deletions

View File

@ -811,7 +811,9 @@ class ExternalToolsController < ApplicationController
# The url of the external tool
#
# @argument resource_selection[enabled] [Boolean]
# Set this to enable this feature
# Set this to enable this feature. If set to false,
# not_selectable must also be set to true in order to hide this tool
# from the selection UI in modules and assignments.
#
# @argument resource_selection[icon_url] [String]
# The url of the icon to show in the module external tool list
@ -839,7 +841,8 @@ class ExternalToolsController < ApplicationController
# "by_url"
#
# @argument not_selectable [Boolean]
# Default: false, if set to true the tool won't show up in the external tool
# Default: false. If set to true, and if resource_selection is set to false,
# the tool won't show up in the external tool
# selection UI in modules and assignments
#
# @argument oauth_compliant [Boolean]