feat(api-idorslug): Rename Path paramaters to organization_id_or_slug

pyproject.toml

@@ -120,14 +120,12 @@ ignore_missing_imports = true
 module = [
     "sentry.api.base",
     "sentry.api.bases.external_actor",
-    "sentry.api.bases.incident",
     "sentry.api.bases.integration",
     "sentry.api.bases.organization_events",
     "sentry.api.bases.organization_request_change",
     "sentry.api.bases.organizationmember",
     "sentry.api.bases.project",
     "sentry.api.bases.project_request_change",
-    "sentry.api.bases.rule",
     "sentry.api.bases.sentryapps",
     "sentry.api.bases.team",
     "sentry.api.endpoints.accept_organization_invite",
@@ -152,11 +150,8 @@ module = [
     "sentry.api.endpoints.integrations.sentry_apps.requests",
     "sentry.api.endpoints.integrations.sentry_apps.stats.details",
     "sentry.api.endpoints.internal.mail",
-    "sentry.api.endpoints.notifications.notification_actions_details",
     "sentry.api.endpoints.organization_code_mapping_codeowners",
-    "sentry.api.endpoints.organization_code_mapping_details",
     "sentry.api.endpoints.organization_code_mappings",
-    "sentry.api.endpoints.organization_dashboard_details",
     "sentry.api.endpoints.organization_details",
     "sentry.api.endpoints.organization_events",
     "sentry.api.endpoints.organization_events_facets",

src/sentry/api/bases/group.py

@@ -40,7 +40,9 @@ class GroupEndpoint(Endpoint):
     owner = ApiOwner.ISSUES
     permission_classes = (GroupPermission,)
 
-    def convert_args(self, request: Request, issue_id, organization_slug=None, *args, **kwargs):
+    def convert_args(
+        self, request: Request, issue_id, organization_id_or_slug=None, *args, **kwargs
+    ):
         # TODO(tkaemming): Ideally, this would return a 302 response, rather
         # than just returning the data that is bound to the new group. (It
         # technically shouldn't be a 301, since the response could change again
@@ -51,17 +53,17 @@ def convert_args(self, request: Request, issue_id, organization_slug=None, *args
         # string replacement, or making the endpoint aware of the URL pattern
         # that caused it to be dispatched, and reversing it with the correct
         # `issue_id` keyword argument.
-        if organization_slug:
+        if organization_id_or_slug:
             try:
                 if (
                     id_or_slug_path_params_enabled(
-                        self.convert_args.__qualname__, str(organization_slug)
+                        self.convert_args.__qualname__, str(organization_id_or_slug)
                     )
-                    and str(organization_slug).isdecimal()
+                    and str(organization_id_or_slug).isdecimal()
                 ):
-                    organization = Organization.objects.get_from_cache(id=organization_slug)
+                    organization = Organization.objects.get_from_cache(id=organization_id_or_slug)
                 else:
-                    organization = Organization.objects.get_from_cache(slug=organization_slug)
+                    organization = Organization.objects.get_from_cache(slug=organization_id_or_slug)
             except Organization.DoesNotExist:
                 raise ResourceDoesNotExist
 

src/sentry/api/bases/organization.py

@@ -242,30 +242,42 @@ class ControlSiloOrganizationEndpoint(Endpoint):
     def convert_args(
         self,
         request: Request,
-        organization_slug: str | int | None = None,
         *args: Any,
         **kwargs: Any,
     ) -> tuple[tuple[Any, ...], dict[str, Any]]:
+        organization_id_or_slug: int | str | None = None
+        if args and args[0] is not None:
+            organization_id_or_slug = args[0]
+            # Required so it behaves like the original convert_args, where organization_id_or_slug was another parameter
+            # TODO: Remove this once we remove the old `organization_slug` parameter from getsentry
+            args = args[1:]
+        else:
+            organization_id_or_slug = kwargs.pop("organization_id_or_slug", None) or kwargs.pop(
+                "organization_slug", None
+            )
+
         if not subdomain_is_region(request):
             subdomain = getattr(request, "subdomain", None)
-            if subdomain is not None and subdomain != organization_slug:
+            if subdomain is not None and subdomain != organization_id_or_slug:
                 raise ResourceDoesNotExist
 
-        if not organization_slug:
+        if not organization_id_or_slug:
             raise ResourceDoesNotExist
 
         if (
-            id_or_slug_path_params_enabled(self.convert_args.__qualname__, str(organization_slug))
-            and str(organization_slug).isdecimal()
+            id_or_slug_path_params_enabled(
+                self.convert_args.__qualname__, str(organization_id_or_slug)
+            )
+            and str(organization_id_or_slug).isdecimal()
         ):
             # It is ok that `get_organization_by_id` doesn't check for visibility as we
             # don't check the visibility in `get_organization_by_slug` either (only_active=False).
             organization_context = organization_service.get_organization_by_id(
-                id=int(organization_slug), user_id=request.user.id
+                id=int(organization_id_or_slug), user_id=request.user.id
             )
         else:
             organization_context = organization_service.get_organization_by_slug(
-                slug=str(organization_slug), only_visible=False, user_id=request.user.id
+                slug=str(organization_id_or_slug), only_visible=False, user_id=request.user.id
             )
         if organization_context is None:
             raise ResourceDoesNotExist
@@ -536,32 +548,42 @@ def get_filter_params(
     def convert_args(
         self,
         request: Request,
-        organization_slug: str | int | None = None,
         *args: Any,
         **kwargs: Any,
     ) -> tuple[tuple[Any, ...], dict[str, Any]]:
         """
-        We temporarily allow the organization_slug to be an integer as it actually can be both slug or id
+        We temporarily allow the organization_id_or_slug to be an integer as it actually can be both slug or id
         Eventually, we will rename this method to organization_id_or_slug
         """
+        organization_id_or_slug: int | str | None = None
+        if args and args[0] is not None:
+            organization_id_or_slug = args[0]
+            # Required so it behaves like the original convert_args, where organization_id_or_slug was another parameter
+            # TODO: Remove this once we remove the old `organization_slug` parameter from getsentry
+            args = args[1:]
+        else:
+            organization_id_or_slug = kwargs.pop("organization_id_or_slug", None) or kwargs.pop(
+                "organization_slug", None
+            )
+
         if not subdomain_is_region(request):
             subdomain = getattr(request, "subdomain", None)
-            if subdomain is not None and subdomain != organization_slug:
+            if subdomain is not None and subdomain != organization_id_or_slug:
                 raise ResourceDoesNotExist
 
-        if not organization_slug:
+        if not organization_id_or_slug:
             raise ResourceDoesNotExist
 
         try:
             if (
                 id_or_slug_path_params_enabled(
-                    self.convert_args.__qualname__, str(organization_slug)
+                    self.convert_args.__qualname__, str(organization_id_or_slug)
                 )
-                and str(organization_slug).isdecimal()
+                and str(organization_id_or_slug).isdecimal()
             ):
-                organization = Organization.objects.get_from_cache(id=organization_slug)
+                organization = Organization.objects.get_from_cache(id=organization_id_or_slug)
             else:
-                organization = Organization.objects.get_from_cache(slug=organization_slug)
+                organization = Organization.objects.get_from_cache(slug=organization_id_or_slug)
         except Organization.DoesNotExist:
             raise ResourceDoesNotExist
 

src/sentry/api/bases/organization_integrations.py

@@ -75,12 +75,12 @@ class RegionOrganizationIntegrationBaseEndpoint(RegionIntegrationEndpoint):
     def convert_args(
         self,
         request: Request,
-        organization_slug: str | int | None = None,
+        organization_id_or_slug: int | str | None = None,
         integration_id: str | None = None,
         *args: Any,
         **kwargs: Any,
     ) -> tuple[tuple[Any, ...], dict[str, Any]]:
-        args, kwargs = super().convert_args(request, organization_slug, *args, **kwargs)
+        args, kwargs = super().convert_args(request, organization_id_or_slug, *args, **kwargs)
 
         kwargs["integration_id"] = self.validate_integration_id(integration_id or "")
         return args, kwargs

src/sentry/api/bases/organizationmember.py

@@ -53,12 +53,12 @@ class OrganizationMemberEndpoint(OrganizationEndpoint):
     def convert_args(
         self,
         request: Request,
-        organization_slug: int | str | None = None,
+        organization_id_or_slug: str | int | None = None,
         member_id: str = "me",
         *args: Any,
         **kwargs: Any,
     ) -> tuple[tuple[Any, ...], dict[str, Any]]:
-        args, kwargs = super().convert_args(request, organization_slug, *args, **kwargs)
+        args, kwargs = super().convert_args(request, organization_id_or_slug, *args, **kwargs)
 
         serializer = MemberSerializer(data={"id": member_id})
         if serializer.is_valid():

src/sentry/api/bases/project.py

@@ -111,10 +111,19 @@ class ProjectEndpoint(Endpoint):
     def convert_args(
         self,
         request: Request,
-        organization_slug: str | int,
         *args,
         **kwargs,
     ):
+        if args and args[0] is not None:
+            organization_id_or_slug: int | str = args[0]
+            # Required so it behaves like the original convert_args, where organization_id_or_slug was another parameter
+            # TODO: Remove this once we remove the old `organization_slug` parameter from getsentry
+            args = args[1:]
+        else:
+            organization_id_or_slug = kwargs.pop("organization_id_or_slug", None) or kwargs.pop(
+                "organization_slug"
+            )
+
         if args and args[0] is not None:
             project_id_or_slug: int | str = args[0]
             # Required so it behaves like the original convert_args, where project_id_or_slug was another parameter
@@ -125,11 +134,11 @@ def convert_args(
             )
         try:
             if id_or_slug_path_params_enabled(
-                self.convert_args.__qualname__, str(organization_slug)
+                self.convert_args.__qualname__, str(organization_id_or_slug)
             ):
                 project = (
                     Project.objects.filter(
-                        organization__slug__id_or_slug=organization_slug,
+                        organization__slug__id_or_slug=organization_id_or_slug,
                         slug__id_or_slug=project_id_or_slug,
                     )
                     .select_related("organization")
@@ -139,7 +148,7 @@ def convert_args(
             else:
                 project = (
                     Project.objects.filter(
-                        organization__slug=organization_slug, slug=project_id_or_slug
+                        organization__slug=organization_id_or_slug, slug=project_id_or_slug
                     )
                     .select_related("organization")
                     .prefetch_related("teams")
@@ -151,24 +160,24 @@ def convert_args(
                 # This will only happen if the passed in project_id_or_slug is a slug and not an id
                 redirect = ProjectRedirect.objects.select_related("project")
                 if id_or_slug_path_params_enabled(
-                    self.convert_args.__qualname__, str(organization_slug)
+                    self.convert_args.__qualname__, str(organization_id_or_slug)
                 ):
                     redirect = redirect.get(
-                        organization__slug__id_or_slug=organization_slug,
+                        organization__slug__id_or_slug=organization_id_or_slug,
                         redirect_slug=project_id_or_slug,
                     )
                 else:
                     redirect = redirect.get(
-                        organization__slug=organization_slug, redirect_slug=project_id_or_slug
+                        organization__slug=organization_id_or_slug, redirect_slug=project_id_or_slug
                     )
                 # Without object permissions don't reveal the rename
                 self.check_object_permissions(request, redirect.project)
 
                 # get full path so that we keep query strings
                 requested_url = request.get_full_path()
                 new_url = requested_url.replace(
-                    f"projects/{organization_slug}/{project_id_or_slug}/",
-                    f"projects/{organization_slug}/{redirect.project.slug}/",
+                    f"projects/{organization_id_or_slug}/{project_id_or_slug}/",
+                    f"projects/{organization_id_or_slug}/{redirect.project.slug}/",
                 )
 
                 # Resource was moved/renamed if the requested url is different than the new url

src/sentry/api/bases/sentryapps.py

@@ -325,22 +325,24 @@ def has_object_permission(self, request: Request, view, organization):
 class SentryAppInstallationsBaseEndpoint(IntegrationPlatformEndpoint):
     permission_classes = (SentryAppInstallationsPermission,)
 
-    def convert_args(self, request: Request, organization_slug, *args, **kwargs):
+    def convert_args(self, request: Request, organization_id_or_slug, *args, **kwargs):
         extra_args = {}
         # We need to pass user_id if the user is not a superuser
         if not is_active_superuser(request):
             extra_args["user_id"] = request.user.id
 
         if (
-            id_or_slug_path_params_enabled(self.convert_args.__qualname__, str(organization_slug))
-            and str(organization_slug).isdecimal()
+            id_or_slug_path_params_enabled(
+                self.convert_args.__qualname__, str(organization_id_or_slug)
+            )
+            and str(organization_id_or_slug).isdecimal()
         ):
             organization = organization_service.get_org_by_id(
-                id=int(organization_slug), **extra_args
+                id=int(organization_id_or_slug), **extra_args
             )
         else:
             organization = organization_service.get_org_by_slug(
-                slug=organization_slug, **extra_args
+                slug=organization_id_or_slug, **extra_args
             )
 
         if organization is None:

src/sentry/api/endpoints/accept_organization_invite.py

@@ -85,7 +85,7 @@ def get_invite_state(
         if (
             id_or_slug_path_params_enabled(
                 convert_args_class=AcceptOrganizationInvite,
-                organization_slug=str(organization_id_or_slug),
+                organization_id_or_slug=str(organization_id_or_slug),
             )
             and str(organization_id_or_slug).isdecimal()
         ):
@@ -127,12 +127,12 @@ def get(
         request: Request,
         member_id: int,
         token: str,
-        organization_slug: int | str | None = None,
+        organization_id_or_slug: int | str | None = None,
     ) -> Response:
 
         invite_context = get_invite_state(
             member_id=int(member_id),
-            organization_id_or_slug=organization_slug,
+            organization_id_or_slug=organization_id_or_slug,
             user_id=request.user.id,
             request=request,
         )
@@ -222,11 +222,15 @@ def get(
         return response
 
     def post(
-        self, request: Request, member_id: int, token: str, organization_slug: str | None = None
+        self,
+        request: Request,
+        member_id: int,
+        token: str,
+        organization_id_or_slug: int | str | None = None,
     ) -> Response:
         invite_context = get_invite_state(
             member_id=int(member_id),
-            organization_id_or_slug=organization_slug,
+            organization_id_or_slug=organization_id_or_slug,
             user_id=request.user.id,
             request=request,
         )

src/sentry/api/endpoints/artifact_bundles.py

@@ -67,7 +67,7 @@ def get(self, request: Request, project) -> Response:
 
         Retrieve a list of artifact bundles for a given project.
 
-        :pparam string organization_slug: the slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           artifact bundle belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to list the
                                      artifact bundles of.
@@ -121,7 +121,7 @@ def delete(self, request: Request, project) -> Response:
 
         Delete all artifacts inside given archive.
 
-        :pparam string organization_slug: the slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                             archive belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to delete the
                                         archive of.

src/sentry/api/endpoints/artifact_lookup.py

@@ -104,7 +104,7 @@ def get(self, request: Request, project: Project) -> Response:
 
         Retrieve a list of individual artifacts or artifact bundles for a given project.
 
-        :pparam string organization_slug: the slug of the organization to query.
+        :pparam string organization_id_or_slug: the id or slug of the organization to query.
         :pparam string project_id_or_slug: the id or slug of the project to query.
         :qparam string debug_id: if set, will query and return the artifact
                                  bundle that matches the given `debug_id`.

src/sentry/api/endpoints/broadcast_index.py

@@ -50,9 +50,19 @@ def _secondary_filtering(self, request: Request, organization_slug, queryset):
         # used in the SAAS product
         return list(queryset)
 
-    def convert_args(self, request: Request, organization_slug=None, *args, **kwargs):
-        if organization_slug:
-            args, kwargs = super().convert_args(request, organization_slug)
+    def convert_args(self, request: Request, *args, **kwargs):
+        organization_id_or_slug: int | str | None = None
+        if args and args[0] is not None:
+            organization_id_or_slug = args[0]
+            # Required so it behaves like the original convert_args, where organization_id_or_slug was another parameter
+            # TODO: Remove this once we remove the old `organization_slug` parameter from getsentry
+            args = args[1:]
+        else:
+            organization_id_or_slug = kwargs.pop("organization_id_or_slug", None) or kwargs.pop(
+                "organization_slug", None
+            )
+        if organization_id_or_slug:
+            args, kwargs = super().convert_args(request, organization_id_or_slug)
 
         return (args, kwargs)