GitHub PullRequestReviewCommentEvent at 2014-05-07 13:36:07
Repository: otter
Actor: lvh
Payload: {"comment":{"url":"https://api.github.com/repos/rackerlabs/otter/pulls/comments/12376342","id":12376342,"diff_hunk":"@@ -1,64 +1,585 @@\n \n+     \n      <!--\n-         A collection of common faults, these are pretty much expected\n-         in every request.\n+         A collection of common faults possible with every endpoint.\n      -->\n      <!ENTITY commonFaults\n            '\n-          <response xmlns=\"http://wadl.dev.java.net/2009/02\">\n-              <doc title=\"Identity fault\"></doc>\n-              <representation mediaType=\"application/xml\" element=\"identity:identityFault\"/>\n-              <representation mediaType=\"application/json\"/>\n-          </response>\n-          <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-              <doc title=\"Error\">A general error occured.</doc>\n-              <representation mediaType=\"application/xml\" element=\"identity:badRequest\"/>\n-              <representation mediaType=\"application/json\"/>\n-          </response>\n           <response status=\"401\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-              <doc title=\"Bad Request\">The format of the specified request is invalid.</doc>\n+              <doc title=\"Unauthorized\">The request requires user authentication.</doc>\n               <representation mediaType=\"application/xml\" element=\"identity:unauthorized\"/>\n               <representation mediaType=\"application/json\"/>\n           </response>\n           <response status=\"403\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-              <doc title=\"Forbidden\"></doc>\n+              <doc title=\"Forbidden\">The server understood the request but is refusing to fulfill it; reasons should be given in the response.</doc>\n               <representation mediaType=\"application/xml\" element=\"identity:forbidden\"/>\n               <representation mediaType=\"application/json\"/>\n-          </response>\n+          </response>          \n           <response status=\"405\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-               <doc title=\"Bad Method\">The method is unavailable</doc>\n+               <doc title=\"Invalid Method\">The method used is unavailable for the endpoint.</doc>\n               <representation mediaType=\"application/xml\" element=\"identity:badMethod\"/>\n               <representation mediaType=\"application/json\"/>\n           </response>\n           <response status=\"413\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-              <doc title=\"Over Limit\">The number of items returned is above the allowed limit.</doc>\n+              <doc title=\"Rate Limit Error\">The user has surpassed their rate limit.</doc>\n               <representation mediaType=\"application/xml\" element=\"identity:overLimit\"/>\n               <representation mediaType=\"application/json\"/>\n           </response>\n+          <response status=\"500\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+              <doc title=\"Internal Error\">An error internal to the application has occurred, please file a bug report.</doc>\n+              <representation mediaType=\"application/xml\" element=\"identity:internal\"/>\n+              <representation mediaType=\"application/json\"/>\n+          </response>\n           <response status=\"503\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-              <doc title=\"Service Unavailable\">The requested service is unavailable.</doc>\n+              <doc title=\"Service Unavailable\">The requested service is unavailable, please file a bug report.</doc>\n               <representation mediaType=\"application/xml\" element=\"identity:serviceUnavailable\"/>\n               <representation mediaType=\"application/json\"/>\n           </response>\n            '>\n+           \n+           \n       <!--\n           Faults on GET\n       -->\n      <!ENTITY getFaults\n            '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid Query\">The query argument is malformed.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badQuery\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n         <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n-            <doc title=\"File not found\">Resource not found.</doc>\n+            <doc title=\"File Not Found\">Resource not found.</doc>\n             <representation mediaType=\"application/xml\" element=\"identity:itemNotFound\"/>\n             <representation mediaType=\"application/json\"/>\n         </response>\n            '>\n+           \n       <!--\n           Faults on POST/PUT\n       -->\n      <!ENTITY postPutFaults\n            '\n+          <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+              <doc title=\"Bad Request: Invalid Json\">A syntax or parameter error. Request body was invalid Json.</doc>\n+              <representation mediaType=\"application/xml\" element=\"identity:badRequestInvalidJson\"/>\n+              <representation mediaType=\"application/json\"/>\n+          </response>\n+          <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+              <doc title=\"Bad Request: Validation\">A syntax or parameter error. Request body had valid Json \n+              but with unexpected properties or values. We will try to list the most common mistakes for each particular request. </doc>\n+              <representation mediaType=\"application/xml\" element=\"identity:badRequestValidation\"/>\n+              <representation mediaType=\"application/json\"/>\n+          </response>\n         <response status=\"415\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+            <doc title=\"Unsupported Media Type\">The request is refused because the entity of the request is in a format not supported by the requested resource for the requested method.</doc>\n             <representation mediaType=\"application/xml\" element=\"identity:badMediaType\"/>\n             <representation mediaType=\"application/json\"/>\n         </response>\n            '>\n+          \n+      <!-- \n+          Faults on List Scaling Groups\n+      -->\n+     <!ENTITY listGroupFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid Query\">The \"limit\" query argument is not a valid integer.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badQuery\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+\n+      <!--\n+          Faults on Create Scaling Groups\n+      -->\n+     <!ENTITY createGroupFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid minEntities\">The \"minEntities\" value is greater than the \"maxEntities\" value.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badMinEntities\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration imageRef\">The \"imageRef\" value is invalid or not active.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigImageRef\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration flavorRef\">The \"flavorRef\" value is invalid.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigFlavorRef\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration personality encoding\">The base64 encoding for the \"path\" argument in the \"personality\" parameter is invalid.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigPersonalityEncoding\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration personality files\">The number of files in the \"personality\" parameter exceeds maximum limit.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigPersonalityFiles\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration personality files content\">The content of the files in the \"personality\" parameter exceeds the maximum size limit allowed.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigPersonalityFilesContent\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration load balancer\">The load balancer ID provided is invalid.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigLb\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"422\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Scaling Group Over Limits\">The user has reached their quota for scaling groups, currently 100.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:overGroupLimit\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+           Faults on Show Scaling Groups Details\n+      -->\n+     <!ENTITY showGroupDetailsFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid Query Argument\">The \"limit\" query argument value is not a valid integer.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLimitArg\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+            Faults on Delete Scaling Groups\n+      -->\n+     <!ENTITY deleteGroupFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid Query Argument\">The \"force\" query argument value is invalid. It must be \"true\".</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badForceArg\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"403\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Forbidden: Scaling Group Not Empty\">The scaling group cannot be deleted because it has servers in it. Use the \"force=true\" query argument to force delete the group.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:groupNotEmpty\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+            Faults on Get Scaling Group State\n+      -->\n+     <!ENTITY getGroupStateFaults\n+           '\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+            Faults on Show Scaling Group Configuration\n+      -->\n+     <!ENTITY getGroupConfigurationFaults\n+           '\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+            Faults on Update Scaling Group Configuration\n+      -->\n+     <!ENTITY updateGroupConfigurationFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid minEntities\">The minEntities value is greater than the maxEntities value.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:invalidMinEntities\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+             Faults on Show Launch Configuration\n+      -->\n+     <!ENTITY getLaunchConfigurationFaults\n+           '\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+               Faults on Update Launch Configuration\n+      -->\n+     <!ENTITY updateLaunchConfigurationFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration imageRef\">The \"imageRef\" value is invalid or not active.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigImageRef\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration flavorRef\">The \"flavorRef\" value is invalid.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigFlavorRef\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration personality encoding\">The base64 encoding for the \"path\" argument in the \"personality\" parameter is invalid.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigPersonalityEncoding\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration personality files\">The number of files in the \"personality\" parameter exceeds maximum limit.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigPersonalityFiles\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration personality files content\">The content of the files in the \"personality\" parameter exceeds the maximum size limit allowed.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigPersonalityFilesContent\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid launchConfiguration load balancer\">The load balancer ID provided is invalid.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLaunchConfigLb\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+                Faults on List Policies\n+      -->\n+     <!ENTITY listPoliciesFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid Query Argument\">The \"limit\" query argument value is not a valid integer.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badLimitArg\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"404\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Group Not Found\">The specified scaling group was not found.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:noSuchGroup\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+           '>\n+           \n+      <!--\n+                Faults on Create Policies\n+      -->\n+     <!ENTITY createPolicyFaults\n+           '\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid at Value\">The \"at\" value does not correspond to \"YYYY-MM-DDTHH:MM:SS.SSSS\" format.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badAtValue\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Invalid cron Expression\">The \"cron\" value is invalid. It either contains a seconds component or is invalid cron expression.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:badCronValue\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Missing args Parameter\">The \"args\" parameter is not supplied and this is a \"schedule\" type policy.</doc>\n+            <representation mediaType=\"application/xml\" element=\"identity:missingArgsForSchedulePolicy\"/>\n+            <representation mediaType=\"application/json\"/>\n+        </response>\n+        <response status=\"400\" xmlns=\"http://wadl.dev.java.net/2009/02\">\n+             <doc title=\"Bad Request: Missing Time Parameter\">Neither \"at\" or \"cron\" values for the \"args\" parameter are supplied and this is a \"schedule\" type policy.</doc>","path":"docbook/src/common/common.ent","position":331,"original_position":331,"commit_id":"9ccd8a5c1cd48a656898b6705cf0d180729bc9f4","original_commit_id":"9ccd8a5c1cd48a656898b6705cf0d180729bc9f4","user":{"login":"lvh","id":97816,"avatar_url":"https://avatars.githubusercontent.com/u/97816?","gravatar_id":"415203f2727ceaf56d8f7f5e6d5d508b","url":"https://api.github.com/users/lvh","html_url":"https://github.com/lvh","followers_url":"https://api.github.com/users/lvh/followers","following_url":"https://api.github.com/users/lvh/following{/other_user}","gists_url":"https://api.github.com/users/lvh/gists{/gist_id}","starred_url":"https://api.github.com/users/lvh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lvh/subscriptions","organizations_url":"https://api.github.com/users/lvh/orgs","repos_url":"https://api.github.com/users/lvh/repos","events_url":"https://api.github.com/users/lvh/events{/privacy}","received_events_url":"https://api.github.com/users/lvh/received_events","type":"User","site_admin":false},"body":"My brain was expecting \"neither ... nor ... nor ...\" instead of \"neither ... or ... or ...\". I am not a native speaker, so maybe this is also completely fine :)","created_at":"2014-05-07T13:36:07Z","updated_at":"2014-05-07T13:36:07Z","html_url":"https://github.com/rackerlabs/otter/pull/622#discussion_r12376342","pull_request_url":"https://api.github.com/repos/rackerlabs/otter/pulls/622","_links":{"self":{"href":"https://api.github.com/repos/rackerlabs/otter/pulls/comments/12376342"},"html":{"href":"https://github.com/rackerlabs/otter/pull/622#discussion_r12376342"},"pull_request":{"href":"https://api.github.com/repos/rackerlabs/otter/pulls/622"}}}}