feat(docs): adds docs for statusDetails (#76378)

This PR adds documentation for `statusDetails` when resolving a release with the API
getsentry · Aug 27, 2024 · e9626c4 · e9626c4
1 parent 57035b3
commit e9626c4
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/api-docs/paths/events/issue-details.json b/api-docs/paths/events/issue-details.json
@@ -214,6 +214,28 @@
                 "type": "string",
                 "description": "The new status for the issues. Valid values are `\"resolved\"`, `\"reprocessing\"`, `\"unresolved\"`, and `\"ignored\"`."
               },
+              "statusDetails": {
+                "type": "object",
+                "description": "Additional details about the status of the issue.",
+                "properties": {
+                  "inNextRelease": {
+                    "type": "boolean",
+                    "description": "Indicates if the issue is resolved in the next release based on the last seen release of that issue."
+                  },
+                  "inUpcomingRelease": {
+                    "type": "boolean",
+                    "description": "Indicates if the issue is resolved in an upcoming release."
+                  },
+                  "inRelease": {
+                    "type": "string",
+                    "description": "The version of the release in which the issue is resolved."
+                  },
+                  "inCommit": {
+                    "type": "string",
+                    "description": "The commit hash in which the issue is resolved."
+                  }
+                }
+              },
               "assignedTo": {
                 "type": "string",
                 "description": "The actor id (or username) of the user or team that should be assigned to this issue."