Skip to content

feat(docs) Add server metadata to files endpoints #82159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 16, 2024
Merged

feat(docs) Add server metadata to files endpoints #82159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9b085a
feat(docs) Add server metadata to files endpoints
markstory Dec 16, 2024
d858914
Update server list to contain the templated region domain
markstory Dec 16, 2024
5c5a323
Fix the other copy of openapi schema too
markstory Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions api-docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,14 @@
},
"servers": [
{
"url": "https://us.sentry.io/"
},
{
"url": "https://de.sentry.io/"
"url": "https://{region}.sentry.io",
"variables": {
"region": {
"default": "us",
"description": "The data-storage-location for an organization",
"enum": ["us", "de"]
}
}
}
],
"tags": [
Expand Down
3 changes: 3 additions & 0 deletions api-docs/paths/projects/dsyms.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@
{
"auth_token": ["project:write"]
}
],
"servers": [
{"url": "https://{region}.sentry.io"}
]
},
"delete": {
Expand Down
3 changes: 3 additions & 0 deletions api-docs/paths/releases/project-release-files.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@
{
"auth_token": ["project:releases"]
}
],
"servers": [
{"url": "https://{region}.sentry.io"}
]
}
}
3 changes: 3 additions & 0 deletions api-docs/paths/releases/release-files.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,9 @@
{
"auth_token": ["project:releases"]
}
],
"servers": [
{"url": "https://{region}.sentry.io"}
]
}
}
13 changes: 12 additions & 1 deletion src/sentry/conf/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1458,7 +1458,18 @@ def custom_parameter_sort(parameter: dict) -> tuple[str, int]:
"PARSER_WHITELIST": ["rest_framework.parsers.JSONParser"],
"POSTPROCESSING_HOOKS": ["sentry.apidocs.hooks.custom_postprocessing_hook"],
"PREPROCESSING_HOOKS": ["sentry.apidocs.hooks.custom_preprocessing_hook"],
"SERVERS": [{"url": "https://us.sentry.io"}, {"url": "https://de.sentry.io"}],
"SERVERS": [
{
"url": "https://{region}.sentry.io",
"variables": {
"region": {
"default": "us",
"description": "The data-storage-location for an organization",
"enum": ["us", "de"],
},
},
},
],
"SORT_OPERATION_PARAMETERS": custom_parameter_sort,
"TAGS": OPENAPI_TAGS,
"TITLE": "API Reference",
Expand Down
2 changes: 1 addition & 1 deletion tests/apidocs/endpoints/projects/test_dsyms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ def test_post(self):
data,
format="multipart",
)
request = RequestFactory().post(self.url, data)
request = RequestFactory().post(self.url, data, SERVER_NAME="de.sentry.io", secure=True)

self.validate_schema(request, response)
8 changes: 7 additions & 1 deletion tests/apidocs/endpoints/releases/test_organization_release_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ def test_post(self):
data,
format="multipart",
)
request = RequestFactory().post(self.url, data=data, content_type="multipart/form-data")
request = RequestFactory().post(
self.url,
data=data,
content_type="multipart/form-data",
SERVER_NAME="us.sentry.io",
secure=True,
)

self.validate_schema(request, response)
8 changes: 7 additions & 1 deletion tests/apidocs/endpoints/releases/test_project_release_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ def test_post(self):
data,
format="multipart",
)
request = RequestFactory().post(self.url, data=data, content_type="multipart/form-data")
request = RequestFactory().post(
self.url,
data=data,
content_type="multipart/form-data",
SERVER_NAME="us.sentry.io",
secure=True,
)

self.validate_schema(request, response)
Loading