{"action":"created","comment":{"url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/comments/112756574","pull_request_review_id":34100590,"id":112756574,"diff_hunk":"@@ -0,0 +1,96 @@\n+# Automated Guidelines for OpenAPI(swagger) specs Authoring #\n+\n+This document lists the set of automated rules that can be validated against OpenAPI(swagger) spec by running [validation tools](https://github.com/Azure/adx-documentation-pr/wiki/OpenAPI-Validation-tools). Please look [here for Manual guidelines](swagger-authoring-manual-guidelines.md).\n+\n+It is a requirement to conform to all manual and automated rules with severity \"Error\" before sending a pull request for review.\n+\n+We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an intimate knowledge of a service endpoint and its developer experience to avoid feeding inefficiencies into teams that focus on Azure developer experiences and the rest of the Azure eco-system.\n+\n+## Error vs Warning\n+- Rules with severity \"Error\" have to be addressed for the OpenAPI(swagger) spec to be approved by the reviewers. If there is a strong reason for why the rule cannot be addressed in an OpenAPI(swagger) spec, [suppression process](https://github.com/Azure/adx-documentation-pr/wiki/Swagger-Validation-Errors-Suppression) has to be followed to get sign off.","path":"documentation/swagger-authoring-automated-guidelines.md","position":10,"original_position":10,"commit_id":"cc18907b03939c38070a4fdb0b49869745fe7887","original_commit_id":"cc18907b03939c38070a4fdb0b49869745fe7887","user":{"login":"veronicagg","id":17714137,"avatar_url":"https://avatars1.githubusercontent.com/u/17714137?v=3","gravatar_id":"","url":"https://api.github.com/users/veronicagg","html_url":"https://github.com/veronicagg","followers_url":"https://api.github.com/users/veronicagg/followers","following_url":"https://api.github.com/users/veronicagg/following{/other_user}","gists_url":"https://api.github.com/users/veronicagg/gists{/gist_id}","starred_url":"https://api.github.com/users/veronicagg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/veronicagg/subscriptions","organizations_url":"https://api.github.com/users/veronicagg/orgs","repos_url":"https://api.github.com/users/veronicagg/repos","events_url":"https://api.github.com/users/veronicagg/events{/privacy}","received_events_url":"https://api.github.com/users/veronicagg/received_events","type":"User","site_admin":false},"body":"if that's the case this sentence may need to be, \"If there's a strong reason for why the rule cannot be addressed.... , then follow <this process>\", and not mention suppression. I just think it may be confusing for folks thinking everything should be suppressed. It's up to you to change it, if you feel other wise. thanks!","created_at":"2017-04-21T19:00:52Z","updated_at":"2017-04-21T19:00:52Z","html_url":"https://github.com/Azure/azure-rest-api-specs/pull/1135#discussion_r112756574","pull_request_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135","_links":{"self":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/comments/112756574"},"html":{"href":"https://github.com/Azure/azure-rest-api-specs/pull/1135#discussion_r112756574"},"pull_request":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135"}}},"pull_request":{"url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135","id":116440781,"html_url":"https://github.com/Azure/azure-rest-api-specs/pull/1135","diff_url":"https://github.com/Azure/azure-rest-api-specs/pull/1135.diff","patch_url":"https://github.com/Azure/azure-rest-api-specs/pull/1135.patch","issue_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues/1135","number":1135,"state":"open","locked":false,"title":"Checklist that separates automated and manual guidelines. ","user":{"login":"kirthik","id":1267650,"avatar_url":"https://avatars3.githubusercontent.com/u/1267650?v=3","gravatar_id":"","url":"https://api.github.com/users/kirthik","html_url":"https://github.com/kirthik","followers_url":"https://api.github.com/users/kirthik/followers","following_url":"https://api.github.com/users/kirthik/following{/other_user}","gists_url":"https://api.github.com/users/kirthik/gists{/gist_id}","starred_url":"https://api.github.com/users/kirthik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kirthik/subscriptions","organizations_url":"https://api.github.com/users/kirthik/orgs","repos_url":"https://api.github.com/users/kirthik/repos","events_url":"https://api.github.com/users/kirthik/events{/privacy}","received_events_url":"https://api.github.com/users/kirthik/received_events","type":"User","site_admin":false},"body":"This will be a good starting point but it is NOT complete yet.\r\n\r\nThis checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process. \r\n\r\n### PR information\r\n- [x ] The title of the PR is clear and informative.\r\n- [x ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, [see this page](https://github.com/Azure/azure-powershell/blob/dev/documentation/cleaning-up-commits.md).\r\n- [ x] Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.\r\n- [ ] If applicable, the PR references the bug/issue that it fixes.\r\n- [ ] Swagger files are correctly named (e.g. the `api-version` in the path should match the `api-version` in the spec).\r\n\r\n### Quality of Swagger\r\n- [ ] I have read the [contribution guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/.github/CONTRIBUTING.md).\r\n- [ ] My spec meets the review criteria:\r\n  - [ ] The spec conforms to the [Swagger 2.0 specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).\r\n  - [ ] The spec follows the guidelines described in the [Swagger checklist](../documentation/swagger-checklist.md) document.\r\n  - [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR. \r\n","created_at":"2017-04-18T23:20:36Z","updated_at":"2017-04-21T19:00:52Z","closed_at":null,"merged_at":null,"merge_commit_sha":"ca45de8d8f6976e77443638d9b2f5f3819cd8dd1","assignee":{"login":"veronicagg","id":17714137,"avatar_url":"https://avatars1.githubusercontent.com/u/17714137?v=3","gravatar_id":"","url":"https://api.github.com/users/veronicagg","html_url":"https://github.com/veronicagg","followers_url":"https://api.github.com/users/veronicagg/followers","following_url":"https://api.github.com/users/veronicagg/following{/other_user}","gists_url":"https://api.github.com/users/veronicagg/gists{/gist_id}","starred_url":"https://api.github.com/users/veronicagg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/veronicagg/subscriptions","organizations_url":"https://api.github.com/users/veronicagg/orgs","repos_url":"https://api.github.com/users/veronicagg/repos","events_url":"https://api.github.com/users/veronicagg/events{/privacy}","received_events_url":"https://api.github.com/users/veronicagg/received_events","type":"User","site_admin":false},"assignees":[{"login":"veronicagg","id":17714137,"avatar_url":"https://avatars1.githubusercontent.com/u/17714137?v=3","gravatar_id":"","url":"https://api.github.com/users/veronicagg","html_url":"https://github.com/veronicagg","followers_url":"https://api.github.com/users/veronicagg/followers","following_url":"https://api.github.com/users/veronicagg/following{/other_user}","gists_url":"https://api.github.com/users/veronicagg/gists{/gist_id}","starred_url":"https://api.github.com/users/veronicagg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/veronicagg/subscriptions","organizations_url":"https://api.github.com/users/veronicagg/orgs","repos_url":"https://api.github.com/users/veronicagg/repos","events_url":"https://api.github.com/users/veronicagg/events{/privacy}","received_events_url":"https://api.github.com/users/veronicagg/received_events","type":"User","site_admin":false},{"login":"salameer","id":18127647,"avatar_url":"https://avatars0.githubusercontent.com/u/18127647?v=3","gravatar_id":"","url":"https://api.github.com/users/salameer","html_url":"https://github.com/salameer","followers_url":"https://api.github.com/users/salameer/followers","following_url":"https://api.github.com/users/salameer/following{/other_user}","gists_url":"https://api.github.com/users/salameer/gists{/gist_id}","starred_url":"https://api.github.com/users/salameer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/salameer/subscriptions","organizations_url":"https://api.github.com/users/salameer/orgs","repos_url":"https://api.github.com/users/salameer/repos","events_url":"https://api.github.com/users/salameer/events{/privacy}","received_events_url":"https://api.github.com/users/salameer/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135/commits","review_comments_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135/comments","review_comment_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues/1135/comments","statuses_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/statuses/cc18907b03939c38070a4fdb0b49869745fe7887","head":{"label":"kirthik:master","ref":"master","sha":"cc18907b03939c38070a4fdb0b49869745fe7887","user":{"login":"kirthik","id":1267650,"avatar_url":"https://avatars3.githubusercontent.com/u/1267650?v=3","gravatar_id":"","url":"https://api.github.com/users/kirthik","html_url":"https://github.com/kirthik","followers_url":"https://api.github.com/users/kirthik/followers","following_url":"https://api.github.com/users/kirthik/following{/other_user}","gists_url":"https://api.github.com/users/kirthik/gists{/gist_id}","starred_url":"https://api.github.com/users/kirthik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kirthik/subscriptions","organizations_url":"https://api.github.com/users/kirthik/orgs","repos_url":"https://api.github.com/users/kirthik/repos","events_url":"https://api.github.com/users/kirthik/events{/privacy}","received_events_url":"https://api.github.com/users/kirthik/received_events","type":"User","site_admin":false},"repo":{"id":66035245,"name":"azure-rest-api-specs","full_name":"kirthik/azure-rest-api-specs","owner":{"login":"kirthik","id":1267650,"avatar_url":"https://avatars3.githubusercontent.com/u/1267650?v=3","gravatar_id":"","url":"https://api.github.com/users/kirthik","html_url":"https://github.com/kirthik","followers_url":"https://api.github.com/users/kirthik/followers","following_url":"https://api.github.com/users/kirthik/following{/other_user}","gists_url":"https://api.github.com/users/kirthik/gists{/gist_id}","starred_url":"https://api.github.com/users/kirthik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kirthik/subscriptions","organizations_url":"https://api.github.com/users/kirthik/orgs","repos_url":"https://api.github.com/users/kirthik/repos","events_url":"https://api.github.com/users/kirthik/events{/privacy}","received_events_url":"https://api.github.com/users/kirthik/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/kirthik/azure-rest-api-specs","description":"The source for REST API specifications for Microsoft Azure.","fork":true,"url":"https://api.github.com/repos/kirthik/azure-rest-api-specs","forks_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/forks","keys_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/teams","hooks_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/hooks","issue_events_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/issues/events{/number}","events_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/events","assignees_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/assignees{/user}","branches_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/branches{/branch}","tags_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/tags","blobs_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/git/refs{/sha}","trees_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/statuses/{sha}","languages_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/languages","stargazers_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/stargazers","contributors_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/contributors","subscribers_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/subscribers","subscription_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/subscription","commits_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/commits{/sha}","git_commits_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/git/commits{/sha}","comments_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/comments{/number}","issue_comment_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/issues/comments{/number}","contents_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/contents/{+path}","compare_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/merges","archive_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/downloads","issues_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/issues{/number}","pulls_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/pulls{/number}","milestones_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/milestones{/number}","notifications_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/labels{/name}","releases_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/releases{/id}","deployments_url":"https://api.github.com/repos/kirthik/azure-rest-api-specs/deployments","created_at":"2016-08-18T22:38:25Z","updated_at":"2016-08-18T22:38:27Z","pushed_at":"2017-04-21T12:42:11Z","git_url":"git://github.com/kirthik/azure-rest-api-specs.git","ssh_url":"git@github.com:kirthik/azure-rest-api-specs.git","clone_url":"https://github.com/kirthik/azure-rest-api-specs.git","svn_url":"https://github.com/kirthik/azure-rest-api-specs","homepage":"","size":7956,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"Azure:master","ref":"master","sha":"961af726dbc0c0417ec6a1b2a4d0487bc6497848","user":{"login":"Azure","id":6844498,"avatar_url":"https://avatars3.githubusercontent.com/u/6844498?v=3","gravatar_id":"","url":"https://api.github.com/users/Azure","html_url":"https://github.com/Azure","followers_url":"https://api.github.com/users/Azure/followers","following_url":"https://api.github.com/users/Azure/following{/other_user}","gists_url":"https://api.github.com/users/Azure/gists{/gist_id}","starred_url":"https://api.github.com/users/Azure/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Azure/subscriptions","organizations_url":"https://api.github.com/users/Azure/orgs","repos_url":"https://api.github.com/users/Azure/repos","events_url":"https://api.github.com/users/Azure/events{/privacy}","received_events_url":"https://api.github.com/users/Azure/received_events","type":"Organization","site_admin":false},"repo":{"id":39093389,"name":"azure-rest-api-specs","full_name":"Azure/azure-rest-api-specs","owner":{"login":"Azure","id":6844498,"avatar_url":"https://avatars3.githubusercontent.com/u/6844498?v=3","gravatar_id":"","url":"https://api.github.com/users/Azure","html_url":"https://github.com/Azure","followers_url":"https://api.github.com/users/Azure/followers","following_url":"https://api.github.com/users/Azure/following{/other_user}","gists_url":"https://api.github.com/users/Azure/gists{/gist_id}","starred_url":"https://api.github.com/users/Azure/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Azure/subscriptions","organizations_url":"https://api.github.com/users/Azure/orgs","repos_url":"https://api.github.com/users/Azure/repos","events_url":"https://api.github.com/users/Azure/events{/privacy}","received_events_url":"https://api.github.com/users/Azure/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Azure/azure-rest-api-specs","description":"The source for REST API specifications for Microsoft Azure.","fork":false,"url":"https://api.github.com/repos/Azure/azure-rest-api-specs","forks_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/forks","keys_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/teams","hooks_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/hooks","issue_events_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues/events{/number}","events_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/events","assignees_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/assignees{/user}","branches_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/branches{/branch}","tags_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/tags","blobs_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/git/refs{/sha}","trees_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/statuses/{sha}","languages_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/languages","stargazers_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/stargazers","contributors_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/contributors","subscribers_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/subscribers","subscription_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/subscription","commits_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/commits{/sha}","git_commits_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/git/commits{/sha}","comments_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/comments{/number}","issue_comment_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues/comments{/number}","contents_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/contents/{+path}","compare_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/merges","archive_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/downloads","issues_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues{/number}","pulls_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls{/number}","milestones_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/milestones{/number}","notifications_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/labels{/name}","releases_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/releases{/id}","deployments_url":"https://api.github.com/repos/Azure/azure-rest-api-specs/deployments","created_at":"2015-07-14T18:37:13Z","updated_at":"2017-04-21T15:09:43Z","pushed_at":"2017-04-21T18:39:59Z","git_url":"git://github.com/Azure/azure-rest-api-specs.git","ssh_url":"git@github.com:Azure/azure-rest-api-specs.git","clone_url":"https://github.com/Azure/azure-rest-api-specs.git","svn_url":"https://github.com/Azure/azure-rest-api-specs","homepage":"","size":8440,"stargazers_count":136,"watchers_count":136,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":322,"mirror_url":null,"open_issues_count":159,"forks":322,"open_issues":159,"watchers":136,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135"},"html":{"href":"https://github.com/Azure/azure-rest-api-specs/pull/1135"},"issue":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues/1135"},"comments":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/issues/1135/comments"},"review_comments":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135/comments"},"review_comment":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/1135/commits"},"statuses":{"href":"https://api.github.com/repos/Azure/azure-rest-api-specs/statuses/cc18907b03939c38070a4fdb0b49869745fe7887"}}}}
{"actor":{"display_login":"veronicagg"}}