3792afc12e
Adds the @deprecated_method, @deprecated_argument, and
@deprecated_response_field tags for API documentation. Also adds the
'deprecated', 'deprecation_notice', 'deprecation_effective', and
'deprecation_description' attributes for the API models and their
properties.
closes GRADE-1450
Test Plan:
1. Read the deprecation_README provided in this commit and verify you
can deprecate methods, arguments, response fields, models, and
model attributes. This verificiation process should include:
- Verifying the `rake doc:api` command throws an error when invalid
and/or missing parameters are used for the deprecation tags
- Verifying the deprecations show up in the generated documentation
(located at public/doc/api/index.html) after running
`rake doc:api`.
2. Verify the @argument, @response_field, and @model tags still work
and generate appropriate documentation when running `rake doc:api`
Change-Id: If6c2b0ee9fccbbd202990d8835c6266017e2dfa5
Reviewed-on: https://gerrit.instructure.com/138581
Reviewed-by: Gary Mei <gmei@instructure.com>
Reviewed-by: Derek Bender <djbender@instructure.com>
QA-Review: Gary Mei <gmei@instructure.com>
Tested-by: Jenkins
Product-Review: Simon Williams <simon@instructure.com>
|
||
|---|---|---|
| .github | ||
| Gemfile.d | ||
| app | ||
| bin | ||
| build | ||
| client_apps | ||
| config | ||
| db/migrate | ||
| doc | ||
| docker-compose | ||
| frontend_build | ||
| gems | ||
| jest | ||
| lib | ||
| packages | ||
| pact | ||
| public | ||
| script | ||
| spec | ||
| .babelrc | ||
| .bowerrc | ||
| .codeclimate.yml | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .i18nignore | ||
| .i18nrc | ||
| .jshintrc | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierrc | ||
| .rubocop.yml | ||
| .selinimumignore | ||
| .stylelintrc | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| COPYRIGHT | ||
| Dockerfile | ||
| Dockerfile-production | ||
| Gemfile | ||
| LICENSE | ||
| README.md | ||
| Rakefile | ||
| bower.json | ||
| code_of_conduct.md | ||
| config.ru | ||
| docker-compose.jenkins.yml | ||
| docker-compose.override.yml | ||
| docker-compose.yml | ||
| gulpfile.js | ||
| issue_template.md | ||
| jest.config.js | ||
| karma.conf.js | ||
| package.json | ||
| schema.graphql | ||
| webpack.config.js | ||
| webpack.production.config.js | ||
| webpack.test.config.js | ||
| yarn.lock | ||
README.md
Canvas LMS
Canvas is a modern, open-source LMS developed and maintained by Instructure Inc. It is released under the AGPLv3 license for use by anyone interested in learning more about or using learning management systems.
Please see our main wiki page for more information
Installation
Detailed instructions for installation and configuration of Canvas are provided on our wiki.