Просмотр исходного кода

ref(api-docs): Update api-schema files (#20923)

Colleen O'Rourke 4 лет назад
Родитель
Сommit
8b08c83a13

+ 12 - 0
api-docs/components/parameters/pagination-cursor.json

@@ -0,0 +1,12 @@
+{
+  "PaginationCursor": {
+    "name": "&cursor",
+    "in": "query",
+    "required": false,
+    "description": "A pointer to the last object fetched and its' sort order; used to retrieve the next or previous results.",
+    "x-learn-more": "https://docs.sentry.io/api/pagination/",
+    "schema": {
+      "type": "string"
+    }
+  }
+}

+ 353 - 0
api-docs/components/schemas/entries.json

@@ -0,0 +1,353 @@
+{
+  "Breadcrumbs": {
+    "type": "object",
+    "required": ["type", "data"],
+    "properties": {
+      "type": {
+        "type": "string"
+      },
+      "data": {
+        "type": "object",
+        "required": ["values"],
+        "properties": {
+          "values": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "category",
+                "level",
+                "event_id",
+                "timestamp",
+                "data",
+                "message",
+                "type"
+              ],
+              "properties": {
+                "category": {
+                  "type": "string"
+                },
+                "level": {
+                  "type": "string"
+                },
+                "event_id": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "timestamp": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "data": {
+                  "type": "object",
+                  "nullable": true
+                },
+                "message": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "type": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "Request": {
+    "type": "object",
+    "required": ["type", "data"],
+    "properties": {
+      "type": {
+        "type": "string"
+      },
+      "data": {
+        "type": "object",
+        "required": [
+          "fragment",
+          "cookies",
+          "inferredContentType",
+          "env",
+          "headers",
+          "url",
+          "query",
+          "data",
+          "method"
+        ],
+        "properties": {
+          "fragment": {
+            "type": "string",
+            "nullable": true
+          },
+          "cookies": {
+            "type": "array",
+            "nullable": true,
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "inferredContentType": {
+            "type": "string",
+            "nullable": true
+          },
+          "env": {
+            "type": "object",
+            "nullable": true,
+            "properties": {
+              "ENV": {
+                "type": "string"
+              }
+            }
+          },
+          "headers": {
+            "type": "array",
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "url": {
+            "type": "string"
+          },
+          "query": {
+            "type": "array",
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "data": {
+            "type": "object",
+            "nullable": true
+          },
+          "method": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      }
+    }
+  },
+  "Message": {
+    "type": "object",
+    "required": ["type", "data"],
+    "properties": {
+      "type": {
+        "type": "string"
+      },
+      "data": {
+        "type": "object",
+        "required": ["formatted"],
+        "properties": {
+          "formatted": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "Exception": {
+    "type": "object",
+    "required": ["type", "data"],
+    "properties": {
+      "type": {
+        "type": "string"
+      },
+      "data": {
+        "type": "object",
+        "required": ["excOmitted", "hasSystemFrames", "values"],
+        "properties": {
+          "excOmitted": {
+            "type": "array",
+            "nullable": true,
+            "items": {
+              "type": "integer"
+            }
+          },
+          "hasSystemFrames": {
+            "type": "boolean"
+          },
+          "values": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "stacktrace",
+                "module",
+                "rawStacktrace",
+                "mechanism",
+                "threadId",
+                "value",
+                "type"
+              ],
+              "properties": {
+                "stacktrace": {
+                  "type": "object",
+                  "nullable": true,
+                  "required": [
+                    "frames",
+                    "framesOmitted",
+                    "registers",
+                    "hasSystemFrames"
+                  ],
+                  "properties": {
+                    "frames": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "function",
+                          "errors",
+                          "colNo",
+                          "vars",
+                          "package",
+                          "absPath",
+                          "inApp",
+                          "lineNo",
+                          "module",
+                          "filename",
+                          "platform",
+                          "instructionAddr",
+                          "context",
+                          "symbolAddr",
+                          "trust",
+                          "symbol"
+                        ],
+                        "properties": {
+                          "function": {
+                            "type": "string"
+                          },
+                          "errors": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "colNo": {
+                            "type": "integer",
+                            "nullable": true
+                          },
+                          "vars": {
+                            "type": "object",
+                            "nullable": true
+                          },
+                          "package": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "absPath": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "inApp": {
+                            "type": "boolean"
+                          },
+                          "lineNo": {
+                            "type": "integer"
+                          },
+                          "module": {
+                            "type": "string"
+                          },
+                          "filename": {
+                            "type": "string"
+                          },
+                          "platform": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "instructionAddr": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "context": {
+                            "type": "array",
+                            "items": {
+                              "type": "array",
+                              "items": {
+                                "oneOf": [
+                                  {
+                                    "type": "integer"
+                                  },
+                                  {
+                                    "type": "string"
+                                  }
+                                ]
+                              }
+                            }
+                          },
+                          "symbolAddr": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "trust": {
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "symbol": {
+                            "type": "string",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "framesOmitted": {
+                      "type": "string",
+                      "nullable": true
+                    },
+                    "registers": {
+                      "type": "string",
+                      "nullable": true
+                    },
+                    "hasSystemFrames": {
+                      "type": "boolean"
+                    }
+                  }
+                },
+                "module": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "rawStacktrace": {
+                  "type": "object",
+                  "nullable": true
+                },
+                "mechanism": {
+                  "type": "object",
+                  "nullable": true,
+                  "properties": {
+                    "type": {
+                      "type": "string"
+                    },
+                    "handled": {
+                      "type": "boolean"
+                    }
+                  }
+                },
+                "threadId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "value": {
+                  "type": "string"
+                },
+                "type": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "Template": {
+    "type": "object"
+  }
+}

+ 692 - 2
api-docs/components/schemas/event.json

@@ -1,8 +1,698 @@
 {
   "Event": {
-    "type": "object"
+    "type": "object",
+    "required": [
+      "eventID",
+      "tags",
+      "dateCreated",
+      "user",
+      "message",
+      "id",
+      "platform",
+      "event.type",
+      "groupID",
+      "title"
+    ],
+    "properties": {
+      "eventID": {
+        "type": "string"
+      },
+      "tags": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "value": {
+              "type": "string"
+            },
+            "key": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "dateCreated": {
+        "type": "string"
+      },
+      "user": {
+        "$ref": "users.json#/EventUser"
+      },
+      "message": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string"
+      },
+      "platform": {
+        "type": "string"
+      },
+      "event.type": {
+        "type": "string"
+      },
+      "groupID": {
+        "type": "string"
+      },
+      "title": {
+        "type": "string"
+      }
+    }
   },
   "EventDetailed": {
-    "type": "object"
+    "type": "object",
+    "required": [
+      "eventID",
+      "dist",
+      "userReport",
+      "previousEventID",
+      "message",
+      "id",
+      "size",
+      "errors",
+      "platform",
+      "nextEventID",
+      "type",
+      "metadata",
+      "tags",
+      "dateCreated",
+      "dateReceived",
+      "user",
+      "entries",
+      "packages",
+      "sdk",
+      "_meta",
+      "contexts",
+      "fingerprints",
+      "context",
+      "release",
+      "groupID",
+      "title"
+    ],
+    "properties": {
+      "eventID": {
+        "type": "string"
+      },
+      "dist": {
+        "type": "string",
+        "nullable": true
+      },
+      "userReport": {
+        "type": "object",
+        "nullable": true
+      },
+      "previousEventID": {
+        "type": "string",
+        "nullable": true
+      },
+      "message": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string"
+      },
+      "size": {
+        "type": "integer"
+      },
+      "errors": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "message": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "data": {
+              "type": "object"
+            }
+          }
+        }
+      },
+      "platform": {
+        "type": "string"
+      },
+      "nextEventID": {
+        "type": "string",
+        "nullable": true
+      },
+      "type": {
+        "type": "string"
+      },
+      "metadata": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": ["type", "value"],
+            "properties": {
+              "type": {
+                "type": "string"
+              },
+              "value": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": ["title"],
+            "properties": {
+              "title": {
+                "type": "string"
+              }
+            }
+          }
+        ]
+      },
+      "tags": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "value": {
+              "type": "string"
+            },
+            "key": {
+              "type": "string"
+            },
+            "_meta": {
+              "type": "string",
+              "nullable": true
+            }
+          }
+        }
+      },
+      "dateCreated": {
+        "type": "string"
+      },
+      "dateReceived": {
+        "type": "string"
+      },
+      "user": {
+        "$ref": "users.json#/EventUser"
+      },
+      "entries": {
+        "type": "array",
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "entries.json#/Breadcrumbs"
+            },
+            {
+              "$ref": "entries.json#/Request"
+            },
+            {
+              "$ref": "entries.json#/Message"
+            },
+            {
+              "$ref": "entries.json#/Exception"
+            }
+          ]
+        }
+      },
+      "packages": {
+        "type": "object"
+      },
+      "sdk": {
+        "type": "object",
+        "properties": {
+          "version": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "_meta": {
+        "type": "object",
+        "properties": {
+          "user": {
+            "type": "string",
+            "nullable": true
+          },
+          "context": {
+            "type": "string",
+            "nullable": true
+          },
+          "entries": {
+            "type": "object"
+          },
+          "contexts": {
+            "type": "string",
+            "nullable": true
+          },
+          "message": {
+            "type": "string",
+            "nullable": true
+          },
+          "packages": {
+            "type": "string",
+            "nullable": true
+          },
+          "tags": {
+            "type": "object"
+          },
+          "sdk": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "contexts": {
+        "type": "object"
+      },
+      "fingerprints": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "context": {
+        "type": "object"
+      },
+      "release": {
+        "$ref": "releases/organization-release.json#/OrganizationRelease",
+        "nullable": true
+      },
+      "groupID": {
+        "type": "string"
+      },
+      "title": {
+        "type": "string"
+      }
+    }
+  },
+  "Hash": {
+    "type": "object",
+    "required": [
+      "eventID",
+      "dist",
+      "message",
+      "id",
+      "size",
+      "errors",
+      "platform",
+      "type",
+      "metadata",
+      "tags",
+      "dateCreated",
+      "dateReceived",
+      "user",
+      "entries",
+      "packages",
+      "sdk",
+      "_meta",
+      "contexts",
+      "fingerprints",
+      "context",
+      "groupID",
+      "title"
+    ],
+    "properties": {
+      "eventID": {
+        "type": "string"
+      },
+      "dist": {
+        "type": "string",
+        "nullable": true
+      },
+      "message": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string"
+      },
+      "size": {
+        "type": "integer"
+      },
+      "errors": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "message": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "data": {
+              "type": "object"
+            }
+          }
+        }
+      },
+      "platform": {
+        "type": "string"
+      },
+      "type": {
+        "type": "string"
+      },
+      "metadata": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": ["type", "value"],
+            "properties": {
+              "type": {
+                "type": "string"
+              },
+              "value": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": ["title"],
+            "properties": {
+              "title": {
+                "type": "string"
+              }
+            }
+          }
+        ]
+      },
+      "tags": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "value": {
+              "type": "string"
+            },
+            "key": {
+              "type": "string"
+            },
+            "_meta": {
+              "type": "string",
+              "nullable": true
+            }
+          }
+        }
+      },
+      "dateCreated": {
+        "type": "string"
+      },
+      "dateReceived": {
+        "type": "string"
+      },
+      "user": {
+        "$ref": "users.json#/EventUser"
+      },
+      "entries": {
+        "type": "array",
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "entries.json#/Breadcrumbs"
+            },
+            {
+              "$ref": "entries.json#/Request"
+            },
+            {
+              "$ref": "entries.json#/Message"
+            },
+            {
+              "$ref": "entries.json#/Exception"
+            }
+          ]
+        }
+      },
+      "packages": {
+        "type": "object"
+      },
+      "sdk": {
+        "type": "object",
+        "properties": {
+          "version": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "_meta": {
+        "type": "object",
+        "properties": {
+          "user": {
+            "type": "string",
+            "nullable": true
+          },
+          "context": {
+            "type": "string",
+            "nullable": true
+          },
+          "entries": {
+            "type": "object"
+          },
+          "contexts": {
+            "type": "string",
+            "nullable": true
+          },
+          "message": {
+            "type": "string",
+            "nullable": true
+          },
+          "packages": {
+            "type": "string",
+            "nullable": true
+          },
+          "tags": {
+            "type": "object"
+          },
+          "sdk": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "contexts": {
+        "type": "object"
+      },
+      "fingerprints": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "context": {
+        "type": "object"
+      },
+      "groupID": {
+        "type": "string"
+      },
+      "title": {
+        "type": "string"
+      }
+    }
+  },
+  "OrganizationEvent": {
+    "type": "object",
+    "required": [
+      "_meta",
+      "context",
+      "contexts",
+      "dateCreated",
+      "dateReceived",
+      "dist",
+      "entries",
+      "errors",
+      "eventID",
+      "fingerprints",
+      "groupID",
+      "id",
+      "message",
+      "metadata",
+      "packages",
+      "platform",
+      "sdk",
+      "size",
+      "tags",
+      "type",
+      "user",
+      "title"
+    ],
+    "properties": {
+      "_meta": {
+        "type": "object",
+        "properties": {
+          "context": {
+            "type": "string",
+            "nullable": true
+          },
+          "contexts": {
+            "type": "object",
+            "nullable": true
+          },
+          "entries": {
+            "type": "object"
+          },
+          "message": {
+            "type": "string",
+            "nullable": true
+          },
+          "packages": {
+            "type": "string",
+            "nullable": true
+          },
+          "sdk": {
+            "type": "string",
+            "nullable": true
+          },
+          "tags": {
+            "type": "object"
+          },
+          "user": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "context": {
+        "type": "object",
+        "properties": {
+          "emptyList": {
+            "type": "array",
+            "items": {}
+          },
+          "emptyMap": {
+            "type": "object"
+          },
+          "length": {
+            "type": "integer"
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "type": "integer"
+            }
+          },
+          "session": {
+            "type": "object",
+            "properties": {
+              "foo": {
+                "type": "string"
+              }
+            }
+          },
+          "unauthorized": {
+            "type": "boolean"
+          },
+          "url": {
+            "type": "string"
+          }
+        }
+      },
+      "contexts": {
+        "type": "object"
+      },
+      "dateCreated": {
+        "type": "string"
+      },
+      "dateReceived": {
+        "type": "string"
+      },
+      "dist": {
+        "type": "string",
+        "nullable": true
+      },
+      "entries": {
+        "type": "array",
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "entries.json#/Breadcrumbs"
+            },
+            {
+              "$ref": "entries.json#/Request"
+            },
+            {
+              "$ref": "entries.json#/Message"
+            },
+            {
+              "$ref": "entries.json#/Exception"
+            }
+          ]
+        }
+      },
+      "errors": {
+        "type": "array",
+        "items": {}
+      },
+      "eventID": {
+        "type": "string"
+      },
+      "fingerprints": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      },
+      "groupID": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string"
+      },
+      "message": {
+        "type": "string"
+      },
+      "metadata": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string"
+          }
+        }
+      },
+      "packages": {
+        "type": "object",
+        "properties": {
+          "my.package": {
+            "type": "string"
+          }
+        }
+      },
+      "platform": {
+        "type": "string"
+      },
+      "sdk": {
+        "type": "object",
+        "nullable": true
+      },
+      "size": {
+        "type": "integer"
+      },
+      "tags": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "_meta": {
+              "type": "string",
+              "nullable": true
+            },
+            "key": {
+              "type": "string"
+            },
+            "value": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "type": {
+        "type": "string"
+      },
+      "user": {
+        "$ref": "users.json#/EventUser"
+      },
+      "title": {
+        "type": "string"
+      }
+    }
   }
 }

