sentry-app-external-issues.json 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. {
  2. "post": {
  3. "tags": ["Integration"],
  4. "description": "Create or update an external issue from an integration platform integration.",
  5. "operationId": "Create or update an External Issue",
  6. "parameters": [
  7. {
  8. "name": "uuid",
  9. "in": "path",
  10. "description": "The uuid of the integration platform integration.",
  11. "required": true,
  12. "schema": {
  13. "type": "string"
  14. }
  15. }
  16. ],
  17. "requestBody": {
  18. "content": {
  19. "application/json": {
  20. "schema": {
  21. "required": ["issueId", "webUrl", "project", "identifier"],
  22. "type": "object",
  23. "properties": {
  24. "issueId": {
  25. "type": "integer",
  26. "description": "The ID of the Sentry issue to link the external issue to."
  27. },
  28. "webUrl": {
  29. "type": "string",
  30. "description": "The URL of the external service to link the issue to."
  31. },
  32. "project": {
  33. "type": "string",
  34. "description": "The external service's project."
  35. },
  36. "identifier": {
  37. "type": "string",
  38. "description": "A unique identifier of the external issue."
  39. }
  40. }
  41. },
  42. "example": {
  43. "issueId": 1,
  44. "webUrl": "https://somerandom.io/project/issue-id",
  45. "project": "ExternalProj",
  46. "identifier": "issue-1"
  47. }
  48. }
  49. },
  50. "required": true
  51. },
  52. "responses": {
  53. "200": {
  54. "description": "Success",
  55. "content": {
  56. "application/json": {
  57. "schema": {
  58. "type": "object",
  59. "required": [
  60. "id",
  61. "issueId",
  62. "serviceType",
  63. "displayName",
  64. "webUrl"
  65. ],
  66. "properties": {
  67. "id": {
  68. "type": "string"
  69. },
  70. "issueId": {
  71. "type": "string"
  72. },
  73. "serviceType": {
  74. "type": "string"
  75. },
  76. "displayName": {
  77. "type": "string"
  78. },
  79. "webUrl": {
  80. "type": "string"
  81. }
  82. }
  83. },
  84. "example": {
  85. "id": "1",
  86. "issueId": "1",
  87. "serviceType": "testing",
  88. "displayName": "ExternalProj#issue-1",
  89. "webUrl": "https://somerandom.io/project/issue-id"
  90. }
  91. }
  92. }
  93. },
  94. "403": {
  95. "description": "Forbidden"
  96. },
  97. "404": {
  98. "description": "Not Found"
  99. }
  100. },
  101. "security": [
  102. {
  103. "auth_token": ["event:write"]
  104. }
  105. ]
  106. }
  107. }