{"action":"created","comment":{"url":"https://api.github.com/repos/edx/edx-platform/pulls/comments/61343403","id":61343403,"diff_hunk":"@@ -0,0 +1,315 @@\n+.. _Course Catalog API Catalogs Resource:\n+\n+########################################\n+Course Catalog API Catalogs Resource\n+########################################\n+\n+With the Course Catalog API **Catalogs** resource, you can complete the\n+following tasks.\n+\n+   * :ref:`Get a list of all available course catalogs <Get a List of All\n+     Course Catalogs>`\n+     - GET\n+     - /api/v1/catalogs/\n+   * - :ref:`Get information about a specific catalog <Get Information About a\n+     Specific Catalog>`\n+     - GET\n+     - /api/v1/catalogs/1/\n+   * - :ref:`Get a list of all courses in a catalog <Get a List of All Courses\n+     in a Catalog>`\n+     - GET\n+     - /api/v1/catalogs/1/courses/\n+\n+.. contents::\n+   :local:\n+   :depth: 1\n+\n+.. _Get a List of All Course Catalogs:\n+\n+**************************************\n+Get a List of All Course Catalogs\n+**************************************\n+\n+The endpoint to get a list of all course catalogs is ``/api/v1/catalogs/``.\n+\n+=====================\n+Use Case\n+=====================\n+\n+Get a list of all the available course catalogs.\n+\n+=====================\n+Example Request\n+=====================\n+\n+``GET /api/v1/catalogs/``\n+\n+=====================\n+Response Values\n+=====================\n+","path":"docs/en_us/platform_api/source/course_catalog/catalogs.rst","position":50,"original_position":50,"commit_id":"6d2d62db7d8b9db0d12c0b2c6d2d9c8e12b7b327","original_commit_id":"6d2d62db7d8b9db0d12c0b2c6d2d9c8e12b7b327","user":{"login":"srpearce","id":3493253,"avatar_url":"https://avatars.githubusercontent.com/u/3493253?v=3","gravatar_id":"","url":"https://api.github.com/users/srpearce","html_url":"https://github.com/srpearce","followers_url":"https://api.github.com/users/srpearce/followers","following_url":"https://api.github.com/users/srpearce/following{/other_user}","gists_url":"https://api.github.com/users/srpearce/gists{/gist_id}","starred_url":"https://api.github.com/users/srpearce/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/srpearce/subscriptions","organizations_url":"https://api.github.com/users/srpearce/orgs","repos_url":"https://api.github.com/users/srpearce/repos","events_url":"https://api.github.com/users/srpearce/events{/privacy}","received_events_url":"https://api.github.com/users/srpearce/received_events","type":"User","site_admin":false},"body":"These values came from https://stage-edx-discovery.edx.org/api/v1/catalogs/. Please confirm that they're correct.","created_at":"2016-04-27T21:54:08Z","updated_at":"2016-04-27T21:54:08Z","html_url":"https://github.com/edx/edx-platform/pull/12207#discussion_r61343403","pull_request_url":"https://api.github.com/repos/edx/edx-platform/pulls/12207","_links":{"self":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/comments/61343403"},"html":{"href":"https://github.com/edx/edx-platform/pull/12207#discussion_r61343403"},"pull_request":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/12207"}}},"pull_request":{"url":"https://api.github.com/repos/edx/edx-platform/pulls/12207","id":67258559,"html_url":"https://github.com/edx/edx-platform/pull/12207","diff_url":"https://github.com/edx/edx-platform/pull/12207.diff","patch_url":"https://github.com/edx/edx-platform/pull/12207.patch","issue_url":"https://api.github.com/repos/edx/edx-platform/issues/12207","number":12207,"state":"open","locked":false,"title":"WIP: Add documentation for Course Catalog API","user":{"login":"srpearce","id":3493253,"avatar_url":"https://avatars.githubusercontent.com/u/3493253?v=3","gravatar_id":"","url":"https://api.github.com/users/srpearce","html_url":"https://github.com/srpearce","followers_url":"https://api.github.com/users/srpearce/followers","following_url":"https://api.github.com/users/srpearce/following{/other_user}","gists_url":"https://api.github.com/users/srpearce/gists{/gist_id}","starred_url":"https://api.github.com/users/srpearce/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/srpearce/subscriptions","organizations_url":"https://api.github.com/users/srpearce/orgs","repos_url":"https://api.github.com/users/srpearce/repos","events_url":"https://api.github.com/users/srpearce/events{/privacy}","received_events_url":"https://api.github.com/users/srpearce/received_events","type":"User","site_admin":false},"body":"## [DOC-2582](https://openedx.atlassian.net/browse/DOC-2582)\r\n\r\nThis PR adds documentation for the Course Catalog API. This is currently a work in progress.\r\n\r\n### Reviewers\r\n- [ ] Subject matter expert: @bderusha  - Please review the documentation so far and let me know if I'm on the right track. I'm not sure how the information in the [Google doc](https://docs.google.com/document/d/11b8Qty8S7GF55QP-yagKi3zdAZGYd-gWYLEwBwxLZQk/edit) fits in with the documentation here. For example, a response to several of the requests is ``courses_count``, I don't see ``courses_count`` mentioned in the Google doc.","created_at":"2016-04-20T21:07:36Z","updated_at":"2016-04-27T21:54:08Z","closed_at":null,"merged_at":null,"merge_commit_sha":"b7ef7530b94549f50704f16360f9526d375fa756","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/edx/edx-platform/pulls/12207/commits","review_comments_url":"https://api.github.com/repos/edx/edx-platform/pulls/12207/comments","review_comment_url":"https://api.github.com/repos/edx/edx-platform/pulls/comments{/number}","comments_url":"https://api.github.com/repos/edx/edx-platform/issues/12207/comments","statuses_url":"https://api.github.com/repos/edx/edx-platform/statuses/6d2d62db7d8b9db0d12c0b2c6d2d9c8e12b7b327","head":{"label":"edx:sylvia/DOC-2582","ref":"sylvia/DOC-2582","sha":"6d2d62db7d8b9db0d12c0b2c6d2d9c8e12b7b327","user":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"repo":{"id":10391073,"name":"edx-platform","full_name":"edx/edx-platform","owner":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/edx/edx-platform","description":"The Open edX platform, the software that powers edX!","fork":false,"url":"https://api.github.com/repos/edx/edx-platform","forks_url":"https://api.github.com/repos/edx/edx-platform/forks","keys_url":"https://api.github.com/repos/edx/edx-platform/keys{/key_id}","collaborators_url":"https://api.github.com/repos/edx/edx-platform/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/edx/edx-platform/teams","hooks_url":"https://api.github.com/repos/edx/edx-platform/hooks","issue_events_url":"https://api.github.com/repos/edx/edx-platform/issues/events{/number}","events_url":"https://api.github.com/repos/edx/edx-platform/events","assignees_url":"https://api.github.com/repos/edx/edx-platform/assignees{/user}","branches_url":"https://api.github.com/repos/edx/edx-platform/branches{/branch}","tags_url":"https://api.github.com/repos/edx/edx-platform/tags","blobs_url":"https://api.github.com/repos/edx/edx-platform/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/edx/edx-platform/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/edx/edx-platform/git/refs{/sha}","trees_url":"https://api.github.com/repos/edx/edx-platform/git/trees{/sha}","statuses_url":"https://api.github.com/repos/edx/edx-platform/statuses/{sha}","languages_url":"https://api.github.com/repos/edx/edx-platform/languages","stargazers_url":"https://api.github.com/repos/edx/edx-platform/stargazers","contributors_url":"https://api.github.com/repos/edx/edx-platform/contributors","subscribers_url":"https://api.github.com/repos/edx/edx-platform/subscribers","subscription_url":"https://api.github.com/repos/edx/edx-platform/subscription","commits_url":"https://api.github.com/repos/edx/edx-platform/commits{/sha}","git_commits_url":"https://api.github.com/repos/edx/edx-platform/git/commits{/sha}","comments_url":"https://api.github.com/repos/edx/edx-platform/comments{/number}","issue_comment_url":"https://api.github.com/repos/edx/edx-platform/issues/comments{/number}","contents_url":"https://api.github.com/repos/edx/edx-platform/contents/{+path}","compare_url":"https://api.github.com/repos/edx/edx-platform/compare/{base}...{head}","merges_url":"https://api.github.com/repos/edx/edx-platform/merges","archive_url":"https://api.github.com/repos/edx/edx-platform/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/edx/edx-platform/downloads","issues_url":"https://api.github.com/repos/edx/edx-platform/issues{/number}","pulls_url":"https://api.github.com/repos/edx/edx-platform/pulls{/number}","milestones_url":"https://api.github.com/repos/edx/edx-platform/milestones{/number}","notifications_url":"https://api.github.com/repos/edx/edx-platform/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/edx/edx-platform/labels{/name}","releases_url":"https://api.github.com/repos/edx/edx-platform/releases{/id}","deployments_url":"https://api.github.com/repos/edx/edx-platform/deployments","created_at":"2013-05-30T20:20:38Z","updated_at":"2016-04-27T11:36:00Z","pushed_at":"2016-04-27T21:52:11Z","git_url":"git://github.com/edx/edx-platform.git","ssh_url":"git@github.com:edx/edx-platform.git","clone_url":"https://github.com/edx/edx-platform.git","svn_url":"https://github.com/edx/edx-platform","homepage":"http://open.edx.org/","size":737256,"stargazers_count":2526,"watchers_count":2526,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":1541,"mirror_url":null,"open_issues_count":180,"forks":1541,"open_issues":180,"watchers":2526,"default_branch":"master"}},"base":{"label":"edx:master","ref":"master","sha":"b6d5c614dde4f61b4d51f2d9eb392c9c1c52ecd7","user":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"repo":{"id":10391073,"name":"edx-platform","full_name":"edx/edx-platform","owner":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/edx/edx-platform","description":"The Open edX platform, the software that powers edX!","fork":false,"url":"https://api.github.com/repos/edx/edx-platform","forks_url":"https://api.github.com/repos/edx/edx-platform/forks","keys_url":"https://api.github.com/repos/edx/edx-platform/keys{/key_id}","collaborators_url":"https://api.github.com/repos/edx/edx-platform/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/edx/edx-platform/teams","hooks_url":"https://api.github.com/repos/edx/edx-platform/hooks","issue_events_url":"https://api.github.com/repos/edx/edx-platform/issues/events{/number}","events_url":"https://api.github.com/repos/edx/edx-platform/events","assignees_url":"https://api.github.com/repos/edx/edx-platform/assignees{/user}","branches_url":"https://api.github.com/repos/edx/edx-platform/branches{/branch}","tags_url":"https://api.github.com/repos/edx/edx-platform/tags","blobs_url":"https://api.github.com/repos/edx/edx-platform/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/edx/edx-platform/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/edx/edx-platform/git/refs{/sha}","trees_url":"https://api.github.com/repos/edx/edx-platform/git/trees{/sha}","statuses_url":"https://api.github.com/repos/edx/edx-platform/statuses/{sha}","languages_url":"https://api.github.com/repos/edx/edx-platform/languages","stargazers_url":"https://api.github.com/repos/edx/edx-platform/stargazers","contributors_url":"https://api.github.com/repos/edx/edx-platform/contributors","subscribers_url":"https://api.github.com/repos/edx/edx-platform/subscribers","subscription_url":"https://api.github.com/repos/edx/edx-platform/subscription","commits_url":"https://api.github.com/repos/edx/edx-platform/commits{/sha}","git_commits_url":"https://api.github.com/repos/edx/edx-platform/git/commits{/sha}","comments_url":"https://api.github.com/repos/edx/edx-platform/comments{/number}","issue_comment_url":"https://api.github.com/repos/edx/edx-platform/issues/comments{/number}","contents_url":"https://api.github.com/repos/edx/edx-platform/contents/{+path}","compare_url":"https://api.github.com/repos/edx/edx-platform/compare/{base}...{head}","merges_url":"https://api.github.com/repos/edx/edx-platform/merges","archive_url":"https://api.github.com/repos/edx/edx-platform/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/edx/edx-platform/downloads","issues_url":"https://api.github.com/repos/edx/edx-platform/issues{/number}","pulls_url":"https://api.github.com/repos/edx/edx-platform/pulls{/number}","milestones_url":"https://api.github.com/repos/edx/edx-platform/milestones{/number}","notifications_url":"https://api.github.com/repos/edx/edx-platform/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/edx/edx-platform/labels{/name}","releases_url":"https://api.github.com/repos/edx/edx-platform/releases{/id}","deployments_url":"https://api.github.com/repos/edx/edx-platform/deployments","created_at":"2013-05-30T20:20:38Z","updated_at":"2016-04-27T11:36:00Z","pushed_at":"2016-04-27T21:52:11Z","git_url":"git://github.com/edx/edx-platform.git","ssh_url":"git@github.com:edx/edx-platform.git","clone_url":"https://github.com/edx/edx-platform.git","svn_url":"https://github.com/edx/edx-platform","homepage":"http://open.edx.org/","size":737256,"stargazers_count":2526,"watchers_count":2526,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":1541,"mirror_url":null,"open_issues_count":180,"forks":1541,"open_issues":180,"watchers":2526,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/12207"},"html":{"href":"https://github.com/edx/edx-platform/pull/12207"},"issue":{"href":"https://api.github.com/repos/edx/edx-platform/issues/12207"},"comments":{"href":"https://api.github.com/repos/edx/edx-platform/issues/12207/comments"},"review_comments":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/12207/comments"},"review_comment":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/12207/commits"},"statuses":{"href":"https://api.github.com/repos/edx/edx-platform/statuses/6d2d62db7d8b9db0d12c0b2c6d2d9c8e12b7b327"}}}}