+ 1 - 2
api-docs/components/schemas/releases/organization-release.json

@@ -57,8 +57,7 @@
         "nullable": true
       },
       "lastDeploy": {
-        "type": "string",
-        "format": "date-time",
+        "$ref": "deploy.json#/Deploy",
         "nullable": true
       },
       "lastEvent": {

+ 35 - 0
api-docs/components/schemas/users.json

@@ -149,5 +149,40 @@
         "type": "string"
       }
     }
+  },
+  "EventUser": {
+    "type": "object",
+    "nullable": true,
+    "required": ["username", "name", "ip_address", "email", "data", "id"],
+    "properties": {
+      "username": {
+        "type": "string",
+        "nullable": true
+      },
+      "name": {
+        "type": "string",
+        "nullable": true
+      },
+      "ip_address": {
+        "type": "string",
+        "nullable": true
+      },
+      "email": {
+        "type": "string",
+        "nullable": true
+      },
+      "data": {
+        "type": "object",
+        "nullable": true,
+        "properties": {
+          "isStaff": {
+            "type": "boolean"
+          }
+        }
+      },
+      "id": {
+        "type": "string"
+      }
+    }
   }
 }

Разница между файлами не показана из-за своего большого размера
+ 786 - 25
api-docs/openapi-derefed.json


