Skip to content

Commit b388bf8

Browse files
authored
chore(API docs): Update docs to reflect sentry changes (#824)
Make docs reflect getsentry/sentry#12297, and a few other small changes which never got pulled in.
1 parent c07f23f commit b388bf8

File tree

10 files changed

+13
-8
lines changed

10 files changed

+13
-8
lines changed

__tests__/__snapshots__/documentation.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,12 @@ Array [
121121
"api/releases/delete-organization-release-file-details/index.html",
122122
"api/releases/delete-project-release-file-details/index.html",
123123
"api/releases/get-commit-file-change/index.html",
124-
"api/releases/get-issues-resolved-in-release/index.html",
125124
"api/releases/get-organization-release-commits/index.html",
126125
"api/releases/get-organization-release-details/index.html",
127126
"api/releases/get-organization-release-file-details/index.html",
128127
"api/releases/get-organization-release-files/index.html",
129128
"api/releases/get-organization-releases/index.html",
129+
"api/releases/get-project-issues-resolved-in-release/index.html",
130130
"api/releases/get-project-release-commits/index.html",
131131
"api/releases/get-project-release-file-details/index.html",
132132
"api/releases/get-project-release-files/index.html",

src/collections/_documentation/api/events/get-project-event-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"type": "string"
2222
},
2323
{
24-
"description": "the hexadecimal ID of the event to retrieve (as reported by the raven client).",
24+
"description": "the id of the event to retrieve (either the numeric primary-key or the hexadecimal id as reported by the raven client)",
2525
"name": "event_id",
2626
"type": "string"
2727
}

src/collections/_documentation/api/events/put-project-group-index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
"name": "status",
1515
"type": "string"
1616
},
17+
{
18+
"description": "additional details about the resolution. Valid values are `\"inRelease\"`, `\"inNextRelease\"`, `\"inCommit\"`, `\"ignoreDuration\"`, `\"ignoreCount\"`, `\"ignoreWindow\"`, `\"ignoreUserCount\"`, and `\"ignoreUserWindow\"`.",
19+
"name": "statusDetails",
20+
"type": "map"
21+
},
1722
{
1823
"description": "the number of minutes to ignore this issue.",
1924
"name": "ignoreDuration",

src/collections/_documentation/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ A full list of the currently supported API endpoints:
4949
- [Create a New Release]({%- link _documentation/api/releases/post-organization-releases.md -%})
5050
- [Update a Release]({%- link _documentation/api/releases/put-organization-release-details.md -%})
5151
- [Delete a Release]({%- link _documentation/api/releases/delete-organization-release-details.md -%})
52-
- [List issues to be resolved in a particular release]({%- link _documentation/api/releases/get-issues-resolved-in-release.md -%})
52+
- [List issues to be resolved in a particular release]({%- link _documentation/api/releases/get-project-issues-resolved-in-release.md -%})
5353
- Deploys
5454
- [List a Release’s Deploys]({%- link _documentation/api/releases/get-release-deploys.md -%})
5555
- [Create a Deploy]({%- link _documentation/api/releases/post-release-deploys.md -%})

src/collections/_documentation/api/organizations/get-organization-stats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"type": "timestamp"
3434
},
3535
{
36-
"description": "an explicit resolution to search for (eg: `10s`). This should not be used unless you are familiar with Sentry's internals as it's restricted to pre-defined values.",
36+
"description": "an explicit resolution to search for (one of `10s`, `1h`, and `1d`)",
3737
"name": "resolution",
3838
"type": "string"
3939
}

src/collections/_documentation/api/projects/get-project-stats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"type": "timestamp"
3939
},
4040
{
41-
"description": "an explicit resolution to search for (eg: `10s`). This should not be used unless you are familiar with Sentry's internals as it's restricted to pre-defined values.",
41+
"description": "an explicit resolution to search for (one of `10s`, `1h`, and `1d`)",
4242
"name": "resolution",
4343
"type": "string"
4444
}

src/collections/_documentation/api/releases/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ title: Releases
2020
- [Create a Deploy]({%- link _documentation/api/releases/post-release-deploys.md -%})
2121
- [List an Organization Release's Commits]({%- link _documentation/api/releases/get-organization-release-commits.md -%})
2222
- [List a Project Release's Commits]({%- link _documentation/api/releases/get-project-release-commits.md -%})
23-
- [List issues to be resolved in a particular release]({%- link _documentation/api/releases/get-issues-resolved-in-release.md -%})
23+
- [List issues to be resolved in a particular release]({%- link _documentation/api/releases/get-project-issues-resolved-in-release.md -%})
2424
- [List a Project Release's Files]({%- link _documentation/api/releases/get-project-release-files.md -%})
2525
- [Upload a New Project Release File]({%- link _documentation/api/releases/post-project-release-files.md -%})
2626
- [Retrieve a Project Release's File]({%- link _documentation/api/releases/get-project-release-file-details.md -%})

src/collections/_documentation/api/releases/post-organization-releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"type": "array"
4141
},
4242
{
43-
"description": "an optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD sha). They can optionally include `previousCommit` (the sha of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data.",
43+
"description": "an optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD sha). They can optionally include `previousCommit` (the sha of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data. `commit` may contain a range in the form of `previousCommit..commit`",
4444
"name": "refs",
4545
"type": "array"
4646
}

src/collections/_documentation/api/teams/get-team-stats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"type": "timestamp"
3939
},
4040
{
41-
"description": "an explicit resolution to search for (eg: `10s`). This should not be used unless you are familiar with Sentry's internals as it's restricted to pre-defined values.",
41+
"description": "an explicit resolution to search for (one of `10s`, `1h`, and `1d`)",
4242
"name": "resolution",
4343
"type": "string"
4444
}

0 commit comments

Comments
 (0)