chore(api-idorslug): Updating More Comments to Reflect Support for organization_id_or_slug (#70569)

Some more comment changes en-masse. Should be the last of them.

Author: iamrajjoshi

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 id or 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 id or 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 id or 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/codeowners/details.py

@@ -58,7 +58,7 @@ def put(self, request: Request, project: Project, codeowners: ProjectCodeOwners)
         Update a CodeOwners
         `````````````
 
-        :pparam string organization_slug: the id or slug of the organization.
+        :pparam string organization_id_or_slug: the id or slug of the organization.
         :pparam string project_id_or_slug: the id or slug of the project to get.
         :pparam string codeowners_id: id of codeowners object
         :param string raw: the raw CODEOWNERS text

src/sentry/api/endpoints/codeowners/external_actor/user_details.py

@@ -48,7 +48,7 @@ def put(
         Update an External User
         `````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           user belongs to.
         :pparam int user_id: the User id.
         :pparam string external_user_id: id of external_user object

src/sentry/api/endpoints/codeowners/external_actor/user_index.py

@@ -27,7 +27,7 @@ def post(self, request: Request, organization: Organization) -> Response:
         Create an External User
         `````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           user belongs to.
         :param required string provider: enum("github", "gitlab", "slack")
         :param required string external_name: the associated username for this provider.

src/sentry/api/endpoints/codeowners/index.py

@@ -88,7 +88,7 @@ def post(self, request: Request, project: Project) -> Response:
         Upload a CODEOWNERS for project
         `````````````
 
-        :pparam string organization_slug: the id or slug of the organization.
+        :pparam string organization_id_or_slug: the id or slug of the organization.
         :pparam string project_id_or_slug: the id or slug of the project to get.
         :param string raw: the raw CODEOWNERS text
         :param string codeMappingId: id of the RepositoryProjectPathConfig object

src/sentry/api/endpoints/debug_files.py

@@ -157,7 +157,7 @@ def get(self, request: Request, project) -> Response:
 
         Retrieve a list of associated releases for a given Proguard File.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           file belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to list the
                                      DIFs of.
@@ -227,7 +227,7 @@ def get(self, request: Request, project) -> Response:
 
         Retrieve a list of debug information files for a given project.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           file belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to list the
                                      DIFs of.
@@ -312,7 +312,7 @@ def delete(self, request: Request, project: Project) -> Response:
 
         Delete a debug information file for a given project.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           file belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to delete the
                                      DIF.
@@ -346,7 +346,7 @@ def post(self, request: Request, project) -> Response:
         contains the individual debug images.  Uploading through this endpoint
         will create different files for the contained images.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           release belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to change the
                                      release of.
@@ -521,7 +521,7 @@ def get(self, request: Request, project) -> Response:
 
         Retrieve a list of source map archives (releases, later bundles) for a given project.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           source map archive belongs to.
         :pparam string project_id_or_slug: the id or slug of the project to list the
                                      source map archives of.
@@ -585,7 +585,7 @@ def delete(self, request: Request, project) -> Response:
 
         Delete all artifacts inside given archive.
 
-        :pparam string organization_slug: the id or 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/event_attachment_details.py

@@ -78,7 +78,7 @@ def get(self, request: Request, project, event_id, attachment_id) -> Response:
         Retrieve an Attachment
         ``````````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           issues belong to.
         :pparam string project_id_or_slug: the id or slug of the project the event
                                      belongs to.

src/sentry/api/endpoints/event_attachments.py

@@ -24,7 +24,7 @@ def get(self, request: Request, project, event_id) -> Response:
         Retrieve attachments for an event
         `````````````````````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           issues belong to.
         :pparam string project_id_or_slug: the id or slug of the project the event
                                      belongs to.

src/sentry/api/endpoints/event_reprocessable.py

@@ -48,7 +48,7 @@ def get(self, request: Request, project, event_id) -> Response:
         * `attachment.not_found`: A required attachment, such as the original
           minidump, is missing.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           issues belong to.
         :pparam string project_id_or_slug: the id or slug of the project the event
                                      belongs to.

src/sentry/api/endpoints/filechange.py

@@ -29,7 +29,7 @@ def get(self, request: Request, organization, version) -> Response:
 
         Retrieve a list of files that were changed in a given release's commits.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           release belongs to.
         :pparam string version: the version identifier of the release.
 

src/sentry/api/endpoints/group_details.py

@@ -136,7 +136,7 @@ def get(self, request: Request, group) -> Response:
         the issue (title, last seen, first seen), some overall numbers (number
         of comments, user reports) as well as the summarized event data.
 
-        :pparam string organization_slug: The slug of the organization.
+        :pparam string organization_id_or_slug: The slug of the organization.
         :pparam string issue_id: the ID of the issue to retrieve.
         :auth: required
         """

src/sentry/api/endpoints/group_tombstone_details.py

@@ -25,7 +25,7 @@ def delete(self, request: Request, project, tombstone_id) -> Response:
         Undiscards a group such that new events in that group will be captured.
         This does not restore any previous data.
 
-        :pparam string organization_slug: the id or slug of the organization.
+        :pparam string organization_id_or_slug: the id or slug of the organization.
         :pparam string project_id_or_slug: the id or slug of the project to which this tombstone belongs.
         :pparam string tombstone_id: the ID of the tombstone to remove.
         :auth: required

src/sentry/api/endpoints/organization_api_key_details.py

@@ -36,7 +36,7 @@ def get(self, request: Request, organization_context, organization, api_key_id)
         Retrieves API Key details
         `````````````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team belongs to.
         :pparam string api_key_id: the ID of the api key to delete
         :auth: required
@@ -53,7 +53,7 @@ def put(self, request: Request, organization_context, organization, api_key_id)
         Update an API Key
         `````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team belongs to.
         :pparam string api_key_id: the ID of the api key to delete
         :param string label: the new label for the api key
@@ -89,7 +89,7 @@ def delete(self, request: Request, organization_context, organization, api_key_i
         Deletes an API Key
         ``````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team belongs to.
         :pparam string api_key_id: the ID of the api key to delete
         :auth: required

src/sentry/api/endpoints/organization_api_key_index.py

@@ -30,7 +30,7 @@ def get(self, request: Request, organization_context, organization) -> Response:
         List an Organization's API Keys
         ```````````````````````````````````
 
-        :pparam string organization_slug: the organization short name
+        :pparam string organization_id_or_slug: the id or slug of the organization
         :auth: required
         """
         queryset = sorted(
@@ -44,7 +44,7 @@ def post(self, request: Request, organization_context, organization) -> Response
         Create an Organization API Key
         ```````````````````````````````````
 
-        :pparam string organization_slug: the organization short name
+        :pparam string organization_id_or_slug: the id or slug of the organization
         :auth: required
         """
         key = ApiKey.objects.create(organization_id=organization.id, scope_list=DEFAULT_SCOPES)

src/sentry/api/endpoints/organization_auth_provider_details.py

@@ -26,7 +26,7 @@ def get(self, request: Request, organization: Organization) -> Response:
         currently installed auth_provider
         ``````````````````````````````````````````````````````
 
-        :pparam string organization_slug: the organization short name
+        :pparam string organization_id_or_slug: the id or slug of the organization
         :auth: required
         """
         auth_provider = auth_service.get_auth_provider(organization_id=organization.id)

src/sentry/api/endpoints/organization_auth_providers.py

@@ -22,7 +22,7 @@ def get(self, request: Request, organization) -> Response:
         List available auth providers that are available to use for an Organization
         ```````````````````````````````````````````````````````````````````````````
 
-        :pparam string organization_slug: the organization short name
+        :pparam string organization_id_or_slug: the id or slug of the organization
         :auth: required
         """
         provider_list = []

src/sentry/api/endpoints/organization_code_mapping_details.py

@@ -50,7 +50,7 @@ def put(self, request: Request, config_id, organization, config) -> Response:
         Update a repository project path config
         ``````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team should be created for.
         :param int repository_id:
         :param int project_id:

src/sentry/api/endpoints/organization_code_mappings.py

@@ -141,7 +141,7 @@ def get(self, request: Request, organization) -> Response:
         """
         Get the list of repository project path configs
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team should be created for.
         :qparam int integrationId: the optional integration id.
         :qparam int project: Optional. Pass "-1" to filter to 'all projects user has access to'. Omit to filter for 'all projects user is a member of'.
@@ -175,7 +175,7 @@ def post(self, request: Request, organization) -> Response:
         Create a new repository project path config
         ``````````````````
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team should be created for.
         :param int repositoryId:
         :param int projectId:

src/sentry/api/endpoints/organization_dashboards.py

@@ -49,7 +49,7 @@ def get(self, request: Request, organization) -> Response:
         If on the first page, this endpoint will also include any pre-built dashboards
         that haven't been replaced or removed.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           dashboards belongs to.
         :qparam string query: the title of the dashboard being searched for.
         :auth: required
@@ -142,7 +142,7 @@ def post(self, request: Request, organization, retry=0) -> Response:
         ``````````````````````````````````````````
 
         Create a new dashboard for the given Organization
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           dashboards belongs to.
         """
         if not features.has("organizations:dashboards-edit", organization, actor=request.user):

src/sentry/api/endpoints/organization_details.py

@@ -555,7 +555,7 @@ def get(self, request: Request, organization) -> Response:
         Return details on an individual organization including various details
         such as membership access, features, and teams.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team should be created for.
         :param string detailed: Specify '0' to retrieve details without projects and teams.
         :auth: required
@@ -581,7 +581,7 @@ def put(self, request: Request, organization) -> Response:
         Update various attributes and configurable settings for the given
         organization.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team should be created for.
         :param string name: an optional new name for the organization.
         :param string slug: an optional new slug for the organization.  Needs
@@ -714,7 +714,7 @@ def delete(self, request: Request, organization) -> Response:
         However once deletion has begun the state of an organization changes and
         will be hidden from most public views.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           team should be created for.
         :auth: required, user-context-needed
         """

src/sentry/api/endpoints/organization_eventid.py

@@ -35,7 +35,7 @@ def get(self, request: Request, organization, event_id) -> Response:
 
         This resolves an event ID to the project slug and internal issue ID and internal event ID.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           event ID should be looked up in.
         :param string event_id: the event ID to look up. validated by a
                                 regex in the URL.

src/sentry/api/endpoints/organization_issues_resolved_in_release.py

@@ -26,7 +26,7 @@ def get(self, request: Request, organization, version) -> Response:
 
         Retrieve a list of issues to be resolved in a given release.
 
-        :pparam string organization_slug: the id or slug of the organization the
+        :pparam string organization_id_or_slug: the id or slug of the organization the
                                           release belongs to.
         :pparam string version: the version identifier of the release.
         :auth: required

src/sentry/api/endpoints/organization_member/requests/invite/details.py

@@ -90,7 +90,7 @@ def put(
 
         Update and/or approve an invite request to an organization.
 
-        :pparam string organization_slug: the id or slug of the organization the member will belong to
+        :pparam string organization_id_or_slug: the id or slug of the organization the member will belong to
         :param string member_id: the member ID
         :param boolean approve: allows the member to be invited
         :param string role: the suggested role of the new member
@@ -171,7 +171,7 @@ def delete(
 
         Delete an invite request to an organization.
 
-        :pparam string organization_slug: the id or slug of the organization the member would belong to
+        :pparam string organization_id_or_slug: the id or slug of the organization the member would belong to
         :param string member_id: the member ID
 
         :auth: required

src/sentry/api/endpoints/organization_member/requests/invite/index.py

@@ -61,7 +61,7 @@ def post(self, request: Request, organization) -> Response:
 
         Creates an invite request given an email and suggested role / teams.
 
-        :pparam string organization_slug: the id or slug of the organization the member will belong to
+        :pparam string organization_id_or_slug: the id or slug of the organization the member will belong to
         :param string email: the email address to invite
         :param string role: the suggested role of the new member
         :param string orgRole: the suggested org-role of the new member