+ 204 - 203
api-docs/openapi.json

@@ -1,212 +1,213 @@
 {
-    "openapi": "3.0.1",
-    "info": {
-      "title": "API Reference",
-      "description": "Sentry Public API",
-      "termsOfService": "http://sentry.io/terms/",
-      "contact": {
-        "email": "partners@sentry.io"
-      },
-      "license": {
-        "name": "Apache 2.0",
-        "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-      },
-      "version": "v0"
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API Reference",
+    "description": "Sentry Public API",
+    "termsOfService": "http://sentry.io/terms/",
+    "contact": {
+      "email": "partners@sentry.io"
     },
-    "servers": [
-      {
-        "url": "https://sentry.io/"
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+    },
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "https://sentry.io/"
+    }
+  ],
+  "tags": [
+    {
+      "name": "Teams",
+      "description": "Endpoints for teams",
+      "externalDocs": {
+        "description": "Found an error? Let us know.",
+        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/teams/&template=api_error_template.md"
       }
-    ],
-    "tags": [
-      {
-        "name": "Teams",
-        "description": "Endpoints for teams",
-        "externalDocs": {
-          "description": "Found an error? Let us know.",
-          "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/teams/&template=api_error_template.md"
-        }
-      },
-      {
-        "name": "Organizations",
-        "description": "Endpoints for organizations",
-        "externalDocs": {
-          "description": "Found an error? Let us know.",
-          "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
-        }
-      },
-      {
-        "name": "Projects",
-        "description": "Endpoints for projects",
-        "externalDocs": {
-          "description": "Found an error? Let us know.",
-          "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
-        }
-      },
-      {
-        "name": "Events",
-        "description": "Endpoints for events",
-        "externalDocs": {
-          "description": "Found an error? Let us know.",
-          "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
-        }
-      },
-      {
-        "name": "Releases",
-        "description": "Endpoints for releases",
-        "externalDocs": {
-          "description": "Found an error? Let us know.",
-          "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/teams/&template=api_error_template.md"
-        }
+    },
+    {
+      "name": "Organizations",
+      "description": "Endpoints for organizations",
+      "externalDocs": {
+        "description": "Found an error? Let us know.",
+        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
       }
-    ],
-    "paths": {
-      "/api/0/organizations/{organization_slug}/teams/": {
-        "$ref": "paths/teams/index.json"
-      },
-      "/api/0/teams/{organization_slug}/{team_slug}/": {
-        "$ref": "paths/teams/by-slug.json"
-      },
-      "/api/0/teams/{organization_slug}/{team_slug}/projects/": {
-        "$ref": "paths/teams/projects.json"
-      },
-      "/api/0/teams/{organization_slug}/{team_slug}/stats/": {
-        "$ref": "paths/teams/stats.json"
-      },
-      "/api/0/organizations/": {
-        "$ref": "paths/organizations/index.json"
-      },
-      "/api/0/organizations/{organization_slug}/eventids/{event_id}/": {
-        "$ref": "paths/organizations/event-id-lookup.json"
-      },
-      "/api/0/organizations/{organization_slug}/": {
-        "$ref": "paths/organizations/details.json"
-      },
-      "/api/0/organizations/{organization_slug}/projects/": {
-        "$ref": "paths/organizations/projects.json"
-      },
-      "/api/0/organizations/{organization_slug}/repos/": {
-        "$ref": "paths/organizations/repos.json"
-      },
-      "/api/0/organizations/{organization_slug}/repos/{repo_id}/commits/": {
-        "$ref": "paths/organizations/repo-commits.json"
-      },
-      "/api/0/organizations/{organization_slug}/stats/": {
-        "$ref": "paths/organizations/stats.json"
-      },
-      "/api/0/organizations/{organization_slug}/users/": {
-        "$ref": "paths/organizations/users.json"
-      },
-      "/api/0/organizations/{organization_slug}/shortids/{short_id}/": {
-        "$ref": "paths/organizations/shortid.json"
-      },
-      "/api/0/projects/": {
-        "$ref": "paths/projects/index.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/": {
-        "$ref": "paths/projects/details.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/files/dsyms/": {
-        "$ref": "paths/projects/dsyms.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/users/": {
-        "$ref": "paths/projects/users.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/tags/{key}/values/": {
-        "$ref": "paths/projects/tag-values.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/stats/": {
-        "$ref": "paths/projects/stats.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/user-feedback/": {
-        "$ref": "paths/projects/user-feedback.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/keys/": {
-        "$ref": "paths/projects/keys.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/keys/{key_id}/": {
-        "$ref": "paths/projects/key-details.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/hooks/": {
-        "$ref": "paths/projects/service-hooks.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/hooks/{hook_id}/": {
-        "$ref": "paths/projects/service-hook-details.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/events/{event_id}/": {
-        "$ref": "paths/events/project-event-details.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/events/": {
-        "$ref": "paths/events/project-events.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/issues/": {
-        "$ref": "paths/events/project-issues.json"
-      },
-      "/api/0/issues/{issue_id}/tags/{key}/values/": {
-        "$ref": "paths/events/tag-values.json"
-      },
-      "/api/0/issues/{issue_id}/tags/{key}/": {
-        "$ref": "paths/events/tag-details.json"
-      },
-      "/api/0/issues/{issue_id}/hashes/": {
-        "$ref": "paths/events/issue-hashes.json"
-      },
-      "/api/0/issues/{issue_id}/events/oldest/": {
-        "$ref": "paths/events/oldest-event.json"
-      },
-      "/api/0/issues/{issue_id}/events/latest/": {
-        "$ref": "paths/events/latest-event.json"
-      },
-      "/api/0/issues/{issue_id}/events/": {
-        "$ref": "paths/events/issue-events.json"
-      },
-      "/api/0/issues/{issue_id}/": {
-        "$ref": "paths/events/issue-details.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/": {
-        "$ref": "paths/releases/organization-releases.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/{version}/": {
-        "$ref": "paths/releases/organization-release.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/{version}/files/": {
-        "$ref": "paths/releases/release-files.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/": {
-        "$ref": "paths/releases/project-release-files.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/{version}/files/{file_id}/": {
-        "$ref": "paths/releases/release-file.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/{file_id}/": {
-        "$ref": "paths/releases/project-release-file.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/{version}/commits/": {
-        "$ref": "paths/releases/organization-release-commits.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/commits/": {
-        "$ref": "paths/releases/project-release-commits.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/{version}/commitfiles/": {
-        "$ref": "paths/releases/organization-release-commit-files.json"
-      },
-      "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/resolved/": {
-        "$ref": "paths/releases/project-issues-resolved-in-release.json"
-      },
-      "/api/0/organizations/{organization_slug}/releases/{version}/deploys/": {
-        "$ref": "paths/releases/deploys.json"
+    },
+    {
+      "name": "Projects",
+      "description": "Endpoints for projects",
+      "externalDocs": {
+        "description": "Found an error? Let us know.",
+        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/projects/&template=api_error_template.md"
+      }
+    },
+    {
+      "name": "Events",
+      "x-sidebar-name": "Events & Issues",
+      "description": "Endpoints for events and issues",
+      "externalDocs": {
+        "description": "Found an error? Let us know.",
+        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/events/&template=api_error_template.md"
       }
     },
-    "components": {
-      "securitySchemes": {
-        "auth_token": {
-          "type": "http",
-          "scheme": "bearer"
-        },
-        "dsn": {
-          "type": "http",
-          "scheme": "DSN"
-        }
+    {
+      "name": "Releases",
+      "description": "Endpoints for releases",
+      "externalDocs": {
+        "description": "Found an error? Let us know.",
+        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/releases/&template=api_error_template.md"
+      }
+    }
+  ],
+  "paths": {
+    "/api/0/organizations/{organization_slug}/teams/": {
+      "$ref": "paths/teams/index.json"
+    },
+    "/api/0/teams/{organization_slug}/{team_slug}/": {
+      "$ref": "paths/teams/by-slug.json"
+    },
+    "/api/0/teams/{organization_slug}/{team_slug}/projects/": {
+      "$ref": "paths/teams/projects.json"
+    },
+    "/api/0/teams/{organization_slug}/{team_slug}/stats/": {
+      "$ref": "paths/teams/stats.json"
+    },
+    "/api/0/organizations/": {
+      "$ref": "paths/organizations/index.json"
+    },
+    "/api/0/organizations/{organization_slug}/eventids/{event_id}/": {
+      "$ref": "paths/organizations/event-id-lookup.json"
+    },
+    "/api/0/organizations/{organization_slug}/": {
+      "$ref": "paths/organizations/details.json"
+    },
+    "/api/0/organizations/{organization_slug}/projects/": {
+      "$ref": "paths/organizations/projects.json"
+    },
+    "/api/0/organizations/{organization_slug}/repos/": {
+      "$ref": "paths/organizations/repos.json"
+    },
+    "/api/0/organizations/{organization_slug}/repos/{repo_id}/commits/": {
+      "$ref": "paths/organizations/repo-commits.json"
+    },
+    "/api/0/organizations/{organization_slug}/stats/": {
+      "$ref": "paths/organizations/stats.json"
+    },
+    "/api/0/organizations/{organization_slug}/users/": {
+      "$ref": "paths/organizations/users.json"
+    },
+    "/api/0/organizations/{organization_slug}/shortids/{short_id}/": {
+      "$ref": "paths/organizations/shortid.json"
+    },
+    "/api/0/projects/": {
+      "$ref": "paths/projects/index.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/": {
+      "$ref": "paths/projects/details.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/files/dsyms/": {
+      "$ref": "paths/projects/dsyms.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/users/": {
+      "$ref": "paths/projects/users.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/tags/{key}/values/": {
+      "$ref": "paths/projects/tag-values.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/stats/": {
+      "$ref": "paths/projects/stats.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/user-feedback/": {
+      "$ref": "paths/projects/user-feedback.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/keys/": {
+      "$ref": "paths/projects/keys.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/keys/{key_id}/": {
+      "$ref": "paths/projects/key-details.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/hooks/": {
+      "$ref": "paths/projects/service-hooks.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/hooks/{hook_id}/": {
+      "$ref": "paths/projects/service-hook-details.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/events/{event_id}/": {
+      "$ref": "paths/events/project-event-details.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/events/": {
+      "$ref": "paths/events/project-events.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/issues/": {
+      "$ref": "paths/events/project-issues.json"
+    },
+    "/api/0/issues/{issue_id}/tags/{key}/values/": {
+      "$ref": "paths/events/tag-values.json"
+    },
+    "/api/0/issues/{issue_id}/tags/{key}/": {
+      "$ref": "paths/events/tag-details.json"
+    },
+    "/api/0/issues/{issue_id}/hashes/": {
+      "$ref": "paths/events/issue-hashes.json"
+    },
+    "/api/0/issues/{issue_id}/events/oldest/": {
+      "$ref": "paths/events/oldest-event.json"
+    },
+    "/api/0/issues/{issue_id}/events/latest/": {
+      "$ref": "paths/events/latest-event.json"
+    },
+    "/api/0/issues/{issue_id}/events/": {
+      "$ref": "paths/events/issue-events.json"
+    },
+    "/api/0/issues/{issue_id}/": {
+      "$ref": "paths/events/issue-details.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/": {
+      "$ref": "paths/releases/organization-releases.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/{version}/": {
+      "$ref": "paths/releases/organization-release.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/{version}/files/": {
+      "$ref": "paths/releases/release-files.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/": {
+      "$ref": "paths/releases/project-release-files.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/{version}/files/{file_id}/": {
+      "$ref": "paths/releases/release-file.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/{file_id}/": {
+      "$ref": "paths/releases/project-release-file.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/{version}/commits/": {
+      "$ref": "paths/releases/organization-release-commits.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/commits/": {
+      "$ref": "paths/releases/project-release-commits.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/{version}/commitfiles/": {
+      "$ref": "paths/releases/organization-release-commit-files.json"
+    },
+    "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/resolved/": {
+      "$ref": "paths/releases/project-issues-resolved-in-release.json"
+    },
+    "/api/0/organizations/{organization_slug}/releases/{version}/deploys/": {
+      "$ref": "paths/releases/deploys.json"
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "auth_token": {
+        "type": "http",
+        "scheme": "bearer"
+      },
+      "dsn": {
+        "type": "http",
+        "scheme": "DSN"
       }
     }
   }
+}

+ 70 - 247
api-docs/paths/events/issue-details.json

@@ -1,10 +1,8 @@
 {
   "get": {
-    "tags": [
-      "Events"
-    ],
+    "tags": ["Events"],
     "description": "Return details on an individual issue. This returns the basic stats for the issue (title, last seen, first seen), some overall numbers (number of comments, user reports) as well as the summarized event data.",
-    "operationId": "Retrieve an issue",
+    "operationId": "Retrieve an Issue",
     "parameters": [
       {
         "name": "issue_id",
@@ -18,7 +16,7 @@
     ],
     "responses": {
       "200": {
-        "description": "Success.",
+        "description": "Success",
         "content": {
           "application/json": {
             "schema": {
@@ -91,232 +89,64 @@
               "shortId": "PUMP-STATION-1",
               "stats": {
                 "24h": [
-                  [
-                    1541451600.0,
-                    557
-                  ],
-                  [
-                    1541455200.0,
-                    473
-                  ],
-                  [
-                    1541458800.0,
-                    914
-                  ],
-                  [
-                    1541462400.0,
-                    991
-                  ],
-                  [
-                    1541466000.0,
-                    925
-                  ],
-                  [
-                    1541469600.0,
-                    881
-                  ],
-                  [
-                    1541473200.0,
-                    182
-                  ],
-                  [
-                    1541476800.0,
-                    490
-                  ],
-                  [
-                    1541480400.0,
-                    820
-                  ],
-                  [
-                    1541484000.0,
-                    322
-                  ],
-                  [
-                    1541487600.0,
-                    836
-                  ],
-                  [
-                    1541491200.0,
-                    565
-                  ],
-                  [
-                    1541494800.0,
-                    758
-                  ],
-                  [
-                    1541498400.0,
-                    880
-                  ],
-                  [
-                    1541502000.0,
-                    677
-                  ],
-                  [
-                    1541505600.0,
-                    381
-                  ],
-                  [
-                    1541509200.0,
-                    814
-                  ],
-                  [
-                    1541512800.0,
-                    329
-                  ],
-                  [
-                    1541516400.0,
-                    446
-                  ],
-                  [
-                    1541520000.0,
-                    731
-                  ],
-                  [
-                    1541523600.0,
-                    111
-                  ],
-                  [
-                    1541527200.0,
-                    926
-                  ],
-                  [
-                    1541530800.0,
-                    772
-                  ],
-                  [
-                    1541534400.0,
-                    400
-                  ],
-                  [
-                    1541538000.0,
-                    943
-                  ]
+                  [1541451600.0, 557],
+                  [1541455200.0, 473],
+                  [1541458800.0, 914],
+                  [1541462400.0, 991],
+                  [1541466000.0, 925],
+                  [1541469600.0, 881],
+                  [1541473200.0, 182],
+                  [1541476800.0, 490],
+                  [1541480400.0, 820],
+                  [1541484000.0, 322],
+                  [1541487600.0, 836],
+                  [1541491200.0, 565],
+                  [1541494800.0, 758],
+                  [1541498400.0, 880],
+                  [1541502000.0, 677],
+                  [1541505600.0, 381],
+                  [1541509200.0, 814],
+                  [1541512800.0, 329],
+                  [1541516400.0, 446],
+                  [1541520000.0, 731],
+                  [1541523600.0, 111],
+                  [1541527200.0, 926],
+                  [1541530800.0, 772],
+                  [1541534400.0, 400],
+                  [1541538000.0, 943]
                 ],
                 "30d": [
-                  [
-                    1538870400.0,
-                    565
-                  ],
-                  [
-                    1538956800.0,
-                    12862
-                  ],
-                  [
-                    1539043200.0,
-                    15617
-                  ],
-                  [
-                    1539129600.0,
-                    10809
-                  ],
-                  [
-                    1539216000.0,
-                    15065
-                  ],
-                  [
-                    1539302400.0,
-                    12927
-                  ],
-                  [
-                    1539388800.0,
-                    12994
-                  ],
-                  [
-                    1539475200.0,
-                    13139
-                  ],
-                  [
-                    1539561600.0,
-                    11838
-                  ],
-                  [
-                    1539648000.0,
-                    12088
-                  ],
-                  [
-                    1539734400.0,
-                    12338
-                  ],
-                  [
-                    1539820800.0,
-                    12768
-                  ],
-                  [
-                    1539907200.0,
-                    12816
-                  ],
-                  [
-                    1539993600.0,
-                    15356
-                  ],
-                  [
-                    1540080000.0,
-                    10910
-                  ],
-                  [
-                    1540166400.0,
-                    12306
-                  ],
-                  [
-                    1540252800.0,
-                    12912
-                  ],
-                  [
-                    1540339200.0,
-                    14700
-                  ],
-                  [
-                    1540425600.0,
-                    11890
-                  ],
-                  [
-                    1540512000.0,
-                    11684
-                  ],
-                  [
-                    1540598400.0,
-                    13510
-                  ],
-                  [
-                    1540684800.0,
-                    12625
-                  ],
-                  [
-                    1540771200.0,
-                    12811
-                  ],
-                  [
-                    1540857600.0,
-                    13180
-                  ],
-                  [
-                    1540944000.0,
-                    14651
-                  ],
-                  [
-                    1541030400.0,
-                    14161
-                  ],
-                  [
-                    1541116800.0,
-                    12612
-                  ],
-                  [
-                    1541203200.0,
-                    14316
-                  ],
-                  [
-                    1541289600.0,
-                    14742
-                  ],
-                  [
-                    1541376000.0,
-                    12505
-                  ],
-                  [
-                    1541462400.0,
-                    14180
-                  ]
+                  [1538870400.0, 565],
+                  [1538956800.0, 12862],
+                  [1539043200.0, 15617],
+                  [1539129600.0, 10809],
+                  [1539216000.0, 15065],
+                  [1539302400.0, 12927],
+                  [1539388800.0, 12994],
+                  [1539475200.0, 13139],
+                  [1539561600.0, 11838],
+                  [1539648000.0, 12088],
+                  [1539734400.0, 12338],
+                  [1539820800.0, 12768],
+                  [1539907200.0, 12816],
+                  [1539993600.0, 15356],
+                  [1540080000.0, 10910],
+                  [1540166400.0, 12306],
+                  [1540252800.0, 12912],
+                  [1540339200.0, 14700],
+                  [1540425600.0, 11890],
+                  [1540512000.0, 11684],
+                  [1540598400.0, 13510],
+                  [1540684800.0, 12625],
+                  [1540771200.0, 12811],
+                  [1540857600.0, 13180],
+                  [1540944000.0, 14651],
+                  [1541030400.0, 14161],
+                  [1541116800.0, 12612],
+                  [1541203200.0, 14316],
+                  [1541289600.0, 14742],
+                  [1541376000.0, 12505],
+                  [1541462400.0, 14180]
                 ]
               },
               "status": "unresolved",
@@ -337,18 +167,14 @@
     },
     "security": [
       {
-        "auth_token": [
-          "event:read"
-        ]
+        "auth_token": ["event:read"]
       }
     ]
   },
   "put": {
-    "tags": [
-      "Events"
-    ],
+    "tags": ["Events"],
     "description": "Updates an individual issue's attributes.  Only the attributes submitted are modified.",
-    "operationId": "Update an issue",
+    "operationId": "Update an Issue",
     "parameters": [
       {
         "name": "issue_id",
@@ -391,6 +217,9 @@
                 "description": "Sets the issue to public or private."
               }
             }
+          },
+          "example": {
+            "status": "unresolved"
           }
         }
       },
@@ -398,7 +227,7 @@
     },
     "responses": {
       "200": {
-        "description": "Success.",
+        "description": "Success",
         "content": {
           "application/json": {
             "schema": {
@@ -449,16 +278,12 @@
     },
     "security": [
       {
-        "auth_token": [
-          "event:write"
-        ]
+        "auth_token": ["event:write"]
       }
     ]
   },
   "delete": {
-    "tags": [
-      "Events"
-    ],
+    "tags": ["Events"],
     "description": "Removes an individual issue.",
     "operationId": "Remove an Issue",
     "parameters": [
@@ -474,7 +299,7 @@
     ],
     "responses": {
       "202": {
-        "description": "Success."
+        "description": "Success"
       },
       "403": {
         "description": "Forbidden"
@@ -485,9 +310,7 @@
     },
     "security": [
       {
-        "auth_token": [
-          "event:admin"
-        ]
+        "auth_token": ["event:admin"]
       }
     ]
   }

+ 52 - 9
api-docs/paths/events/issue-events.json

@@ -1,10 +1,8 @@
 {
   "get": {
-    "tags": [
-      "Events"
-    ],
+    "tags": ["Events"],
     "description": "This endpoint lists an issue's events.",
-    "operationId": "List a issue's events",
+    "operationId": "List an Issue's Events",
     "parameters": [
       {
         "name": "issue_id",
@@ -26,7 +24,7 @@
     ],
     "responses": {
       "200": {
-        "description": "Success.",
+        "description": "Success",
         "content": {
           "application/json": {
             "schema": {
@@ -34,7 +32,54 @@
               "items": {
                 "$ref": "../../components/schemas/event.json#/Event"
               }
-            }
+            },
+            "example": [
+              {
+                "eventID": "9fac2ceed9344f2bbfdd1fdacb0ed9b1",
+                "tags": [
+                  {
+                    "key": "browser",
+                    "value": "Chrome 60.0"
+                  },
+                  {
+                    "key": "device",
+                    "value": "Other"
+                  },
+                  {
+                    "key": "environment",
+                    "value": "production"
+                  },
+                  {
+                    "value": "fatal",
+                    "key": "level"
+                  },
+                  {
+                    "key": "os",
+                    "value": "Mac OS X 10.12.6"
+                  },
+                  {
+                    "value": "CPython 2.7.16",
+                    "key": "runtime"
+                  },
+                  {
+                    "key": "release",
+                    "value": "17642328ead24b51867165985996d04b29310337"
+                  },
+                  {
+                    "key": "server_name",
+                    "value": "web1.example.com"
+                  }
+                ],
+                "dateCreated": "2020-09-11T17:46:36Z",
+                "user": null,
+                "message": "",
+                "title": "This is an example Python exception",
+                "id": "dfb1a2d057194e76a4186cc8a5271553",
+                "platform": "python",
+                "event.type": "error",
+                "groupID": "1889724436"
+              }
+            ]
           }
         }
       },
@@ -44,9 +89,7 @@
     },
     "security": [
       {
-        "auth_token": [
-          "event:read"
-        ]
+        "auth_token": ["event:read"]
       }
     ]
   }

Разница между файлами не показана из-за своего большого размера
+ 401 - 14
api-docs/paths/events/issue-hashes.json


Некоторые файлы не были показаны из-за большого количества измененных файлов