Browse Source

feat(api-docs): Update api-schema files (#20947)

* feat(api-docs): Update api-schema files
Colleen O'Rourke 4 years ago
parent
commit
efac779233

File diff suppressed because it is too large
+ 119 - 436
api-docs/openapi-derefed.json


+ 1 - 1
api-docs/paths/events/issue-hashes.json

@@ -38,7 +38,7 @@
             },
             "example": [
               {
-                "id": "dhgjkldfsghdfakjgh",
+                "id": "9999aaaaca8b46d797c23c6077c6ff01",
                 "latestEvent": {
                   "eventID": "9999aaaaca8b46d797c23c6077c6ff01",
                   "dist": null,

+ 5 - 2
api-docs/paths/projects/service-hook-details.json

@@ -66,7 +66,7 @@
   },
   "put": {
     "tags": ["Projects"],
-    "description": "Update a service hook",
+    "description": "Update a service hook.",
     "operationId": "Update a Service Hook",
     "parameters": [
       {
@@ -142,6 +142,9 @@
           }
         }
       },
+      "400": {
+        "description": "Bad Input"
+      },
       "403": {
         "description": "Forbidden"
       },
@@ -157,7 +160,7 @@
   },
   "delete": {
     "tags": ["Projects"],
-    "description": "Remove a service hook",
+    "description": "Remove a service hook.",
     "operationId": "Remove a Service Hook",
     "parameters": [
       {

+ 9 - 0
api-docs/paths/projects/user-feedback.json

@@ -55,6 +55,9 @@
       },
       "403": {
         "description": "Forbidden"
+      },
+      "404": {
+        "description": "Not Found"
       }
     },
     "security": [
@@ -145,11 +148,17 @@
           }
         }
       },
+      "400": {
+        "description": "Bad Input"
+      },
       "403": {
         "description": "Forbidden"
       },
       "404": {
         "description": "The requested resource does not exist"
+      },
+      "409": {
+        "description": "Conflict"
       }
     },
     "security": [

+ 1 - 1
api-docs/paths/releases/deploys.json

@@ -120,7 +120,7 @@
       }
     },
     "responses": {
-      "200": {
+      "201": {
         "description": "Success",
         "content": {
           "application/json": {

+ 1 - 1
api-docs/paths/releases/organization-releases.json

@@ -104,7 +104,7 @@
   },
   "post": {
     "tags": ["Releases"],
-    "description": "Create a new release for the given Organization.  Releases are used by\nSentry to improve its error reporting abilities by correlating\nfirst seen events with the release that might have introduced the\nproblem.\nReleases are also necessary for source maps and other debug features\nthat require manual upload for functioning well.",
+    "description": "Create a new release for the given organization.  Releases are used by\nSentry to improve its error reporting abilities by correlating\nfirst seen events with the release that might have introduced the\nproblem.\nReleases are also necessary for source maps and other debug features\nthat require manual upload for functioning well.",
     "operationId": "Create a New Release for an Organization",
     "parameters": [
       {

+ 1 - 1
api-docs/paths/teams/index.json

@@ -189,7 +189,7 @@
               },
               "slug": {
                 "type": "string",
-                "description": "The optional slug for this team. If not provided it will be auto generated from the name",
+                "description": "The optional slug for this team. If not provided it will be auto generated from the name.",
                 "example": "ancient-gabelers"
               }
             }

+ 2 - 2
api-docs/paths/teams/stats.json

@@ -1,7 +1,7 @@
 {
   "get": {
     "tags": ["Teams"],
-    "summary": "Caution\nThis endpoint may change in the future without notice.",
+    "summary": "Caution: this endpoint may change in the future without notice.",
     "description": "Return a set of points representing a normalized timestamp and the number of events seen in the period.\n\nQuery ranges are limited to Sentry’s configured time-series resolutions.",
     "operationId": "Retrieve Event Counts for a Team",
     "parameters": [
@@ -26,7 +26,7 @@
       {
         "name": "stat",
         "in": "query",
-        "description": "The name of the stat to query `(\"received\", \"rejected\")`",
+        "description": "The name of the stat to query `(\"received\", \"rejected\")`.",
         "schema": {
           "type": "string",
           "enum": ["received", "rejected"]

Some files were not shown because too many files changed in this diff