Skip to content

Commit 0800689

Browse files
authored
chore(api) Update API docs for region limitations (#71441)
The unprefixed /projects and /organizations endpoints are region bound. I've also tried to remove the `/projects` endpoint from the docs as we should be encouraging use of organization scoped endpoints.
1 parent a23af18 commit 0800689

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/sentry/api/endpoints/organization_index.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ class OrganizationIndexEndpoint(Endpoint):
8484
)
8585
def get(self, request: Request) -> Response:
8686
"""
87-
Return a list of organizations available to the authenticated session. This is particularly useful for requests with a user bound context. For API key-based requests this will only return the organization that belongs to the key.
87+
Return a list of organizations available to the authenticated session in a region.
88+
This is particularly useful for requests with a user bound context. For API key-based requests this will only return the organization that belongs to the key.
8889
"""
8990
owner_only = request.GET.get("owner") in ("1", "true")
9091

src/sentry/api/endpoints/project_index.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
@region_silo_endpoint
2222
class ProjectIndexEndpoint(Endpoint):
2323
publish_status = {
24-
"GET": ApiPublishStatus.UNKNOWN,
24+
"GET": ApiPublishStatus.PRIVATE,
2525
}
2626
permission_classes = (ProjectPermission,)
2727

@@ -31,7 +31,7 @@ def get(self, request: Request) -> Response:
3131
``````````````````
3232
3333
Return a list of projects available to the authenticated
34-
session.
34+
session in a region.
3535
3636
:auth: required
3737
"""

0 commit comments

Comments
 (0)