{"action":"closed","number":702,"pull_request":{"url":"https://api.github.com/repos/json-api/json-api/pulls/702","id":36356033,"html_url":"https://github.com/json-api/json-api/pull/702","diff_url":"https://github.com/json-api/json-api/pull/702.diff","patch_url":"https://github.com/json-api/json-api/pull/702.patch","issue_url":"https://api.github.com/repos/json-api/json-api/issues/702","number":702,"state":"closed","locked":false,"title":"Convert all JSON code blocks to valid JSON","user":{"login":"nonsensery","id":238323,"avatar_url":"https://avatars.githubusercontent.com/u/238323?v=3","gravatar_id":"","url":"https://api.github.com/users/nonsensery","html_url":"https://github.com/nonsensery","followers_url":"https://api.github.com/users/nonsensery/followers","following_url":"https://api.github.com/users/nonsensery/following{/other_user}","gists_url":"https://api.github.com/users/nonsensery/gists{/gist_id}","starred_url":"https://api.github.com/users/nonsensery/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nonsensery/subscriptions","organizations_url":"https://api.github.com/users/nonsensery/orgs","repos_url":"https://api.github.com/users/nonsensery/repos","events_url":"https://api.github.com/users/nonsensery/events{/privacy}","received_events_url":"https://api.github.com/users/nonsensery/received_events","type":"User","site_admin":false},"body":"#### What's this PR do?\r\n\r\nUpdates the JSON code blocks so that they are properly highlighted.\r\n\r\n**Note:** This is only a change to the documentation, not the actual spec itself.\r\n\r\n#### Where should the reviewer start?\r\n\r\nIn this branch, I've changed the JSON code blocks so that they're all tagged as `json` (previously, some were `javascript`). Since JSON is more restrictive than JavaScript, I made some changes to the content of the code blocks so that they are all valid JSON now.\r\n\r\n#### Any background context you want to provide?\r\n\r\nUnfortunately, this is a situation with no \"right\" answer. In order to make the code blocks into valid JSON data structures, I had to make some changes to their content. (For example, comments are not allowed in JSON data.) I've tried to find a compromise that allows the syntax to be valid while still communicating the essential points.\r\n\r\nIn general, I'm not crazy about compromising on the content just to make the syntax highlighter happy, so I'm interested in iterating here. One way or another, there will be a comprise here. Currently, the compromise is inconsistent syntax highlighting.\r\n\r\n#### Alternatives worth considering?\r\n\r\nAnother option would be to just use to `javascript` for all of these code blocks, since that would allow the inline comments to stay.\r\n\r\nThe JS syntax highlighter seems to be more forgiving of partial data structures as well, for example:\r\n\r\n`javascript`:\r\n![screen shot 2015-05-27 at 3 18 32 pm](https://cloud.githubusercontent.com/assets/238323/7848995/b36848a8-0485-11e5-9d34-405907ec2988.png)\r\n\r\n`json`:\r\n![screen shot 2015-05-27 at 3 18 48 pm](https://cloud.githubusercontent.com/assets/238323/7848998/b85caeb2-0485-11e5-9030-9508fb740997.png)","created_at":"2015-05-27T22:36:20Z","updated_at":"2015-11-14T07:57:15Z","closed_at":"2015-11-14T07:57:15Z","merged_at":null,"merge_commit_sha":"8f646d736b0a8299d27bcae710d1a9997d8167ef","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/json-api/json-api/pulls/702/commits","review_comments_url":"https://api.github.com/repos/json-api/json-api/pulls/702/comments","review_comment_url":"https://api.github.com/repos/json-api/json-api/pulls/comments{/number}","comments_url":"https://api.github.com/repos/json-api/json-api/issues/702/comments","statuses_url":"https://api.github.com/repos/json-api/json-api/statuses/5e47156818b3d8c701247a9d28d80d7fade9d5cc","head":{"label":"nonsensery:json-code-block-cleanup","ref":"json-code-block-cleanup","sha":"5e47156818b3d8c701247a9d28d80d7fade9d5cc","user":{"login":"nonsensery","id":238323,"avatar_url":"https://avatars.githubusercontent.com/u/238323?v=3","gravatar_id":"","url":"https://api.github.com/users/nonsensery","html_url":"https://github.com/nonsensery","followers_url":"https://api.github.com/users/nonsensery/followers","following_url":"https://api.github.com/users/nonsensery/following{/other_user}","gists_url":"https://api.github.com/users/nonsensery/gists{/gist_id}","starred_url":"https://api.github.com/users/nonsensery/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nonsensery/subscriptions","organizations_url":"https://api.github.com/users/nonsensery/orgs","repos_url":"https://api.github.com/users/nonsensery/repos","events_url":"https://api.github.com/users/nonsensery/events{/privacy}","received_events_url":"https://api.github.com/users/nonsensery/received_events","type":"User","site_admin":false},"repo":{"id":35287455,"name":"json-api","full_name":"nonsensery/json-api","owner":{"login":"nonsensery","id":238323,"avatar_url":"https://avatars.githubusercontent.com/u/238323?v=3","gravatar_id":"","url":"https://api.github.com/users/nonsensery","html_url":"https://github.com/nonsensery","followers_url":"https://api.github.com/users/nonsensery/followers","following_url":"https://api.github.com/users/nonsensery/following{/other_user}","gists_url":"https://api.github.com/users/nonsensery/gists{/gist_id}","starred_url":"https://api.github.com/users/nonsensery/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nonsensery/subscriptions","organizations_url":"https://api.github.com/users/nonsensery/orgs","repos_url":"https://api.github.com/users/nonsensery/repos","events_url":"https://api.github.com/users/nonsensery/events{/privacy}","received_events_url":"https://api.github.com/users/nonsensery/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/nonsensery/json-api","description":"A shared media type for JSON APIs.","fork":true,"url":"https://api.github.com/repos/nonsensery/json-api","forks_url":"https://api.github.com/repos/nonsensery/json-api/forks","keys_url":"https://api.github.com/repos/nonsensery/json-api/keys{/key_id}","collaborators_url":"https://api.github.com/repos/nonsensery/json-api/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/nonsensery/json-api/teams","hooks_url":"https://api.github.com/repos/nonsensery/json-api/hooks","issue_events_url":"https://api.github.com/repos/nonsensery/json-api/issues/events{/number}","events_url":"https://api.github.com/repos/nonsensery/json-api/events","assignees_url":"https://api.github.com/repos/nonsensery/json-api/assignees{/user}","branches_url":"https://api.github.com/repos/nonsensery/json-api/branches{/branch}","tags_url":"https://api.github.com/repos/nonsensery/json-api/tags","blobs_url":"https://api.github.com/repos/nonsensery/json-api/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/nonsensery/json-api/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/nonsensery/json-api/git/refs{/sha}","trees_url":"https://api.github.com/repos/nonsensery/json-api/git/trees{/sha}","statuses_url":"https://api.github.com/repos/nonsensery/json-api/statuses/{sha}","languages_url":"https://api.github.com/repos/nonsensery/json-api/languages","stargazers_url":"https://api.github.com/repos/nonsensery/json-api/stargazers","contributors_url":"https://api.github.com/repos/nonsensery/json-api/contributors","subscribers_url":"https://api.github.com/repos/nonsensery/json-api/subscribers","subscription_url":"https://api.github.com/repos/nonsensery/json-api/subscription","commits_url":"https://api.github.com/repos/nonsensery/json-api/commits{/sha}","git_commits_url":"https://api.github.com/repos/nonsensery/json-api/git/commits{/sha}","comments_url":"https://api.github.com/repos/nonsensery/json-api/comments{/number}","issue_comment_url":"https://api.github.com/repos/nonsensery/json-api/issues/comments{/number}","contents_url":"https://api.github.com/repos/nonsensery/json-api/contents/{+path}","compare_url":"https://api.github.com/repos/nonsensery/json-api/compare/{base}...{head}","merges_url":"https://api.github.com/repos/nonsensery/json-api/merges","archive_url":"https://api.github.com/repos/nonsensery/json-api/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/nonsensery/json-api/downloads","issues_url":"https://api.github.com/repos/nonsensery/json-api/issues{/number}","pulls_url":"https://api.github.com/repos/nonsensery/json-api/pulls{/number}","milestones_url":"https://api.github.com/repos/nonsensery/json-api/milestones{/number}","notifications_url":"https://api.github.com/repos/nonsensery/json-api/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/nonsensery/json-api/labels{/name}","releases_url":"https://api.github.com/repos/nonsensery/json-api/releases{/id}","created_at":"2015-05-08T15:40:08Z","updated_at":"2015-05-08T15:40:09Z","pushed_at":"2015-05-29T20:07:55Z","git_url":"git://github.com/nonsensery/json-api.git","ssh_url":"git@github.com:nonsensery/json-api.git","clone_url":"https://github.com/nonsensery/json-api.git","svn_url":"https://github.com/nonsensery/json-api","homepage":"http://jsonapi.org","size":1456,"stargazers_count":0,"watchers_count":0,"language":"CSS","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"gh-pages"}},"base":{"label":"json-api:gh-pages","ref":"gh-pages","sha":"4d681d426ca497582095e4db3d674f526c887cc1","user":{"login":"json-api","id":4341694,"avatar_url":"https://avatars.githubusercontent.com/u/4341694?v=3","gravatar_id":"","url":"https://api.github.com/users/json-api","html_url":"https://github.com/json-api","followers_url":"https://api.github.com/users/json-api/followers","following_url":"https://api.github.com/users/json-api/following{/other_user}","gists_url":"https://api.github.com/users/json-api/gists{/gist_id}","starred_url":"https://api.github.com/users/json-api/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/json-api/subscriptions","organizations_url":"https://api.github.com/users/json-api/orgs","repos_url":"https://api.github.com/users/json-api/repos","events_url":"https://api.github.com/users/json-api/events{/privacy}","received_events_url":"https://api.github.com/users/json-api/received_events","type":"Organization","site_admin":false},"repo":{"id":9859154,"name":"json-api","full_name":"json-api/json-api","owner":{"login":"json-api","id":4341694,"avatar_url":"https://avatars.githubusercontent.com/u/4341694?v=3","gravatar_id":"","url":"https://api.github.com/users/json-api","html_url":"https://github.com/json-api","followers_url":"https://api.github.com/users/json-api/followers","following_url":"https://api.github.com/users/json-api/following{/other_user}","gists_url":"https://api.github.com/users/json-api/gists{/gist_id}","starred_url":"https://api.github.com/users/json-api/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/json-api/subscriptions","organizations_url":"https://api.github.com/users/json-api/orgs","repos_url":"https://api.github.com/users/json-api/repos","events_url":"https://api.github.com/users/json-api/events{/privacy}","received_events_url":"https://api.github.com/users/json-api/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/json-api/json-api","description":"A specification for building JSON APIs","fork":false,"url":"https://api.github.com/repos/json-api/json-api","forks_url":"https://api.github.com/repos/json-api/json-api/forks","keys_url":"https://api.github.com/repos/json-api/json-api/keys{/key_id}","collaborators_url":"https://api.github.com/repos/json-api/json-api/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/json-api/json-api/teams","hooks_url":"https://api.github.com/repos/json-api/json-api/hooks","issue_events_url":"https://api.github.com/repos/json-api/json-api/issues/events{/number}","events_url":"https://api.github.com/repos/json-api/json-api/events","assignees_url":"https://api.github.com/repos/json-api/json-api/assignees{/user}","branches_url":"https://api.github.com/repos/json-api/json-api/branches{/branch}","tags_url":"https://api.github.com/repos/json-api/json-api/tags","blobs_url":"https://api.github.com/repos/json-api/json-api/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/json-api/json-api/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/json-api/json-api/git/refs{/sha}","trees_url":"https://api.github.com/repos/json-api/json-api/git/trees{/sha}","statuses_url":"https://api.github.com/repos/json-api/json-api/statuses/{sha}","languages_url":"https://api.github.com/repos/json-api/json-api/languages","stargazers_url":"https://api.github.com/repos/json-api/json-api/stargazers","contributors_url":"https://api.github.com/repos/json-api/json-api/contributors","subscribers_url":"https://api.github.com/repos/json-api/json-api/subscribers","subscription_url":"https://api.github.com/repos/json-api/json-api/subscription","commits_url":"https://api.github.com/repos/json-api/json-api/commits{/sha}","git_commits_url":"https://api.github.com/repos/json-api/json-api/git/commits{/sha}","comments_url":"https://api.github.com/repos/json-api/json-api/comments{/number}","issue_comment_url":"https://api.github.com/repos/json-api/json-api/issues/comments{/number}","contents_url":"https://api.github.com/repos/json-api/json-api/contents/{+path}","compare_url":"https://api.github.com/repos/json-api/json-api/compare/{base}...{head}","merges_url":"https://api.github.com/repos/json-api/json-api/merges","archive_url":"https://api.github.com/repos/json-api/json-api/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/json-api/json-api/downloads","issues_url":"https://api.github.com/repos/json-api/json-api/issues{/number}","pulls_url":"https://api.github.com/repos/json-api/json-api/pulls{/number}","milestones_url":"https://api.github.com/repos/json-api/json-api/milestones{/number}","notifications_url":"https://api.github.com/repos/json-api/json-api/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/json-api/json-api/labels{/name}","releases_url":"https://api.github.com/repos/json-api/json-api/releases{/id}","created_at":"2013-05-04T19:29:30Z","updated_at":"2015-11-14T05:25:58Z","pushed_at":"2015-11-14T07:57:14Z","git_url":"git://github.com/json-api/json-api.git","ssh_url":"git@github.com:json-api/json-api.git","clone_url":"https://github.com/json-api/json-api.git","svn_url":"https://github.com/json-api/json-api","homepage":"http://jsonapi.org","size":5045,"stargazers_count":3097,"watchers_count":3097,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":358,"mirror_url":null,"open_issues_count":40,"forks":358,"open_issues":40,"watchers":3097,"default_branch":"actions-discovery-faq-cleanup"}},"_links":{"self":{"href":"https://api.github.com/repos/json-api/json-api/pulls/702"},"html":{"href":"https://github.com/json-api/json-api/pull/702"},"issue":{"href":"https://api.github.com/repos/json-api/json-api/issues/702"},"comments":{"href":"https://api.github.com/repos/json-api/json-api/issues/702/comments"},"review_comments":{"href":"https://api.github.com/repos/json-api/json-api/pulls/702/comments"},"review_comment":{"href":"https://api.github.com/repos/json-api/json-api/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/json-api/json-api/pulls/702/commits"},"statuses":{"href":"https://api.github.com/repos/json-api/json-api/statuses/5e47156818b3d8c701247a9d28d80d7fade9d5cc"}},"merged":false,"mergeable":false,"mergeable_state":"dirty","merged_by":null,"comments":1,"review_comments":5,"commits":1,"additions":66,"deletions":64,"changed_files":1}}