Commit Graph

6 Commits

Author SHA1 Message Date
Jesse Poulos 6782976a48 Clarify "rich editor" and "link selection" api docs
Documentation was innacurrate surrounding the "text" query parameter.
Before this fix, the field was marked as optional; it is now required.
Furthermore, it was implied that one could highlight text and replace the
returned url would be used as a hyperlink for that text; now it states that
the highlighted text will be replaced. Another patchset will update these
same endpoints to state that resource selection is being deprecated in
place of content-item. This fix does not address that.

Test plan:
1) run localhost Canvas
2) build the API docs (docker-compose run --rm web bundle exec rake
doc:api)
3) navigate to <your host url>/doc/api/file.link_selection_tools.html and
<your host url>//doc/api/file.editor_button_tools.html
4) check for spelling, grammar, accuracy of information and that the new
link works

Fixes PLAT-1920

Change-Id: Ib2b563d3902935441f76f582112a99dd53d8d56d
Reviewed-on: https://gerrit.instructure.com/93869
Reviewed-by: Weston Dransfield <wdransfield@instructure.com>
QA-Review: August Thornton <august@instructure.com>
Reviewed-by: Andrew Butterfield <abutterfield@instructure.com>
Tested-by: Jenkins
Product-Review: Andrew Butterfield <abutterfield@instructure.com>
2016-11-09 20:59:58 +00:00
Jesse Poulos 6721d605b5 Add content item to API docs and add deprecation resource select
Resource selection (under "Editor Button" and "Link Selection") in the API
docs has been replaced by content item. This update adds content item
documentation and adds warnings the to the two resource selection sections
stating that they have been deprecated. The introduction page has also
been updated to reflect these changes

Test plan:
1) run localhost Canvas
2) build the API docs (docker-compose run --rm web bundle exec rake
doc:api)
3) navigate to the following:
<your host url>/doc/api/file.link_selection_tools.html
<your host url>/doc/api/file.editor_button_tools.html
<your host url>/doc/api/file.content_item.html
<your host url>/doc/api/file.editor_button_tools.html
<your host url>/doc/api/file.editor_button_tools.html
4) check for spelling, grammar, accuracy of information and that the new
link works

Fixes PLAT-1921

Change-Id: I62e5d8debb4ae8c00f5cbcca9009cde668adefab
Reviewed-on: https://gerrit.instructure.com/93897
Tested-by: Jenkins
Reviewed-by: Weston Dransfield <wdransfield@instructure.com>
Reviewed-by: Nathan Mills <nathanm@instructure.com>
QA-Review: August Thornton <august@instructure.com>
Product-Review: August Thornton <august@instructure.com>
2016-10-28 19:53:36 +00:00
Brad Humphrey 6fe9daca43 fixes improperly formatted external tool documentation
also modified the documentation for external tool configurations
to clarify how "environment" settings work

Test plan:

 - verify that underscores are displaying instead of italicizing content

Change-Id: Ie62d11018becdc9a5281f3d25907827814d3fb7d
Reviewed-on: https://gerrit.instructure.com/25191
Reviewed-by: Brad Humphrey <brad@instructure.com>
Product-Review: Brad Humphrey <brad@instructure.com>
QA-Review: Brad Humphrey <brad@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
2013-10-31 20:43:09 +00:00
Brad Humphrey 49c6521ad8 turning in homework from LTI tools
adds a new LTI extension, "content", that
defines the interaction for sending content from
a tool provider to the tool consumer.  This extension
will replace the "embed_content" and '"select_link"
selection_directives, as well as adding allowing
am external tool to submit content for a homework
submission.

also starts sending intended_use, return_types, return_url
and file_extensions as part of the LTI launch with the new
extension.

test plan:
- make sure the "more" tab only shows up when there are valid tools

- install at least one valid tool
  (make a homework_submission tool by taking the xml for
  a resource_selection tool and replace "resource_selection"
  with "homework_submission")
- click "more"
- make sure you can't submit the assignment when no
  resource has been selected

- set an assignment that only allows file uploads
- try selecting a url from the tool
- make sure it errors out

- set an assignment that only allows file uploads
- limit the file types
- try selecting a file with a non-supported file extension
- make sure it errors out

- set an assignment that only allows file uploads
- try selecting an invalid file from the tool
- try submitting the homework
- make sure it errors out gracefully

- set an assignment that only allows file uploads
- try selecting a file from the tool
- make sure the submission works correctly

- set an assignment that only allows urls
- try selecting a file from the tool
- make sure it errors out

- set an assignment that only allows urls
- try selecting a url from the tool
- make sure the submission works correctly

Change-Id: I8df682bc73087681159110ab02f77f0e5a2b3911
Reviewed-on: https://gerrit.instructure.com/13419
Tested-by: Jenkins <jenkins@instructure.com>
QA-Review: Adam Phillipps <adam@instructure.com>
Product-Review: Brad Humphrey <brad@instructure.com>
Reviewed-by: Bracken Mosbacker <bracken@instructure.com>
2013-03-27 14:52:12 +00:00
Bracken Mosbacker d728f925e2 extension tool launches default to settings from main tool
External Tool extension previously needed their own urls,
custom fields, and text. Now they use the settings from
the main tool config as the defaults. So an extension
only needs a hash to be enabled.

Test Plan:
 * Add a tool by xml that has custom parameters and that only has the enabled property in the course_navigation settings
 * Launch that tool and verify that it used the main tools launch url and custom parameters

closes #8786

Change-Id: If760bbfe5c1dc10814d2a4b900a53abceab08e2e
Reviewed-on: https://gerrit.instructure.com/11700
Tested-by: Jenkins <jenkins@instructure.com>
Reviewed-by: Brian Palmer <brianp@instructure.com>
2012-06-26 12:10:36 -06:00
Brian Palmer 4d70f07d9e rename doc/templates/rest to doc/api
test plan: run the doc:api rake task, verify the docs are still
generated

Change-Id: I9f372a8e68de1019619b452c14f1ebbb1895cecf
Reviewed-on: https://gerrit.instructure.com/7745
Tested-by: Hudson <hudson@instructure.com>
Reviewed-by: Brian Whitmer <brian@instructure.com>
2011-12-30 09:00:27 -07:00