Skip to content

Commit

Permalink
fix(docs) Add notes about region domains to symbol endpoints (#82158)
Browse files Browse the repository at this point in the history
The file upload endpoints have special cased behavior for backwards
compatibility reasons that result in slug.sentry.io being pinned to the
US region. This can create confusing scenarios for customers in other
regions.

Refs #81232
  • Loading branch information
markstory authored Dec 16, 2024
1 parent 646c7ae commit d37b36e
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion api-docs/paths/projects/dsyms.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
},
"post": {
"tags": ["Projects"],
"description": "Upload a new debug information file for the given release.\n\nUnlike other API requests, files must be uploaded using the\ntraditional multipart/form-data content-type.\n\nThe file uploaded is a zip archive of an Apple .dSYM folder which\ncontains the individual debug images. Uploading through this endpoint\nwill create different files for the contained images.",
"description": "Upload a new debug information file for the given release.\n\nUnlike other API requests, files must be uploaded using the\ntraditional multipart/form-data content-type.\n\nRequests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`.\n\nThe file uploaded is a zip archive of an Apple .dSYM folder which\ncontains the individual debug images. Uploading through this endpoint\nwill create different files for the contained images.",
"operationId": "Upload a New File",
"parameters": [
{
Expand Down
2 changes: 1 addition & 1 deletion api-docs/paths/releases/project-release-files.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
},
"post": {
"tags": ["Releases"],
"description": "Upload a new project release file.",
"description": "Upload a new file for the given release.\n\nUnlike other API requests, files must be uploaded using the traditional multipart/form-data content-type.\n\nRequests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`\n\nThe optional 'name' attribute should reflect the absolute path that this file will be referenced as. For example, in the case of JavaScript you might specify the full web URI.",
"operationId": "Upload a New Project Release File",
"parameters": [
{
Expand Down
2 changes: 1 addition & 1 deletion api-docs/paths/releases/release-files.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
},
"post": {
"tags": ["Releases"],
"description": "Upload a new organization release file.",
"description": "Upload a new file for the given release.\n\nUnlike other API requests, files must be uploaded using the traditional multipart/form-data content-type.\n\nRequests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`.\n\nThe optional 'name' attribute should reflect the absolute path that this file will be referenced as. For example, in the case of JavaScript you might specify the full web URI.",
"operationId": "Upload a New Organization Release File",
"parameters": [
{
Expand Down
4 changes: 4 additions & 0 deletions src/sentry/api/endpoints/chunk.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ def post(self, request: Request, organization) -> Response:
"""
Upload chunks and store them as FileBlobs
`````````````````````````````````````````
Requests to this endpoint should use the region-specific domain
eg. `us.sentry.io` or `de.sentry.io`
:pparam file file: The filename should be sha1 hash of the content.
Also not you can add up to MAX_CHUNKS_PER_REQUEST files
in this request.
Expand Down
3 changes: 3 additions & 0 deletions src/sentry/api/endpoints/debug_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,9 @@ def post(self, request: Request, project: Project) -> Response:
Unlike other API requests, files must be uploaded using the
traditional multipart/form-data content-type.
Requests to this endpoint should use the region-specific domain
eg. `us.sentry.io` or `de.sentry.io`
The file uploaded is a zip archive of a Apple .dSYM folder which
contains the individual debug images. Uploading through this endpoint
will create different files for the contained images.
Expand Down
3 changes: 3 additions & 0 deletions src/sentry/api/endpoints/organization_release_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ def post(self, request: Request, organization, version) -> Response:
Unlike other API requests, files must be uploaded using the
traditional multipart/form-data content-type.
Requests to this endpoint should use the region-specific domain
eg. `us.sentry.io` or `de.sentry.io`
The optional 'name' attribute should reflect the absolute path
that this file will be referenced as. For example, in the case of
JavaScript you might specify the full web URI.
Expand Down
3 changes: 3 additions & 0 deletions src/sentry/api/endpoints/project_release_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,9 @@ def post(self, request: Request, project, version) -> Response:
Unlike other API requests, files must be uploaded using the
traditional multipart/form-data content-type.
Requests to this endpoint should use the region-specific domain
eg. `us.sentry.io` or `de.sentry.io`
The optional 'name' attribute should reflect the absolute path
that this file will be referenced as. For example, in the case of
JavaScript you might specify the full web URI.
Expand Down

0 comments on commit d37b36e

Please sign in to comment.