ref(apidocs): dont make devs set private = True for apidocs (#45660)

- There was previously a push to make new API endpoints public, and we'd
fail api docs tests if private wasn't set to true, or the endpoints were
documented
- This ended up not being super useful as most new endpoints are private
/ still in development / only for the UI, so it never made sense to make
them public right away
- This also caused a bunch of brittleness as we maintained an exclusion
list for old endpoints.

This should improve default developer experience, remove some messiness
in imports, and not have any affect on when we make APIs public.

will update our devdocs in a follow up PR.

Author: JoshFerge

src/sentry/api/base.py

@@ -121,8 +121,6 @@ class Endpoint(APIView):
 
     cursor_name = "cursor"
 
-    # end user of endpoint must set private to true, or define public endpoints
-    private: Optional[bool] = None
     public: Optional[HTTP_METHODS_SET] = None
 
     rate_limits: RateLimitConfig = DEFAULT_RATE_LIMIT_CONFIG

src/sentry/api/endpoints/admin_project_configs.py

@@ -10,7 +10,6 @@
 
 @pending_silo_endpoint
 class AdminRelayProjectConfigsEndpoint(Endpoint):
-    private = True
     permission_classes = (SuperuserPermission,)
 
     def get(self, request: Request) -> Response:

src/sentry/api/endpoints/client_state.py

@@ -14,8 +14,6 @@
 
 @pending_silo_endpoint
 class ClientStateListEndpoint(OrganizationEndpoint):
-    private = True
-
     def __init__(self, **options) -> None:
         cluster_key = getattr(settings, "SENTRY_CLIENT_STATE_REDIS_CLUSTER", "default")
         self.client = redis.redis_clusters.get(cluster_key)
@@ -33,8 +31,6 @@ def get(self, request: Request, organization) -> Response:
 
 @pending_silo_endpoint
 class ClientStateEndpoint(OrganizationEndpoint):
-    private = True
-
     def __init__(self, **options) -> None:
         self.client = get_redis_client()
         super().__init__(**options)

src/sentry/api/endpoints/issue_occurrence.py

@@ -19,7 +19,6 @@
 @region_silo_endpoint
 class IssueOccurrenceEndpoint(Endpoint):
     permission_classes = (SuperuserPermission,)
-    private = True
 
     def post(self, request: Request) -> Response:
         """

src/sentry/api/endpoints/organization_events_spans_histogram.py

@@ -35,8 +35,6 @@ def validate_span(self, span: str) -> Span:
 
 @region_silo_endpoint
 class OrganizationEventsSpansHistogramEndpoint(OrganizationEventsV2EndpointBase):
-    private = True
-
     def has_feature(self, organization, request):
         return features.has(
             "organizations:performance-span-histogram-view", organization, actor=request.user

src/sentry/api/endpoints/organization_integration_issues.py

@@ -9,8 +9,6 @@
 
 @region_silo_endpoint
 class OrganizationIntegrationIssuesEndpoint(OrganizationIntegrationBaseEndpoint):
-    private = True
-
     def put(self, request: Request, organization, integration_id) -> Response:
         """
         Migrate plugin linked issues to integration linked issues

src/sentry/api/endpoints/organization_measurements_meta.py

@@ -12,8 +12,6 @@
 
 @region_silo_endpoint
 class OrganizationMeasurementsMeta(OrganizationEventsEndpointBase):  # type: ignore
-    private = True
-
     def get(self, request: Request, organization: Organization) -> Response:
         try:
             params = self.get_snuba_params(request, organization)

src/sentry/api/endpoints/organization_metrics_meta.py

@@ -19,8 +19,6 @@ class OrganizationMetricsCompatibility(OrganizationEventsEndpointBase):
     which are the projects which don't have null transactions and have at least 1 transaction with a valid name
     """
 
-    private = True
-
     def get(self, request: Request, organization) -> Response:
         data = {
             "incompatible_projects": [],
@@ -68,8 +66,6 @@ class OrganizationMetricsCompatibilitySums(OrganizationEventsEndpointBase):
     be
     """
 
-    private = True
-
     def get(self, request: Request, organization) -> Response:
         data = {
             "sum": {

src/sentry/api/endpoints/organization_onboarding_continuation_email.py

@@ -40,7 +40,7 @@ def get_request_builder_args(user: User, organization: Organization, platforms:
 
 @region_silo_endpoint
 class OrganizationOnboardingContinuationEmail(OrganizationEndpoint):
-    private = True
+
     # let anyone in the org use this endpoint
     permission_classes = ()
 

src/sentry/api/endpoints/organization_profiling_profiles.py

@@ -16,8 +16,6 @@
 
 
 class OrganizationProfilingBaseEndpoint(OrganizationEventsV2EndpointBase):  # type: ignore
-    private = True
-
     def get_profiling_params(self, request: Request, organization: Organization) -> Dict[str, Any]:
         try:
             params: Dict[str, Any] = parse_profile_filters(request.query_params.get("query", ""))