canvas-lms/script/generate_lti_variable_subst...

#! /bin/sh

bundle exec yardoc --verbose --tag launch_parameter:"Launch Parameter" --tag duplicates:"Duplicates" --tag internal -n -e doc/yard_plugins/lti_variable_expansion_plugin.rb lib/lti/variable_expander.rb
Better LTI Variable Substitution Docs Generate LTI Variable Substitution Docs from the code Uses YARD's plugin hooks to generate the markdown. I couldn't find a good way to do this with YARDs builtin generation stuff. So I hacked together. No pretty, but gets the job done. You can update the generated markdown by running this ``` script/generate_lti_variable_subustition_markdown ``` Our yard templates, dont process markdown files like YARD is supposed to.i Not sure why? :shrug: Fixes https://github.com/instructure/canvas-lms/issues/592 Change-Id: If0728d357dc745d81381e818ed62d087d76f0e66 Reviewed-on: https://gerrit.instructure.com/74312 Reviewed-by: Andrew Butterfield <abutterfield@instructure.com> QA-Review: August Thornton <august@instructure.com> Tested-by: Jenkins Product-Review: Brad Horrocks <bhorrocks@instructure.com> 2016-03-11 12:49:32 +08:00			`#! /bin/sh`

add permissions variable expansion also keeps it undocumented for now test plan: * test an lti launch in a course using a variable in the format: $Canvas.membership.permissions<permission1,permission2,..> with a comma-separated list in between the brackets corresponding to course-level permissions (see doc/api/roles.html#method.role_overrides.show), e.g. $Canvas.membership.permissions<read_forum,moderate_forum> these are the list of permissions to check when the variable is expanded it should substitute it with a comma-separated list of permissions filtered to those that the user has been granted within the course closes #PLYT-1796 Change-Id: I1c039e04318fcfe8ca5ee450e608bd3fb2affe6b Reviewed-on: https://gerrit.instructure.com/194797 Tested-by: Jenkins QA-Review: Nathan Mills <nathanm@instructure.com> Product-Review: James Williams <jamesw@instructure.com> Reviewed-by: Nathan Mills <nathanm@instructure.com> Reviewed-by: Marc Phillips <mphillips@instructure.com> 2019-05-23 04:18:31 +08:00			`bundle exec yardoc --verbose --tag launch_parameter:"Launch Parameter" --tag duplicates:"Duplicates" --tag internal -n -e doc/yard_plugins/lti_variable_expansion_plugin.rb lib/lti/variable_expander.rb`