{"action":"created","comment":{"url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/comments/79123100","id":79123100,"diff_hunk":"@@ -1,40 +1,29 @@\n ---\n layout:     guidelines\n title:      \"API design\"\n+subtitle:   \"Designing APIs in a resource-oriented architecture\"\n collection: guidelines\n ---\n \n+## Table of Contents\n+{:.no_toc}\n \n+1. Automatic Table of Contents Here\n+{:toc}\n \n-> These guidelines mostly apply to _internal_ APIs, meant to be consumed by\n-> software we build and maintain.\n->\n-> APIs that face the public, or 3rd-party integrators, or simply our own apps\n-> outside the datacenter, have very different constraints.\n-> The section [external-facing APIs](#external-facing) has details on how to\n-> handle those cases.\n-{: .dg-sidebar.dg-warning }\n-\n-# Designing APIs in a resource-oriented architecture\n+## Introduction\n \n This set of guidelines and conventions outline how to design APIs that are\n-reusable and match with our [Service\n-design](http://deliveroo.engineering/guide/services) guidelines.\n-\n+reusable and match with our [Service design](/guidelines/services) guidelines.\n \n-<!-- START doctoc generated TOC please keep comment here to allow auto update -->","path":"_guidelines/api-design.md","position":32,"original_position":32,"commit_id":"eeb252d0fdde0ad7b5fc24b8c6f4c8f17163addb","original_commit_id":"eeb252d0fdde0ad7b5fc24b8c6f4c8f17163addb","user":{"login":"mezis","id":231698,"avatar_url":"https://avatars.githubusercontent.com/u/231698?v=3","gravatar_id":"","url":"https://api.github.com/users/mezis","html_url":"https://github.com/mezis","followers_url":"https://api.github.com/users/mezis/followers","following_url":"https://api.github.com/users/mezis/following{/other_user}","gists_url":"https://api.github.com/users/mezis/gists{/gist_id}","starred_url":"https://api.github.com/users/mezis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mezis/subscriptions","organizations_url":"https://api.github.com/users/mezis/orgs","repos_url":"https://api.github.com/users/mezis/repos","events_url":"https://api.github.com/users/mezis/events{/privacy}","received_events_url":"https://api.github.com/users/mezis/received_events","type":"User","site_admin":false},"body":"Awesome. Never knew Kramdown / Github pages supported this.","created_at":"2016-09-16T08:09:43Z","updated_at":"2016-09-16T08:09:43Z","html_url":"https://github.com/deliveroo/deliveroo.engineering/pull/45#discussion_r79123100","pull_request_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45","_links":{"self":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/comments/79123100"},"html":{"href":"https://github.com/deliveroo/deliveroo.engineering/pull/45#discussion_r79123100"},"pull_request":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45"}}},"pull_request":{"url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45","id":85487101,"html_url":"https://github.com/deliveroo/deliveroo.engineering/pull/45","diff_url":"https://github.com/deliveroo/deliveroo.engineering/pull/45.diff","patch_url":"https://github.com/deliveroo/deliveroo.engineering/pull/45.patch","issue_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/45","number":45,"state":"open","locked":false,"title":"Update format of guidelines & add descriptions","user":{"login":"kapowaz","id":25730,"avatar_url":"https://avatars.githubusercontent.com/u/25730?v=3","gravatar_id":"","url":"https://api.github.com/users/kapowaz","html_url":"https://github.com/kapowaz","followers_url":"https://api.github.com/users/kapowaz/followers","following_url":"https://api.github.com/users/kapowaz/following{/other_user}","gists_url":"https://api.github.com/users/kapowaz/gists{/gist_id}","starred_url":"https://api.github.com/users/kapowaz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kapowaz/subscriptions","organizations_url":"https://api.github.com/users/kapowaz/orgs","repos_url":"https://api.github.com/users/kapowaz/repos","events_url":"https://api.github.com/users/kapowaz/events{/privacy}","received_events_url":"https://api.github.com/users/kapowaz/received_events","type":"User","site_admin":false},"body":"These changes update the layout/formatting of the various guideline documents to bring them in line with what the new blog layout expects, including:\r\n\r\n* Adding Front Matter descriptions/titles\r\n* Correcting heading levels\r\n* Adding Table of Contents identifiers\r\n* Made code blocks consistently use the ``` block identifier instead of indentation\r\n* General tidying up\r\n\r\nI’ve also added some more detail about Markdown guidelines to the meta document which describes the kind of thing I’ve added with this PR, so that future guidelines can make use of them.","created_at":"2016-09-15T21:51:26Z","updated_at":"2016-09-16T08:09:43Z","closed_at":null,"merged_at":null,"merge_commit_sha":"448e930ec9a8ec00a62772bce68944ecd001bfea","assignee":{"login":"kapowaz","id":25730,"avatar_url":"https://avatars.githubusercontent.com/u/25730?v=3","gravatar_id":"","url":"https://api.github.com/users/kapowaz","html_url":"https://github.com/kapowaz","followers_url":"https://api.github.com/users/kapowaz/followers","following_url":"https://api.github.com/users/kapowaz/following{/other_user}","gists_url":"https://api.github.com/users/kapowaz/gists{/gist_id}","starred_url":"https://api.github.com/users/kapowaz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kapowaz/subscriptions","organizations_url":"https://api.github.com/users/kapowaz/orgs","repos_url":"https://api.github.com/users/kapowaz/repos","events_url":"https://api.github.com/users/kapowaz/events{/privacy}","received_events_url":"https://api.github.com/users/kapowaz/received_events","type":"User","site_admin":false},"assignees":[{"login":"kapowaz","id":25730,"avatar_url":"https://avatars.githubusercontent.com/u/25730?v=3","gravatar_id":"","url":"https://api.github.com/users/kapowaz","html_url":"https://github.com/kapowaz","followers_url":"https://api.github.com/users/kapowaz/followers","following_url":"https://api.github.com/users/kapowaz/following{/other_user}","gists_url":"https://api.github.com/users/kapowaz/gists{/gist_id}","starred_url":"https://api.github.com/users/kapowaz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kapowaz/subscriptions","organizations_url":"https://api.github.com/users/kapowaz/orgs","repos_url":"https://api.github.com/users/kapowaz/repos","events_url":"https://api.github.com/users/kapowaz/events{/privacy}","received_events_url":"https://api.github.com/users/kapowaz/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45/commits","review_comments_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45/comments","review_comment_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/comments{/number}","comments_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/45/comments","statuses_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/statuses/eeb252d0fdde0ad7b5fc24b8c6f4c8f17163addb","head":{"label":"deliveroo:feature/update-guideline-descriptions","ref":"feature/update-guideline-descriptions","sha":"eeb252d0fdde0ad7b5fc24b8c6f4c8f17163addb","user":{"login":"deliveroo","id":10514109,"avatar_url":"https://avatars.githubusercontent.com/u/10514109?v=3","gravatar_id":"","url":"https://api.github.com/users/deliveroo","html_url":"https://github.com/deliveroo","followers_url":"https://api.github.com/users/deliveroo/followers","following_url":"https://api.github.com/users/deliveroo/following{/other_user}","gists_url":"https://api.github.com/users/deliveroo/gists{/gist_id}","starred_url":"https://api.github.com/users/deliveroo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deliveroo/subscriptions","organizations_url":"https://api.github.com/users/deliveroo/orgs","repos_url":"https://api.github.com/users/deliveroo/repos","events_url":"https://api.github.com/users/deliveroo/events{/privacy}","received_events_url":"https://api.github.com/users/deliveroo/received_events","type":"Organization","site_admin":false},"repo":{"id":32532933,"name":"deliveroo.engineering","full_name":"deliveroo/deliveroo.engineering","owner":{"login":"deliveroo","id":10514109,"avatar_url":"https://avatars.githubusercontent.com/u/10514109?v=3","gravatar_id":"","url":"https://api.github.com/users/deliveroo","html_url":"https://github.com/deliveroo","followers_url":"https://api.github.com/users/deliveroo/followers","following_url":"https://api.github.com/users/deliveroo/following{/other_user}","gists_url":"https://api.github.com/users/deliveroo/gists{/gist_id}","starred_url":"https://api.github.com/users/deliveroo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deliveroo/subscriptions","organizations_url":"https://api.github.com/users/deliveroo/orgs","repos_url":"https://api.github.com/users/deliveroo/repos","events_url":"https://api.github.com/users/deliveroo/events{/privacy}","received_events_url":"https://api.github.com/users/deliveroo/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/deliveroo/deliveroo.engineering","description":"Guidelines and conventions for good software at Deliveroo","fork":true,"url":"https://api.github.com/repos/deliveroo/deliveroo.engineering","forks_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/forks","keys_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/keys{/key_id}","collaborators_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/teams","hooks_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/hooks","issue_events_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/events{/number}","events_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/events","assignees_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/assignees{/user}","branches_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/branches{/branch}","tags_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/tags","blobs_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/refs{/sha}","trees_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/trees{/sha}","statuses_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/statuses/{sha}","languages_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/languages","stargazers_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/stargazers","contributors_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/contributors","subscribers_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/subscribers","subscription_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/subscription","commits_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/commits{/sha}","git_commits_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/commits{/sha}","comments_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/comments{/number}","issue_comment_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/comments{/number}","contents_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/contents/{+path}","compare_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/compare/{base}...{head}","merges_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/merges","archive_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/downloads","issues_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues{/number}","pulls_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls{/number}","milestones_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/milestones{/number}","notifications_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/labels{/name}","releases_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/releases{/id}","deployments_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/deployments","created_at":"2015-03-19T16:23:28Z","updated_at":"2016-09-15T15:29:29Z","pushed_at":"2016-09-15T22:15:15Z","git_url":"git://github.com/deliveroo/deliveroo.engineering.git","ssh_url":"git@github.com:deliveroo/deliveroo.engineering.git","clone_url":"https://github.com/deliveroo/deliveroo.engineering.git","svn_url":"https://github.com/deliveroo/deliveroo.engineering","homepage":"","size":4213,"stargazers_count":8,"watchers_count":8,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":2,"mirror_url":null,"open_issues_count":15,"forks":2,"open_issues":15,"watchers":8,"default_branch":"gh-pages"}},"base":{"label":"deliveroo:gh-pages","ref":"gh-pages","sha":"175e8693a76670596e423109594d6cb63a475c9b","user":{"login":"deliveroo","id":10514109,"avatar_url":"https://avatars.githubusercontent.com/u/10514109?v=3","gravatar_id":"","url":"https://api.github.com/users/deliveroo","html_url":"https://github.com/deliveroo","followers_url":"https://api.github.com/users/deliveroo/followers","following_url":"https://api.github.com/users/deliveroo/following{/other_user}","gists_url":"https://api.github.com/users/deliveroo/gists{/gist_id}","starred_url":"https://api.github.com/users/deliveroo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deliveroo/subscriptions","organizations_url":"https://api.github.com/users/deliveroo/orgs","repos_url":"https://api.github.com/users/deliveroo/repos","events_url":"https://api.github.com/users/deliveroo/events{/privacy}","received_events_url":"https://api.github.com/users/deliveroo/received_events","type":"Organization","site_admin":false},"repo":{"id":32532933,"name":"deliveroo.engineering","full_name":"deliveroo/deliveroo.engineering","owner":{"login":"deliveroo","id":10514109,"avatar_url":"https://avatars.githubusercontent.com/u/10514109?v=3","gravatar_id":"","url":"https://api.github.com/users/deliveroo","html_url":"https://github.com/deliveroo","followers_url":"https://api.github.com/users/deliveroo/followers","following_url":"https://api.github.com/users/deliveroo/following{/other_user}","gists_url":"https://api.github.com/users/deliveroo/gists{/gist_id}","starred_url":"https://api.github.com/users/deliveroo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deliveroo/subscriptions","organizations_url":"https://api.github.com/users/deliveroo/orgs","repos_url":"https://api.github.com/users/deliveroo/repos","events_url":"https://api.github.com/users/deliveroo/events{/privacy}","received_events_url":"https://api.github.com/users/deliveroo/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/deliveroo/deliveroo.engineering","description":"Guidelines and conventions for good software at Deliveroo","fork":true,"url":"https://api.github.com/repos/deliveroo/deliveroo.engineering","forks_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/forks","keys_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/keys{/key_id}","collaborators_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/teams","hooks_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/hooks","issue_events_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/events{/number}","events_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/events","assignees_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/assignees{/user}","branches_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/branches{/branch}","tags_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/tags","blobs_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/refs{/sha}","trees_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/trees{/sha}","statuses_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/statuses/{sha}","languages_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/languages","stargazers_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/stargazers","contributors_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/contributors","subscribers_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/subscribers","subscription_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/subscription","commits_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/commits{/sha}","git_commits_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/git/commits{/sha}","comments_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/comments{/number}","issue_comment_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/comments{/number}","contents_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/contents/{+path}","compare_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/compare/{base}...{head}","merges_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/merges","archive_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/downloads","issues_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues{/number}","pulls_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls{/number}","milestones_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/milestones{/number}","notifications_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/labels{/name}","releases_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/releases{/id}","deployments_url":"https://api.github.com/repos/deliveroo/deliveroo.engineering/deployments","created_at":"2015-03-19T16:23:28Z","updated_at":"2016-09-15T15:29:29Z","pushed_at":"2016-09-15T22:15:15Z","git_url":"git://github.com/deliveroo/deliveroo.engineering.git","ssh_url":"git@github.com:deliveroo/deliveroo.engineering.git","clone_url":"https://github.com/deliveroo/deliveroo.engineering.git","svn_url":"https://github.com/deliveroo/deliveroo.engineering","homepage":"","size":4213,"stargazers_count":8,"watchers_count":8,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":2,"mirror_url":null,"open_issues_count":15,"forks":2,"open_issues":15,"watchers":8,"default_branch":"gh-pages"}},"_links":{"self":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45"},"html":{"href":"https://github.com/deliveroo/deliveroo.engineering/pull/45"},"issue":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/45"},"comments":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/issues/45/comments"},"review_comments":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45/comments"},"review_comment":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/pulls/45/commits"},"statuses":{"href":"https://api.github.com/repos/deliveroo/deliveroo.engineering/statuses/eeb252d0fdde0ad7b5fc24b8c6f4c8f17163addb"}}}}
{"actor":{"display_login":"mezis"}}