issue-events.json 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. {
  2. "get": {
  3. "tags": ["Events"],
  4. "description": "This endpoint lists an issue's events.",
  5. "operationId": "List an Issue's Events",
  6. "parameters": [
  7. {
  8. "name": "organization_slug",
  9. "in": "path",
  10. "description": "The slug of the organization the issues belongs to.",
  11. "required": true,
  12. "schema": {
  13. "type": "string"
  14. }
  15. },
  16. {
  17. "name": "issue_id",
  18. "in": "path",
  19. "description": "The ID of the issue to retrieve.",
  20. "required": true,
  21. "schema": {
  22. "type": "string"
  23. }
  24. },
  25. {
  26. "name": "full",
  27. "in": "query",
  28. "description": "If this is set to true then the event payload will include the full event body, including the stacktrace. \nSet to true to enable.",
  29. "schema": {
  30. "type": "boolean"
  31. }
  32. }
  33. ],
  34. "responses": {
  35. "200": {
  36. "description": "Success",
  37. "content": {
  38. "application/json": {
  39. "schema": {
  40. "type": "array",
  41. "items": {
  42. "$ref": "../../components/schemas/event.json#/Event"
  43. }
  44. },
  45. "example": [
  46. {
  47. "eventID": "9fac2ceed9344f2bbfdd1fdacb0ed9b1",
  48. "tags": [
  49. {
  50. "key": "browser",
  51. "value": "Chrome 60.0"
  52. },
  53. {
  54. "key": "device",
  55. "value": "Other"
  56. },
  57. {
  58. "key": "environment",
  59. "value": "production"
  60. },
  61. {
  62. "value": "fatal",
  63. "key": "level"
  64. },
  65. {
  66. "key": "os",
  67. "value": "Mac OS X 10.12.6"
  68. },
  69. {
  70. "value": "CPython 2.7.16",
  71. "key": "runtime"
  72. },
  73. {
  74. "key": "release",
  75. "value": "17642328ead24b51867165985996d04b29310337"
  76. },
  77. {
  78. "key": "server_name",
  79. "value": "web1.example.com"
  80. }
  81. ],
  82. "dateCreated": "2020-09-11T17:46:36Z",
  83. "user": null,
  84. "message": "",
  85. "title": "This is an example Python exception",
  86. "id": "dfb1a2d057194e76a4186cc8a5271553",
  87. "platform": "python",
  88. "event.type": "error",
  89. "groupID": "1889724436"
  90. }
  91. ]
  92. }
  93. }
  94. },
  95. "403": {
  96. "description": "Forbidden"
  97. }
  98. },
  99. "security": [
  100. {
  101. "auth_token": ["event:read"]
  102. }
  103. ]
  104. }
  105. }