ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

change api doc examples to be https instead of http 

closes CNVS-3912

test plan
- api docs should be updated and display

Change-Id: Ie6d4c80b91e3e3c8cee4b6d2e93c000f1040fd35
Reviewed-on: https://gerrit.instructure.com/25657
Reviewed-by: Cody Cutrer <cody@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
Product-Review: Rob Orton <rob@instructure.com>
QA-Review: Rob Orton <rob@instructure.com>
This commit is contained in:
Rob Orton 2013-10-25 11:51:23 -06:00
parent e099fdf432
commit fc80fa2b77
15 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/coffeescripts/models/DiscussionTopic.coffee
View File

@ -89,7 +89,7 @@ define [
##
# this is for getting the topic 'full view' from the api
# see: http://<canvas>/doc/api/discussion_topics.html#method.discussion_topics_api.view
# see: https://<canvas>/doc/api/discussion_topics.html#method.discussion_topics_api.view
fetchEntries: ->
baseUrl = _.result this, 'url'
$.get "#{baseUrl}/view", ({unread_entries, forced_entries, participants, view: entries}) =>

6
app/controllers/appointment_groups_controller.rb
View File

@ -252,7 +252,7 @@ class AppointmentGroupsController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/appointment_groups.json' \
# curl 'https://<canvas>/api/v1/appointment_groups.json' \
# -X POST \
# -F 'appointment_group[context_codes][]=course_123' \
# -F 'appointment_group[sub_context_codes][]=course_section_234' \
@ -360,7 +360,7 @@ class AppointmentGroupsController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/appointment_groups/543.json' \
# curl 'https://<canvas>/api/v1/appointment_groups/543.json' \
# -X PUT \
# -F 'appointment_group[publish]=1' \
# -H "Authorization: Bearer <token>"
@ -388,7 +388,7 @@ class AppointmentGroupsController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/appointment_groups/543.json' \
# curl 'https://<canvas>/api/v1/appointment_groups/543.json' \
# -X DELETE \
# -F 'cancel_reason=El Tigre Chino got fired' \
# -H "Authorization: Bearer <token>"

6
app/controllers/assignment_overrides_controller.rb
View File

@ -180,7 +180,7 @@ class AssignmentOverridesController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/1/assignments/2/overrides.json' \
# curl 'https://<canvas>/api/v1/courses/1/assignments/2/overrides.json' \
# -X POST \
# -F 'assignment_override[student_ids][]=8' \
# -F 'assignment_override[title]=Fred Flinstone' \
@ -240,7 +240,7 @@ class AssignmentOverridesController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/1/assignments/2/overrides/3.json' \
# curl 'https://<canvas>/api/v1/courses/1/assignments/2/overrides/3.json' \
# -X PUT \
# -F 'assignment_override[title]=Fred Flinstone' \
# -F 'assignment_override[due_at]=2012-10-08T21:00:00Z' \
@ -266,7 +266,7 @@ class AssignmentOverridesController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/1/assignments/2/overrides/3.json' \
# curl 'https://<canvas>/api/v1/courses/1/assignments/2/overrides/3.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
def destroy

8
app/controllers/calendar_events_api_controller.rb
View File

@ -278,7 +278,7 @@ class CalendarEventsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/calendar_events.json' \
# curl 'https://<canvas>/api/v1/calendar_events.json' \
# -X POST \
# -F 'calendar_event[context_code]=course_123' \
# -F 'calendar_event[title]=Paintball Fight!' \
@ -325,7 +325,7 @@ class CalendarEventsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/calendar_events/345/reservations.json' \
# curl 'https://<canvas>/api/v1/calendar_events/345/reservations.json' \
# -X POST \
# -F 'cancel_existing=true' \
# -H "Authorization: Bearer <token>"
@ -389,7 +389,7 @@ class CalendarEventsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/calendar_events/234.json' \
# curl 'https://<canvas>/api/v1/calendar_events/234.json' \
# -X PUT \
# -F 'calendar_event[title]=Epic Paintball Fight!' \
# -H "Authorization: Bearer <token>"
@ -423,7 +423,7 @@ class CalendarEventsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/calendar_events/234.json' \
# curl 'https://<canvas>/api/v1/calendar_events/234.json' \
# -X DELETE \
# -F 'cancel_reason=Greendale layed off the janitorial staff :(' \
# -H "Authorization: Bearer <token>"

2
app/controllers/collaborations_controller.rb
View File

@ -125,7 +125,7 @@ class CollaborationsController < ApplicationController
#
# Examples
#
# curl http://<canvas>/api/v1/courses/1/collaborations/1/members
# curl https://<canvas>/api/v1/courses/1/collaborations/1/members
#
# @returns [Collaborator]
def members

2
app/controllers/collection_items_controller.rb
View File

@ -125,7 +125,7 @@
# "avatar_image_url": "http://...",
#
# // The URL to the HTML page in Canvas of this user's public profile.
# "html_url": "http://<canvas>/users/37"
# "html_url": "https://<canvas>/users/37"
# }
# }
class CollectionItemsController < ApplicationController

4
app/controllers/discussion_entries_controller.rb
View File

@ -81,7 +81,7 @@ class DiscussionEntriesController < ApplicationController
# @argument message [String] The updated body of the entry.
#
# @example_request
# curl -X PUT 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>' \
# curl -X PUT 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>' \
# -F 'message=<message>' \
# -H "Authorization: Bearer <token>"
def update
@ -137,7 +137,7 @@ class DiscussionEntriesController < ApplicationController
#
# @example_request
#
# curl -X DELETE 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>' \
# curl -X DELETE 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>' \
# -H "Authorization: Bearer <token>"
def destroy
@topic = @context.all_discussion_topics.active.find(params[:topic_id]) if params[:topic_id].present?

24
app/controllers/discussion_topics_api_controller.rb
View File

@ -75,7 +75,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/view' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/view' \
# -H "Authorization: Bearer <token>"
#
# @example_response
@ -134,7 +134,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries.json' \
# -F 'message=<message>' \
# -F 'attachment=@<filename>' \
# -H "Authorization: Bearer <token>"
@ -246,7 +246,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>/replies.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>/replies.json' \
# -F 'message=<message>' \
# -F 'attachment=@<filename>' \
# -H "Authorization: Bearer <token>"
@ -339,7 +339,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entry_list?ids[]=1&ids[]=2&ids[]=3' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entry_list?ids[]=1&ids[]=2&ids[]=3' \
# -H "Authorization: Bearer <token>"
#
# @example_response
@ -364,7 +364,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read.json' \
# -X PUT \
# -H "Authorization: Bearer <token>" \
# -H "Content-Length: 0"
@ -381,7 +381,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
def mark_topic_unread
@ -401,7 +401,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read_all.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read_all.json' \
# -X PUT \
# -H "Authorization: Bearer <token>" \
# -H "Content-Length: 0"
@ -422,7 +422,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read_all.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/read_all.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
def mark_all_unread
@ -442,7 +442,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>/read.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>/read.json' \
# -X PUT \
# -H "Authorization: Bearer <token>"\
# -H "Content-Length: 0"
@ -463,7 +463,7 @@ class DiscussionTopicsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>/read.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/entries/<entry_id>/read.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
def mark_entry_unread
@ -476,7 +476,7 @@ class DiscussionTopicsApiController < ApplicationController
# On success, the response will be 204 No Content with an empty body
#
# @example_request
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/subscribed.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/subscribed.json' \
# -X PUT \
# -H "Authorization: Bearer <token>" \
# -H "Content-Length: 0"
@ -490,7 +490,7 @@ class DiscussionTopicsApiController < ApplicationController
# On success, the response will be 204 No Content with an empty body
#
# @example_request
# curl 'http://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/subscribed.json' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/discussion_topics/<topic_id>/subscribed.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
def unsubscribe_topic

10
app/controllers/external_tools_controller.rb
View File

@ -464,7 +464,7 @@ class ExternalToolsController < ApplicationController
# @example_request
#
# This would create a tool on this course with two custom fields and a course navigation tab
# curl 'http://<canvas>/api/v1/courses/<course_id>/external_tools' \
# curl 'https://<canvas>/api/v1/courses/<course_id>/external_tools' \
# -H "Authorization: Bearer <token>" \
# -F 'name=LTI Example' \
# -F 'consumer_key=asdfg' \
@ -480,7 +480,7 @@ class ExternalToolsController < ApplicationController
# @example_request
#
# This would create a tool on the account with navigation for the user profile page
# curl 'http://<canvas>/api/v1/accounts/<account_id>/external_tools' \
# curl 'https://<canvas>/api/v1/accounts/<account_id>/external_tools' \
# -H "Authorization: Bearer <token>" \
# -F 'name=LTI Example' \
# -F 'consumer_key=asdfg' \
@ -494,7 +494,7 @@ class ExternalToolsController < ApplicationController
# @example_request
#
# This would create a tool on the account with configuration pulled from an external URL
# curl 'http://<canvas>/api/v1/accounts/<account_id>/external_tools' \
# curl 'https://<canvas>/api/v1/accounts/<account_id>/external_tools' \
# -H "Authorization: Bearer <token>" \
# -F 'name=LTI Example' \
# -F 'consumer_key=asdfg' \
@ -525,7 +525,7 @@ class ExternalToolsController < ApplicationController
# @example_request
#
# This would update the specified keys on this external tool
# curl -X PUT 'http://<canvas>/api/v1/courses/<course_id>/external_tools/<external_tool_id>' \
# curl -X PUT 'https://<canvas>/api/v1/courses/<course_id>/external_tools/<external_tool_id>' \
# -H "Authorization: Bearer <token>" \
# -F 'name=Public Example' \
# -F 'privacy_level=public'
@ -553,7 +553,7 @@ class ExternalToolsController < ApplicationController
# @example_request
#
# This would delete the specified external tool
# curl -X DELETE 'http://<canvas>/api/v1/courses/<course_id>/external_tools/<external_tool_id>' \
# curl -X DELETE 'https://<canvas>/api/v1/courses/<course_id>/external_tools/<external_tool_id>' \
# -H "Authorization: Bearer <token>"
def destroy
@tool = @context.context_external_tools.active.find(params[:id] || params[:external_tool_id])

4
app/controllers/media_objects_controller.rb
View File

@ -30,14 +30,14 @@
# "kind": "captions",
# "created_at": "2012-09-27T16:46:50-06:00",
# "updated_at": "2012-09-27T16:46:50-06:00",
# "url": "http://<canvas>/media_objects/0_r949z9lk/media_tracks/1",
# "url": "https://<canvas>/media_objects/0_r949z9lk/media_tracks/1",
# "id": 1,
# "locale": "af"
# }, {
# "kind": "subtitles",
# "created_at": "2012-09-27T20:29:17-06:00",
# "updated_at": "2012-09-27T20:29:17-06:00",
# "url": "http://<canvas>/media_objects/0_r949z9lk/media_tracks/14",
# "url": "https://<canvas>/media_objects/0_r949z9lk/media_tracks/14",
# "id": 14,
# "locale": "cs"
# }],

20
app/controllers/outcome_groups_api_controller.rb
View File

@ -175,7 +175,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/2.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/2.json' \
# -X PUT \
# -F 'title=Outcome Group Title' \
# -F 'description=Outcome group description' \
@ -185,7 +185,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/2.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/2.json' \
# -X PUT \
# --data-binary '{
# "title": "Outcome Group Title",
@ -233,7 +233,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/2.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/2.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
#
@ -361,13 +361,13 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes/1.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes/1.json' \
# -X PUT \
# -H "Authorization: Bearer <token>"
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes.json' \
# -X POST \
# -F 'title=Outcome Title' \
# -F 'description=Outcome description' \
@ -383,7 +383,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes.json' \
# -X POST \
# --data-binary '{
# "title": "Outcome Title",
@ -431,7 +431,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes/1.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/1/outcomes/1.json' \
# -X DELETE \
# -H "Authorization: Bearer <token>"
#
@ -493,7 +493,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/1/subgroups.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/1/subgroups.json' \
# -X POST \
# -F 'title=Outcome Group Title' \
# -F 'description=Outcome group description' \
@ -502,7 +502,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/1/outcome_groups/1/subgroups.json' \
# curl 'https://<canvas>/api/v1/accounts/1/outcome_groups/1/subgroups.json' \
# -X POST \
# --data-binary '{
# "title": "Outcome Group Title",
@ -546,7 +546,7 @@ class OutcomeGroupsApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/accounts/2/outcome_groups/3/import.json' \
# curl 'https://<canvas>/api/v1/accounts/2/outcome_groups/3/import.json' \
# -X POST \
# -F 'source_outcome_group_id=2' \
# -H "Authorization: Bearer <token>"

4
app/controllers/outcomes_api_controller.rb
View File

@ -120,7 +120,7 @@ class OutcomesApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/outcomes/1.json' \
# curl 'https://<canvas>/api/v1/outcomes/1.json' \
# -X PUT \
# -F 'title=Outcome Title' \
# -F 'description=Outcome description' \
@ -136,7 +136,7 @@ class OutcomesApiController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/outcomes/1.json' \
# curl 'https://<canvas>/api/v1/outcomes/1.json' \
# -X PUT \
# --data-binary '{
# "title": "Outcome Title",

2
app/controllers/profile_controller.rb
View File

@ -149,7 +149,7 @@ class ProfileController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/users/1/avatars.json' \
# curl 'https://<canvas>/api/v1/users/1/avatars.json' \
# -H "Authorization: Bearer <token>"
#
# @example_response

2
app/controllers/role_overrides_controller.rb
View File

@ -266,7 +266,7 @@ class RoleOverridesController < ApplicationController
# upstream. May occur multiple times with unique values for <X>.
#
# @example_request
# curl 'http://<canvas>/api/v1/accounts/<account_id>/roles.json' \
# curl 'https://<canvas>/api/v1/accounts/<account_id>/roles.json' \
# -H "Authorization: Bearer <token>" \
# -F 'role=New Role' \
# -F 'permissions[read_course_content][explicit]=1' \

4
app/controllers/users_controller.rb
View File

@ -1000,7 +1000,7 @@ class UsersController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/users/<user_id>/settings \
# curl 'https://<canvas>/api/v1/users/<user_id>/settings \
# -X PUT \
# -F 'manual_mark_as_read=true'
# -H 'Authorization: Bearer <token>'
@ -1066,7 +1066,7 @@ class UsersController < ApplicationController
#
# @example_request
#
# curl 'http://<canvas>/api/v1/users/133.json' \
# curl 'https://<canvas>/api/v1/users/133.json' \
# -X PUT \
# -F 'user[name]=Sheldon Cooper' \
# -F 'user[short_name]=Shelly' \