Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

chore(devex): guard paginators by their base class, not a name list (#127198)

Julian Bezba73f4f08224
diff --git a/.semgrep/rules/devex/no-hand-set-paginator-state.py b/.semgrep/rules/devex/no-hand-set-paginator-state.py
new file mode 100644
index 000000000000..103060da554a
--- /dev/null
+++ b/.semgrep/rules/devex/no-hand-set-paginator-state.py
@@ -0,0 +1,72 @@
+# Test cases for no-hand-set-paginator-state.
+# ruff: noqa
+from rest_framework.pagination import LimitOffsetPagination
+
+from posthog.api.pagination import BoundedLimitOffsetPagination
+
+
+def facade_list(self, request, page):
+ paginator = self.paginator
+ # ruleid: no-hand-set-paginator-state
+ paginator.count = page.count
+ # ruleid: no-hand-set-paginator-state
+ paginator.limit = paginator.get_limit(request)
+ # ruleid: no-hand-set-paginator-state
+ paginator.offset = paginator.get_offset(request)
+ # ruleid: no-hand-set-paginator-state
+ paginator.request = request
+ return paginator.get_paginated_response(page.results)
+
+
+def view_list(self, request, rows):
+ # ruleid: no-hand-set-paginator-state
+ self.paginator.page = rows
+ # ruleid: no-hand-set-paginator-state
+ self.paginator.has_next = False
+
+
+def schema_check(view):
+ pagination = view.pagination_class()
+ # ruleid: no-hand-set-paginator-state
+ pagination.has_previous = False
+ run_paginator = view.paginator
+ # ruleid: no-hand-set-paginator-state
+ run_paginator.ordering = ("-created_at",)
+
+
+class ReportListPagination(BoundedLimitOffsetPagination):
+ def paginate_queryset(self, queryset, request, view=None):
+ # ok: no-hand-set-paginator-state
+ self.limit = self.get_limit(request)
+ # ok: no-hand-set-paginator-state
+ self.request = request
+ return list(queryset[: self.limit])
+
+
+class BoundedListPagination(LimitOffsetPagination):
+ # ok: no-hand-set-paginator-state
+ default_limit = 100
+ # ok: no-hand-set-paginator-state
+ max_limit = 500
+
+
+def precounted_list(self, rows, total):
+ # ok: no-hand-set-paginator-state
+ self.paginator.set_count(total)
+ page = self.paginate_queryset(rows)
+ return self.get_paginated_response(page)
+
+
+class ExportRunner:
+ def __init__(self, request, limit):
+ # ok: no-hand-set-paginator-state
+ self.request = request
+ # ok: no-hand-set-paginator-state
+ self.limit = limit
+
+
+def summary(stats):
+ # ok: no-hand-set-paginator-state
+ stats.count = 0
+ # ok: no-hand-set-paginator-state
+ paginator_options = {"limit": 10}
diff --git a/.semgrep/rules/devex/no-hand-set-paginator-state.yaml b/.semgrep/rules/devex/no-hand-set-paginator-state.yaml
new file mode 100644
index 000000000000..4ea382577cae
--- /dev/null
+++ b/.semgrep/rules/devex/no-hand-set-paginator-state.yaml
@@ -0,0 +1,42 @@
+rules:
+ - id: no-hand-set-paginator-state
+ message: |
+ Do not set a paginator's state from outside the paginator. A paginator sets `limit`,
+ `offset`, `count`, `page` and `request` in its own `paginate_queryset`. Code that sets
+ them by hand skips the bounds, ordering and links that the shared bases add.
+
+ Use a base from posthog/api/pagination.py instead:
+ - a queryset list: return `self.get_paginated_response(...)` after `self.paginate_queryset(...)`
+ - a facade list: `pagination_class = FacadeLimitOffsetPagination` and `facade_page_response(self, fetch)`
+ - a cursor facade list: subclass `FacadeCursorPagination` and return `facade_cursor_page_response(self, fetch)`
+ - a precounted SQL page: `PrecountedLimitOffsetPagination.set_count(...)`
+
+ If the shared bases cannot express the list, add the behavior to posthog/api/pagination.py.
+ See "How do lists page?" in products/architecture.md.
+ severity: ERROR
+ languages: [python]
+ paths:
+ include:
+ - 'common/**/*.py'
+ - 'ee/**/*.py'
+ - 'posthog/**/*.py'
+ - 'products/**/*.py'
+ exclude:
+ - 'posthog/api/pagination.py'
+ - '**/test/**'
+ - '**/tests/**'
+ - '**/test_*.py'
+ patterns:
+ - pattern-either:
+ - pattern: $VIEW.paginator.$ATTR = $VALUE
+ - patterns:
+ - pattern: $PAGINATOR.$ATTR = $VALUE
+ - metavariable-regex:
+ metavariable: $PAGINATOR
+ regex: ^\w*(paginator|pagination)$
+ - metavariable-regex:
+ metavariable: $ATTR
+ regex: ^(count|limit|offset|request|page|page_size|has_next|has_previous|cursor|current_cursor|ordering|base_url|display_page_controls)$
+ metadata:
+ category: maintainability
+ confidence: HIGH
diff --git a/.semgrep/rules/devex/no-unbounded-drf-paginator.py b/.semgrep/rules/devex/no-unbounded-drf-paginator.py
new file mode 100644
index 000000000000..e232a822d57c
--- /dev/null
+++ b/.semgrep/rules/devex/no-unbounded-drf-paginator.py
@@ -0,0 +1,61 @@
+# Test cases for no-unbounded-drf-paginator.
+# ruff: noqa
+from rest_framework import pagination
+from rest_framework.pagination import CursorPagination, LimitOffsetPagination, PageNumberPagination
+
+from posthog.api.pagination import BoundedLimitOffsetPagination, BoundedPageNumberPagination, StableCursorPagination
+
+
+# ruleid: no-unbounded-drf-paginator
+class ChannelListPagination(LimitOffsetPagination):
+ default_limit = None
+
+
+# ruleid: no-unbounded-drf-paginator
+class ReportPagination(PageNumberPagination):
+ page_size = 100
+
+
+# ruleid: no-unbounded-drf-paginator
+class EventCursorPagination(CursorPagination):
+ ordering = "-created_at"
+
+
+# ruleid: no-unbounded-drf-paginator
+class QualifiedPagination(pagination.LimitOffsetPagination):
+ default_limit = 50
+
+
+# ruleid: no-unbounded-drf-paginator
+class MixinPagination(SomeMixin, pagination.PageNumberPagination):
+ page_size = 20
+
+
+class UncappedPagination(BoundedLimitOffsetPagination):
+ # ruleid: no-unbounded-drf-paginator
+ max_limit = None
+
+
+# ok: no-unbounded-drf-paginator
+class OptInPagination(BoundedLimitOffsetPagination):
+ default_limit = None
+
+
+# ok: no-unbounded-drf-paginator
+class NumberedPagination(BoundedPageNumberPagination):
+ page_size = 100
+
+
+# ok: no-unbounded-drf-paginator
+class ActivityCursorPagination(StableCursorPagination):
+ ordering = "-created_at"
+
+
+class LargerPagination(BoundedLimitOffsetPagination):
+ # ok: no-unbounded-drf-paginator
+ max_limit = 5000
+
+
+class ExportOptions:
+ # ok: no-unbounded-drf-paginator
+ max_limit = None
diff --git a/.semgrep/rules/devex/no-unbounded-drf-paginator.yaml b/.semgrep/rules/devex/no-unbounded-drf-paginator.yaml
new file mode 100644
index 000000000000..d2dbe568e408
--- /dev/null
+++ b/.semgrep/rules/devex/no-unbounded-drf-paginator.yaml
@@ -0,0 +1,47 @@
+rules:
+ - id: no-unbounded-drf-paginator
+ message: |
+ Do not subclass DRF's LimitOffsetPagination, PageNumberPagination or CursorPagination
+ directly, and do not set `max_limit = None` on a paginator. DRF has no upper bound by
+ default, so `?limit=` or `?page_size=` can ask one request to read a whole table.
+
+ Subclass a base from posthog/api/pagination.py instead:
+ - limit/offset pages: `BoundedLimitOffsetPagination`
+ - numbered pages: `BoundedPageNumberPagination`
+ - cursor pages: `StableCursorPagination`
+ - facade lists: `FacadeLimitOffsetPagination` or `FacadeCursorPagination`
+
+ If the shared bases cannot express the list, add the behavior to posthog/api/pagination.py.
+ See "How do lists page?" in products/architecture.md.
+ severity: ERROR
+ languages: [python]
+ paths:
+ include:
+ - 'common/**/*.py'
+ - 'ee/**/*.py'
+ - 'posthog/**/*.py'
+ - 'products/**/*.py'
+ exclude:
+ - 'posthog/api/pagination.py'
+ - '**/test/**'
+ - '**/tests/**'
+ - '**/test_*.py'
+ pattern-either:
+ - patterns:
+ - pattern: |
+ class $CLASS(..., $BASE, ...):
+ ...
+ - metavariable-regex:
+ metavariable: $BASE
+ regex: ^(pagination\.)?(LimitOffsetPagination|PageNumberPagination|CursorPagination)$
+ - patterns:
+ - pattern-inside: |
+ class $CLASS(...):
+ ...
+ - pattern: max_limit = None
+ - metavariable-regex:
+ metavariable: $CLASS
+ regex: ^\w*Pagination$
+ metadata:
+ category: maintainability
+ confidence: HIGH
diff --git a/posthog/api/test/test_pagination.py b/posthog/api/test/test_pagination.py
index 604d36644959..9414d9ccc63c 100644
--- a/posthog/api/test/test_pagination.py
+++ b/posthog/api/test/test_pagination.py
@@ -136,15 +136,6 @@ class TestCursorPagination(BaseTest):
for cursor in cursors:
assert self._drf_page_ids(cursor) == [row["id"] for row in self._page(mode, cursor)["results"]]
- def test_ordering_keeps_one_term_per_field_and_caps_the_field_count(self) -> None:
- def ordering_for(param: str) -> tuple[str, ...]:
- request = Request(APIRequestFactory().get("/annotations/", {"ordering": param}))
- return _ByDateMarkerQueryset().get_ordering(request, Annotation.objects.all(), _OrderableAnnotationView())
-
- assert ordering_for("date_marker,-date_marker,date_marker") == ("date_marker", "id")
- with self.assertRaises(ValidationError):
- ordering_for("date_marker,created_at,updated_at,content,-id")
-
@parameterized.expand(
[
("negative_offset", b64encode(b"o=-1").decode("ascii")),
@@ -164,3 +155,12 @@ class TestCursorPagination(BaseTest):
def test_rejects_a_malformed_cursor(self, _name: str, cursor: str) -> None:
with self.assertRaises(NotFound):
self._page("queryset", cursor)
+
+ def test_ordering_keeps_one_term_per_field_and_caps_the_field_count(self) -> None:
+ def ordering_for(param: str) -> tuple[str, ...]:
+ request = Request(APIRequestFactory().get("/annotations/", {"ordering": param}))
+ return _ByDateMarkerQueryset().get_ordering(request, Annotation.objects.all(), _OrderableAnnotationView())
+
+ assert ordering_for("date_marker,-date_marker,date_marker") == ("date_marker", "id")
+ with self.assertRaises(ValidationError):
+ ordering_for("date_marker,created_at,updated_at,content,-id")
diff --git a/posthog/test/repo_invariants/test_pagination_contract.py b/posthog/test/repo_invariants/test_pagination_contract.py
index 5f8bf8032558..c0b0124ef160 100644
--- a/posthog/test/repo_invariants/test_pagination_contract.py
+++ b/posthog/test/repo_invariants/test_pagination_contract.py
@@ -1,12 +1,13 @@
from collections.abc import Iterator
+from typing import Any
from django.urls import URLPattern, URLResolver, get_resolver
from rest_framework.generics import GenericAPIView
-from rest_framework.mixins import ListModelMixin
-from rest_framework.pagination import CursorPagination
+from rest_framework.pagination import BasePagination, CursorPagination
from rest_framework.viewsets import ViewSetMixin
+from posthog.api.pagination import BoundedLimitOffsetPagination, BoundedPageNumberPagination, StableCursorPagination
from posthog.api.routing import TeamAndOrgViewSetMixin
LIST_VIEWSETS_WITHOUT_DIRECT_SHARED_PAGINATION = {
@@ -26,305 +27,6 @@ LIST_VIEWSETS_WITHOUT_DIRECT_SHARED_PAGINATION = {
"products.workflows.backend.presentation.views.hog_flow_template.PublicHogFlowTemplateViewSet",
}
-EXISTING_CUSTOM_LIST_VIEWSETS = {
- "products.aeo.backend.presentation.views.AEOPromptViewSet",
- # Returns one bounded object (capped at SERVICES_LIMIT services), not a page of rows.
- "products.apm.backend.presentation.views.ServicesHealthViewSet",
- # Returns one bounded object (capped at ENDPOINTS_LIMIT rows), not a page of rows.
- "products.apm.backend.presentation.views.EndpointsHealthViewSet",
- # Returns one bounded object (capped at MAP_EDGES_LIMIT edges over a bounded trace sample), not a page of rows.
- "products.apm.backend.presentation.views.ServiceMapViewSet",
- # Returns the team's 20 most recent import runs, not a page of rows.
- "products.messaging.backend.presentation.views.provider_imports.ProviderImportViewSet",
- "ee.api.billing.BillingViewset",
- "ee.api.quota_limits.QuotaLimitsViewSet",
- "products.subscriptions.backend.presentation.views.SubscriptionDeliveryViewSet",
- "products.subscriptions.backend.presentation.views.SubscriptionViewSet",
- "ee.clickhouse.views.experiment_saved_metrics.ExperimentSavedMetricViewSet",
- "ee.clickhouse.views.person.EnterprisePersonViewSet",
- "ee.clickhouse.views.person.LegacyEnterprisePersonViewSet",
- "posthog.api.advanced_activity_logs.viewset.ActivityLogViewSet",
- "posthog.api.advanced_activity_logs.viewset.AdvancedActivityLogsViewSet",
- "posthog.api.advanced_activity_logs.viewset.OrganizationAdvancedActivityLogsViewSet",
- "posthog.api.authentication.DevLoginViewSet",
- "posthog.api.cohort.CohortViewSet",
- "posthog.api.cohort.LegacyCohortViewSet",
- "posthog.api.column_configuration.ColumnConfigurationViewSet",
- "posthog.api.comments.CommentViewSet",
- "posthog.api.data_color_theme.DataColorThemeViewSet",
- "posthog.api.data_deletion_request.DataDeletionRequestViewSet",
- "posthog.api.debug_ch_queries.DebugCHQueries",
- "posthog.api.event.EventViewSet",
- "posthog.api.event.LegacyEventViewSet",
- "posthog.api.event_definition.EventDefinitionViewSet",
- "posthog.api.event_filter_config.EventFilterConfigViewSet",
- "posthog.api.file_system.file_system.FileSystemViewSet",
- "posthog.api.health_issue.HealthIssueViewSet",
- "posthog.api.ingestion_warnings.IngestionWarningsViewSet",
- "posthog.api.ingestion_warnings_v2.IngestionWarningsV2ViewSet",
- "posthog.api.instance_status.InstanceStatusViewSet",
- "posthog.api.integration.IntegrationViewSet",
- "posthog.api.llm_prompt.LLMPromptViewSet",
- "posthog.api.my_notifications.MyNotificationsViewSet",
- "posthog.api.oauth.connected_apps.ConnectedAppsViewSet",
- "posthog.api.organization_member.OrganizationMemberViewSet",
- "posthog.api.organization_notification_locks.OrganizationNotificationLockViewSet",
- "posthog.api.personal_api_key.PersonalAPIKeyViewSet",
- "posthog.api.project.ProjectViewSet",
- "posthog.api.project.RootProjectViewSet",
- "posthog.api.proxy_record.ProxyRecordViewset",
- "posthog.api.search.SearchViewSet",
- "posthog.api.sharing.SharingConfigurationViewSet",
- "posthog.api.tagged_item.TaggedItemViewSet",
- "posthog.api.uploaded_media.MediaViewSet",
- "posthog.api.user_integration.UserIntegrationViewSet",
- "posthog.api.web_vitals.WebVitalsViewSet",
- "posthog.api.webauthn.WebAuthnCredentialViewSet",
- "posthog.session_recordings.session_recording_api.SessionRecordingViewSet",
- "posthog.session_recordings.session_recording_playlist_api.SessionRecordingPlaylistViewSet",
- "posthog.taxonomy.property_definition_api.PropertyDefinitionViewSet",
- "products.access_control.backend.presentation.views.PropertyAccessControlViewSet",
- "products.actions.backend.api.action.ActionViewSet",
- "products.ai_observability.backend.api.clustering_config.ClusteringConfigViewSet",
- "products.ai_observability.backend.api.clustering_job.ClusteringJobViewSet",
- "products.ai_observability.backend.api.datasets.DatasetItemViewSet",
- "products.ai_observability.backend.api.datasets.DatasetViewSet",
- "products.ai_observability.backend.api.evaluation_backfills.EvaluationBackfillViewSet",
- "products.ai_observability.backend.api.evaluation_config.EvaluationConfigViewSet",
- "products.ai_observability.backend.api.evaluation_reports.EvaluationReportViewSet",
- "products.ai_observability.backend.api.evaluations.EvaluationViewSet",
- "products.ai_observability.backend.api.instrumentation_checklist.AIObservabilityInstrumentationChecklistViewSet",
- "products.ai_observability.backend.api.models.LLMModelsViewSet",
- "products.ai_observability.backend.api.offline_experiments.OfflineExperimentViewSet",
- "products.ai_observability.backend.api.personal_spend.PersonalSpendViewSet",
- "products.ai_observability.backend.api.provider_keys.LLMProviderKeyViewSet",
- "products.ai_observability.backend.api.review_queues.ReviewQueueItemViewSet",
- "products.ai_observability.backend.api.review_queues.ReviewQueueViewSet",
- "products.ai_observability.backend.api.score_definitions.ScoreDefinitionViewSet",
- "products.ai_observability.backend.api.taggers.TaggerViewSet",
- "products.ai_observability.backend.api.trace_reviews.TraceReviewViewSet",
- "products.alerts.backend.presentation.views.alert.AlertViewSet",
- "products.alerts_platform.backend.presentation.views.platform_alert.PlatformAlertConfigurationViewSet",
- "products.annotations.backend.presentation.views.ChangeFeedViewSet",
- "products.autoresearch.backend.presentation.views.views.AutoresearchModelViewSet",
- "products.autoresearch.backend.presentation.views.views.AutoresearchPipelineViewSet",
- "products.autoresearch.backend.presentation.views.views.AutoresearchRunViewSet",
- "products.autoresearch.backend.presentation.views.views.AutoresearchSuggestionViewSet",
- "products.autoresearch.backend.presentation.views.views.AutoresearchTrainingRunViewSet",
- "products.batch_exports.backend.presentation.views.batch_export.backfills.BatchExportBackfillViewSet",
- "products.batch_exports.backend.presentation.views.batch_export.exports.BatchExportViewSet",
- "products.batch_exports.backend.presentation.views.batch_export.runs.BatchExportRunViewSet",
- "products.batch_exports.backend.presentation.views.file_download.FileDownloadBatchExportOnDemandViewSet",
- # Lists at most MAX_LIBRARIES_PER_TEAM (100) libraries, so it has no pages.
- "products.business_knowledge.backend.api.libraries.KnowledgeLibraryViewSet",
- "products.business_knowledge.backend.api.playground.BusinessKnowledgePlaygroundChatViewSet",
- "products.business_knowledge.backend.api.views.KnowledgeGapSuggestionViewSet",
- "products.business_knowledge.backend.api.views.KnowledgeSourceViewSet",
- "products.canvas.backend.presentation.views.CanvasViewSet",
- "products.cdp.backend.api.hog_function.HogFunctionViewSet",
- "products.cdp.backend.api.hog_function_template.PublicHogFunctionTemplateViewSet",
- "products.cdp.backend.api.plugin_log_entry.PluginLogEntryViewSet",
- "products.cohorts.backend.api.staff_tools.CohortsStaffToolsViewSet",
- "products.conversations.backend.api.ai_context.AIContextAccountPropertiesViewSet",
- "products.conversations.backend.api.ai_reply_playbook.AIReplyPlaybookViewSet",
- "products.conversations.backend.api.signing_secret.SigningSecretViewSet",
- # extend_schema_view only sets the list operation_id; the list itself stays the stock paginated one,
- # with -usage_count, -created_at, -id ordering and a page-boundary test.
- "products.conversations.backend.api.ticket_macros.TicketMacroViewSet",
- "products.conversations.backend.api.tickets.TicketViewSet",
- "products.customer_analytics.backend.presentation.views.announcements.AnnouncementViewSet",
- # HogQL paginates after person aggregation. Tied-sort boundaries are covered by
- # TestAccountUsersQuery.test_persons_are_narrowed_aggregated_and_paginated.
- "products.customer_analytics.backend.presentation.views.account_persons_query.AccountPersonsViewSet",
- "products.customer_analytics.backend.presentation.views.customer_tasks.CustomerTaskViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountNotebookViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountNotesViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountRelationshipDefinitionViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountRelationshipViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountTrackRuleViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountViewSet",
- "products.customer_analytics.backend.presentation.views.views.AccountViewTemplateViewSet",
- "products.customer_analytics.backend.presentation.views.views.CalendarSyncViewSet",
- "products.customer_analytics.backend.presentation.views.views.CustomPropertyDefinitionViewSet",
- "products.customer_analytics.backend.presentation.views.views.CustomPropertySourceViewSet",
- "products.customer_analytics.backend.presentation.views.views.CustomPropertyValueViewSet",
- "products.customer_analytics.backend.presentation.views.views.CustomerJourneyViewSet",
- "products.customer_analytics.backend.presentation.views.views.CustomerProfileConfigViewSet",
- "products.customer_analytics.backend.presentation.views.views.EventStreamViewSet",
- "products.customer_analytics.backend.presentation.views.views.FeatureRequestProductAreaViewSet",
- "products.customer_analytics.backend.presentation.views.views.FeatureRequestViewSet",
- "products.dashboards.backend.api.dashboard.DashboardsViewSet",
- "products.dashboards.backend.api.dashboard.LegacyDashboardsViewSet",
- "products.dashboards.backend.api.dashboard.LegacyInsightViewSet",
- "products.dashboards.backend.api.dashboard_templates.DashboardTemplateViewSet",
- "products.data_catalog.backend.presentation.views.MetricViewSet",
- "products.data_catalog.backend.presentation.views.RelationshipProposalViewSet",
- "products.data_modeling.backend.presentation.views.node.NodeViewSet",
- # Only the model breakdown is paginated; overview and trends cover the full range.
- "products.data_modeling.backend.presentation.views.usage.ModelUsageViewSet",
- "products.data_quality.backend.presentation.views.DataQualityCheckViewSet",
- "products.data_quality.backend.presentation.views.DataQualityRunViewSet",
- "products.data_warehouse.backend.presentation.views.column_annotation.WarehouseColumnAnnotationViewSet",
- # extend_schema_view only documents the all_engines query parameter; the list itself stays the stock
- # paginated one, with -created_at ordering and a page-boundary test.
- "products.data_warehouse.backend.presentation.views.data_modeling_job.DataModelingJobViewSet",
- "products.data_warehouse.backend.presentation.views.expression.DataWarehouseExpressionViewSet",
- "products.data_warehouse.backend.presentation.views.fix_hogql.FixHogQLViewSet",
- "products.data_warehouse.backend.presentation.views.saved_query.viewset.DataWarehouseSavedQueryViewSet",
- "products.data_warehouse.backend.presentation.views.saved_query_column_annotation.DataWarehouseSavedQueryColumnAnnotationViewSet",
- # extend_schema_view wraps the inherited DRF list solely to document include_columns.
- "products.data_warehouse.backend.presentation.views.table.TableViewSet",
- "products.data_warehouse.backend.presentation.views.view_link.ViewLinkViewSet",
- "products.endpoints.backend.presentation.views.api.EndpointViewSet",
- "products.error_tracking.backend.presentation.views.alerts.ErrorTrackingAlertViewSet",
- "products.error_tracking.backend.presentation.views.assignment_rules.ErrorTrackingAssignmentRuleViewSet",
- # Returns the fixed set of built-in filter definitions, one entry each, not a page of rows.
- "products.error_tracking.backend.presentation.views.built_in_filters.ErrorTrackingBuiltInFilterViewSet",
- "products.error_tracking.backend.presentation.views.bypass_rules.ErrorTrackingBypassRuleViewSet",
- "products.error_tracking.backend.presentation.views.external_references.ErrorTrackingExternalReferenceViewSet",
- "products.error_tracking.backend.presentation.views.fingerprints.ErrorTrackingFingerprintViewSet",
- "products.error_tracking.backend.presentation.views.grouping_rules.ErrorTrackingGroupingRuleViewSet",
- "products.error_tracking.backend.presentation.views.issues.ErrorTrackingIssueViewSet",
- "products.error_tracking.backend.presentation.views.recommendations.ErrorTrackingRecommendationViewSet",
- "products.error_tracking.backend.presentation.views.releases.ErrorTrackingReleaseViewSet",
- "products.error_tracking.backend.presentation.views.severity_rules.ErrorTrackingSeverityRuleViewSet",
- "products.error_tracking.backend.presentation.views.spike_detection_config.ErrorTrackingSpikeDetectionConfigViewSet",
- "products.error_tracking.backend.presentation.views.spike_events.ErrorTrackingSpikeEventViewSet",
- "products.error_tracking.backend.presentation.views.stack_frames.ErrorTrackingStackFrameViewSet",
- "products.error_tracking.backend.presentation.views.suppression_rules.ErrorTrackingSuppressionRuleViewSet",
- "products.error_tracking.backend.presentation.views.symbol_sets.ErrorTrackingSymbolSetViewSet",
- "products.experiments.backend.presentation.views.EnterpriseExperimentsViewSet",
- "products.feature_flags.backend.api.feature_flag.FeatureFlagViewSet",
- "products.feature_flags.backend.api.feature_flag.LegacyFeatureFlagViewSet",
- "products.feature_flags.backend.api.scheduled_change.ScheduledChangeViewSet",
- "products.feature_flags.backend.api.staff_cache.FeatureFlagsStaffCacheViewSet",
- "products.feature_flags.backend.api.staff_team_config.FeatureFlagsStaffTeamConfigViewSet",
- "products.feature_flags.backend.api.staff_teams.FeatureFlagsStaffTeamSearchViewSet",
- "products.feature_flags.backend.presentation.request_usage.FeatureFlagRequestUsageViewSet",
- "products.field_notes.backend.api.FieldNoteViewSet",
- "products.groups.backend.presentation.views.GroupsTypesViewSet",
- "products.groups.backend.presentation.views.GroupsViewSet",
- "products.growth.backend.api.identity_matching.IdentityMatchingLinkViewSet",
- "products.legal_documents.backend.presentation.views.LegalDocumentViewSet",
- "products.logs.backend.presentation.views.alerts_api.LogsAlertViewSet",
- "products.managed_migrations.backend.api.batch_imports.BatchImportViewSet",
- "products.managed_migrations.backend.api.support_batch_imports.BatchImportSupportViewSet",
- "products.mcp_analytics.backend.presentation.views.MCPFeedbackViewSet",
- "products.mcp_analytics.backend.presentation.views.MCPIntentClusterViewSet",
- "products.mcp_analytics.backend.presentation.views.MCPMissingCapabilityViewSet",
- "products.mcp_analytics.backend.presentation.views.MCPSessionViewSet",
- "products.mcp_registry.backend.presentation.views.MCPRegistryServerViewSet",
- "products.mcp_store.backend.presentation.agent_views.MCPGatewayAgentViewSet",
- "products.mcp_store.backend.presentation.gateway_views.MCPAuditEventViewSet",
- "products.mcp_store.backend.presentation.gateway_views.MCPGatewayConfigViewSet",
- "products.mcp_store.backend.presentation.gateway_views.MCPGatewayMemberViewSet",
- "products.mcp_store.backend.presentation.views.MCPOAuthRedirectViewSet",
- "products.mcp_store.backend.presentation.views.MCPServerViewSet",
- # Lists at most 20 imports from the last 7 days, so it has no pages.
- "products.metrics.backend.presentation.dashboard_import_api.MetricsDashboardImportViewSet",
- "products.metrics.backend.presentation.suggested_dashboards_api.MetricsDashboardTemplateViewSet",
- "products.metrics.backend.presentation.suggested_dashboards_api.MetricsSuggestedDashboardViewSet",
- "products.notebooks.backend.presentation.views.notebook.NotebookViewSet",
- "products.notebooks.backend.presentation.views.reusable_widget.ReusableWidgetViewSet",
- "products.notifications.backend.presentation.views.NotificationsViewSet",
- "products.product_analytics.backend.presentation.events_retention.EventsRetentionViewSet",
- # Returns the organization's one retention setting, not a page of rows.
- "products.product_analytics.backend.presentation.events_retention.OrganizationEventsRetentionViewSet",
- "products.product_analytics.backend.presentation.insight.InsightViewSet",
- "products.product_tours.backend.api.product_tour.ProductTourViewSet",
- # Pages with `limit`/`offset` over clusters ranked live, with `has_more`; the API tests cover the page boundary.
- "products.replay_vision.backend.api.clusters.VisionGroupViewSet",
- "products.replay_vision.backend.api.clusters.VisionThemeViewSet",
- "products.replay_vision.backend.api.observations.ReplayObservationViewSet",
- "products.replay_vision.backend.api.observations.SessionReplayObservationViewSet",
- "products.replay_vision.backend.api.quota.VisionQuotaViewSet",
- "products.replay_vision.backend.api.scanners.ReplayScannerViewSet",
- "products.replay_vision.backend.api.scout_reports.ScannerScoutReportViewSet",
- "products.replay_vision.backend.api.variants.ReplayScannerVariantsViewSet",
- "products.replay_vision.backend.api.vision_alerts.VisionAlertViewSet",
- "products.review_hog.backend.presentation.views.blind_spots.ReviewBlindSpotsConfigViewSet",
- "products.review_hog.backend.presentation.views.perspectives.ReviewPerspectiveConfigViewSet",
- "products.review_hog.backend.presentation.views.repositories.ReviewInstallationClaimViewSet",
- "products.review_hog.backend.presentation.views.repositories.ReviewRepositoryChoiceViewSet",
- "products.review_hog.backend.presentation.views.repositories.ReviewRepositoryViewSet",
- "products.review_hog.backend.presentation.views.resolution.ReviewResolutionConfigViewSet",
- "products.review_hog.backend.presentation.views.reviews.ReviewRecentReviewsViewSet",
- "products.review_hog.backend.presentation.views.validators.ReviewValidatorConfigViewSet",
- # Returns the requesting user's own summary as a single document, so there is nothing to paginate.
- "products.signals.backend.presentation.activity_summary.ActivitySummaryViewSet",
- # Counts and hover details must use the same complete seven-day window.
- "products.signals.backend.presentation.inbox_summary.InboxSummaryViewSet",
- # Returns one team's onboarding state as a single document, so there is nothing to paginate.
- "products.signals.backend.presentation.onboarding.InboxOnboardingViewSet",
- # Lists only the requesting member's own exclusions, a short list, so `pagination_class` is None.
- "products.signals.backend.presentation.reviewer_exclusions.SignalReviewerExclusionViewSet",
- # Returns one usage overview document, not a page of rows.
- "products.signals.backend.presentation.spend.SignalSpendViewSet",
- # Returns one rollup per signal source type; Settings needs the complete breakdown to total usage.
- "products.signals.backend.presentation.spend.SignalSourceSpendViewSet",
- "products.signals.backend.scout_harness.views.SignalScoutConfigViewSet",
- "products.signals.backend.scout_harness.views.SignalScoutMembersViewSet",
- "products.signals.backend.scout_harness.views.SignalScoutNoteViewSet",
- "products.signals.backend.scout_harness.views.SignalScoutRunViewSet",
- "products.signals.backend.scout_harness.views.SignalScratchpadViewSet",
- "products.signals.backend.scout_suggestions_api.SignalScoutSuggestionViewSet",
- "products.signals.backend.views.SignalProcessingViewSet",
- "products.signals.backend.views.SignalReportArtefactViewSet",
- "products.signals.backend.views.SignalReportCheckViewSet",
- "products.signals.backend.views.SignalReportViewSet",
- "products.signals.backend.views.SignalSourceConfigViewSet",
- "products.signals.backend.views.SignalTeamConfigViewSet",
- "products.skills.backend.api.community_skills.CommunitySkillViewSet",
- "products.skills.backend.api.skills.LLMSkillViewSet",
- "products.stamphog.backend.presentation.views.DigestRunViewSet",
- "products.stamphog.backend.presentation.views.PullRequestViewSet",
- "products.stamphog.backend.presentation.views.ReviewRunViewSet",
- "products.stamphog.backend.presentation.views.StamphogRepoConfigViewSet",
- "products.messaging.backend.presentation.views.message_templates.MessageTemplatesViewSet",
- "products.streamlit_apps.backend.presentation.views.StreamlitAppViewSet",
- "products.surveys.backend.api.survey.SurveyViewSet",
- "products.tasks.backend.presentation.views.api.SandboxCustomImageViewSet",
- "products.tasks.backend.presentation.views.api.SandboxEnvironmentViewSet",
- "products.tasks.backend.presentation.views.api.TaskRunLivingArtifactViewSet",
- "products.tasks.backend.presentation.views.api.TaskRunViewSet",
- "products.tasks.backend.presentation.views.api.TaskViewSet",
- "products.tasks.backend.presentation.views.channels_api.ChannelFeedMessageViewSet",
- "products.tasks.backend.presentation.views.channels_api.ChannelViewSet",
- "products.tasks.backend.presentation.views.channels_api.TaskActivityViewSet",
- "products.tasks.backend.presentation.views.channels_api.TaskMentionViewSet",
- "products.cross_project_dashboards.backend.presentation.views.CrossProjectDashboardTileViewSet",
- "products.cross_project_dashboards.backend.presentation.views.CrossProjectDashboardViewSet",
- "products.tasks.backend.presentation.views.channels_api.TaskThreadMessageViewSet",
- "products.tasks.backend.presentation.views.config_api.TasksTeamConfigViewSet",
- "products.tasks.backend.presentation.views.config_api.TasksUserConfigViewSet",
- "products.tasks.backend.presentation.views.desktop.DesktopBetaTermsViewSet",
- "products.tasks.backend.presentation.views.sandbox_pricing_api.SandboxComputePricingViewSet",
- "products.uptime_monitoring.backend.presentation.views.UptimeMonitorViewSet",
- "products.visual_review.backend.presentation.views.RepoRunsViewSet",
- "products.visual_review.backend.presentation.views.RepoViewSet",
- "products.visual_review.backend.presentation.views.RunViewSet",
- "products.warehouse_sources.backend.presentation.views.column_statistics.WarehouseColumnStatisticsViewSet",
- "products.warehouse_sources.backend.presentation.views.public_source_configs.PublicSourceConfigViewSet",
- "products.warehouse_suggestions.backend.presentation.views.WarehouseSuggestionViewSet",
- "products.web_analytics.backend.api.custom_bot_rules.CustomBotRuleViewSet",
- "products.web_analytics.backend.api.heatmaps_api.HeatmapViewSet",
- "products.web_analytics.backend.api.heatmaps_api.LegacyHeatmapViewSet",
- "products.web_analytics.backend.api.heatmaps_api.SavedHeatmapViewSet",
- "products.web_analytics.backend.presentation.views.content_autopilot.ContentAutopilotOpportunityViewSet",
- "products.web_analytics.backend.presentation.views.content_autopilot.ContentAutopilotProposalViewSet",
- "products.web_analytics.backend.presentation.views.content_autopilot.ContentAutopilotRunViewSet",
- "products.wizard.backend.presentation.artifacts.views.WizardRunArtifactViewSet",
- "products.wizard.backend.presentation.registry.views.WizardRegistryViewSet",
- "products.wizard.backend.presentation.runs.views.WizardRunViewSet",
- "products.wizard.backend.presentation.sessions.views.WizardSessionViewSet",
- # Serves the whole tool catalog as one cached document, so there is nothing to page.
- "products.wizard.backend.presentation.tool_catalog.views.WizardToolCatalogViewSet",
- "products.workflows.backend.presentation.views.hog_flow.HogFlowViewSet",
- "products.workflows.backend.presentation.views.hog_flow_template.HogFlowTemplateViewSet",
- "products.workflows.backend.presentation.views.hog_flow_template.PublicHogFlowTemplateViewSet",
- "products.messaging.backend.presentation.views.message_categories.MessageCategoryViewSet",
-}
-
def _url_patterns(patterns: list[URLPattern | URLResolver]) -> Iterator[URLPattern]:
for pattern in patterns:
@@ -334,20 +36,52 @@ def _url_patterns(patterns: list[URLPattern | URLResolver]) -> Iterator[URLPatte
yield pattern
+def _class_name(cls: type) -> str:
+ return f"{cls.__module__}.{cls.__qualname__}"
+
+
+def _pagination_class(callback: Any, view: type[GenericAPIView]) -> type[BasePagination] | None:
+ return getattr(callback, "initkwargs", {}).get("pagination_class", view.pagination_class)
+
+
+def _base_to_use(pagination_class: type[BasePagination]) -> str | None:
+ if issubclass(pagination_class, CursorPagination):
+ if issubclass(pagination_class, StableCursorPagination):
+ return None
+ return "StableCursorPagination, so rows that share a sort value cannot move a page boundary"
+ if issubclass(pagination_class, (BoundedLimitOffsetPagination, BoundedPageNumberPagination)):
+ return None
+ return "BoundedLimitOffsetPagination, so one request cannot ask for a whole table"
+
+
+def test_paginators_extend_the_shared_bases() -> None:
+ problems: set[str] = set()
+ for pattern in _url_patterns(get_resolver().url_patterns):
+ view = getattr(pattern.callback, "cls", None) or getattr(pattern.callback, "view_class", None)
+ if view is None or not issubclass(view, GenericAPIView):
+ continue
+ pagination_class = _pagination_class(pattern.callback, view)
+ if pagination_class is None:
+ continue
+ base = _base_to_use(pagination_class)
+ if base is not None:
+ problems.add(f"{_class_name(pagination_class)} (used by {_class_name(view)}): subclass {base}")
+
+ assert not problems, "Paginators must extend a base in posthog/api/pagination.py:\n " + "\n ".join(
+ sorted(problems)
+ )
+
+
def test_new_list_viewsets_review_their_pagination_contract() -> None:
list_viewsets: set[str] = set()
- custom_list_viewsets: set[str] = set()
for pattern in _url_patterns(get_resolver().url_patterns):
viewset = getattr(pattern.callback, "cls", None)
actions = getattr(pattern.callback, "actions", None) or {}
if viewset is None or not issubclass(viewset, ViewSetMixin) or "list" not in actions.values():
continue
- viewset_name = f"{viewset.__module__}.{viewset.__qualname__}"
- if viewset.list is not ListModelMixin.list:
- custom_list_viewsets.add(viewset_name)
if not issubclass(viewset, GenericAPIView):
continue
- pagination_class = getattr(pattern.callback, "initkwargs", {}).get("pagination_class", viewset.pagination_class)
+ pagination_class = _pagination_class(pattern.callback, viewset)
if pagination_class is None or issubclass(pagination_class, CursorPagination):
continue
if (
@@ -355,7 +89,7 @@ def test_new_list_viewsets_review_their_pagination_contract() -> None:
and viewset.paginate_queryset is TeamAndOrgViewSetMixin.paginate_queryset
):
continue
- list_viewsets.add(viewset_name)
+ list_viewsets.add(_class_name(viewset))
unreviewed = sorted(list_viewsets - LIST_VIEWSETS_WITHOUT_DIRECT_SHARED_PAGINATION)
assert not unreviewed, (
@@ -365,12 +99,3 @@ def test_new_list_viewsets_review_their_pagination_contract() -> None:
stale = sorted(LIST_VIEWSETS_WITHOUT_DIRECT_SHARED_PAGINATION - list_viewsets)
assert not stale, "Remove standard list viewsets that no longer bypass shared pagination:\n " + "\n ".join(stale)
-
- unreviewed_custom = sorted(custom_list_viewsets - EXISTING_CUSTOM_LIST_VIEWSETS)
- assert not unreviewed_custom, (
- "New custom list actions need a pagination review and a page-boundary test, or a reviewed exception:\n "
- + "\n ".join(unreviewed_custom)
- )
-
- stale_custom = sorted(EXISTING_CUSTOM_LIST_VIEWSETS - custom_list_viewsets)
- assert not stale_custom, "Remove custom list actions that no longer exist:\n " + "\n ".join(stale_custom)
diff --git a/products/ai_observability/backend/api/datasets.py b/products/ai_observability/backend/api/datasets.py
index cfcb8ce547f8..52227fdd85b7 100644
--- a/products/ai_observability/backend/api/datasets.py
+++ b/products/ai_observability/backend/api/datasets.py
@@ -13,7 +13,6 @@ from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import OpenApiParameter, extend_schema_field
from rest_framework import serializers, status
from rest_framework.decorators import action
-from rest_framework.pagination import LimitOffsetPagination
from rest_framework.permissions import BasePermission, IsAuthenticated
from rest_framework.request import Request
from rest_framework.response import Response
@@ -23,6 +22,7 @@ from rest_framework.viewsets import GenericViewSet
from posthog.api.documentation import extend_schema
from posthog.api.fields import RepeatedOrCommaSeparatedListField
from posthog.api.monitoring import monitor
+from posthog.api.pagination import BoundedLimitOffsetPagination
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.shared import UserBasicSerializer
from posthog.auth import InternalAPIAuthentication
@@ -544,17 +544,17 @@ class DatasetItemRetrieveQuerySerializer(serializers.Serializer):
)
-class DatasetPagination(LimitOffsetPagination):
+class DatasetPagination(BoundedLimitOffsetPagination):
default_limit = 50
max_limit = 100
-class DatasetItemPagination(LimitOffsetPagination):
+class DatasetItemPagination(BoundedLimitOffsetPagination):
default_limit = 10
max_limit = 25
-class DatasetItemVersionPagination(LimitOffsetPagination):
+class DatasetItemVersionPagination(BoundedLimitOffsetPagination):
default_limit = 25
max_limit = 100
diff --git a/products/ai_observability/frontend/generated/api.schemas.ts b/products/ai_observability/frontend/generated/api.schemas.ts
index fa2923423782..1a08c44a1303 100644
--- a/products/ai_observability/frontend/generated/api.schemas.ts
+++ b/products/ai_observability/frontend/generated/api.schemas.ts
@@ -5993,6 +5993,7 @@ export type DatasetItemsListParams = {
dataset: string
/**
* Number of results to return per page.
+ * @maximum 25
*/
limit?: number
/**
@@ -6052,6 +6053,7 @@ export type DatasetItemsPartialUpdateBody = {
export type DatasetItemsVersionsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
@@ -6073,6 +6075,7 @@ export type DatasetsListParams = {
id__in?: string[]
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
@@ -6118,6 +6121,7 @@ export const DatasetsListTagMatch = {
export type DatasetsRevisionsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
diff --git a/products/architecture.md b/products/architecture.md
index 3ac25b0376d6..0c2d83f55a6c 100644
--- a/products/architecture.md
+++ b/products/architecture.md
@@ -497,6 +497,9 @@ The facade pages in SQL instead, and the view builds the standard response from
- Every list returns `count`, `next`, `previous` and `results`, so clients and MCP tools page every product the same way.
Add extra fields beside them when a list needs them, and do not replace them.
- Do not set paginator attributes by hand, build a fake queryset for a paginator, or return a whole list for the view to slice.
+ The `no-hand-set-paginator-state` semgrep rule blocks the first.
+- Every paginator extends a base in `posthog/api/pagination.py`: `BoundedLimitOffsetPagination`, `BoundedPageNumberPagination` or `StableCursorPagination`.
+ `posthog/test/repo_invariants/test_pagination_contract.py` fails for a registered view whose paginator does not.
`products/visual_review/backend/presentation/views.py` shows the limit/offset form.
diff --git a/products/mcp_analytics/backend/presentation/views.py b/products/mcp_analytics/backend/presentation/views.py
index 903bbc93e246..b212f4fc1df0 100644
--- a/products/mcp_analytics/backend/presentation/views.py
+++ b/products/mcp_analytics/backend/presentation/views.py
@@ -8,12 +8,11 @@ from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema
from rest_framework import status, viewsets
from rest_framework.decorators import action
-from rest_framework.pagination import LimitOffsetPagination
from rest_framework.request import Request
from rest_framework.response import Response
from posthog.api.mixins import ValidatedRequest, validated_request
-from posthog.api.pagination import page_link, previous_offset
+from posthog.api.pagination import BoundedLimitOffsetPagination, page_link, previous_offset
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.event_usage import report_user_action
from posthog.models.user import User
@@ -50,12 +49,12 @@ def _parse_detail_date_from(raw: str | None) -> datetime | None:
return parse_datetime(raw) if raw else None
-class MCPAnalyticsPagination(LimitOffsetPagination):
+class MCPAnalyticsPagination(BoundedLimitOffsetPagination):
default_limit = 100
max_limit = 500
-class MCPSessionPagination(LimitOffsetPagination):
+class MCPSessionPagination(BoundedLimitOffsetPagination):
"""Returns ``{next, previous, results, has_next}`` without a ``count``. The list is an
on-the-fly ClickHouse aggregate with no cheap total, so ``has_next`` comes from the
logic layer over-fetching one row rather than a count query.
diff --git a/products/mcp_analytics/frontend/generated/api.schemas.ts b/products/mcp_analytics/frontend/generated/api.schemas.ts
index 1f88d439663f..b2a8ab7fe2bd 100644
--- a/products/mcp_analytics/frontend/generated/api.schemas.ts
+++ b/products/mcp_analytics/frontend/generated/api.schemas.ts
@@ -659,6 +659,7 @@ export interface MCPIntentDigestApi {
export type McpAnalyticsFeedbackListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number
/**
@@ -677,6 +678,7 @@ export type McpAnalyticsIntentClustersRetrieveParams = {
export type McpAnalyticsMissingCapabilitiesListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number
/**
diff --git a/products/tasks/backend/presentation/views/channels_api.py b/products/tasks/backend/presentation/views/channels_api.py
index a967a0a63707..8cce004c3628 100644
--- a/products/tasks/backend/presentation/views/channels_api.py
+++ b/products/tasks/backend/presentation/views/channels_api.py
@@ -6,13 +6,12 @@ from drf_spectacular.utils import OpenApiResponse, extend_schema
from rest_framework import status, viewsets
from rest_framework.decorators import action
from rest_framework.exceptions import NotFound, PermissionDenied, ValidationError
-from rest_framework.pagination import LimitOffsetPagination
from rest_framework.permissions import IsAuthenticated
from rest_framework.request import Request
from rest_framework.response import Response
from posthog.api.mixins import validated_request
-from posthog.api.pagination import page_link_with_params
+from posthog.api.pagination import BoundedLimitOffsetPagination, page_link_with_params
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.auth import OAuthAccessTokenAuthentication, PersonalAPIKeyAuthentication, SessionAuthentication
from posthog.models import OrganizationMembership
@@ -66,10 +65,11 @@ from products.tasks.backend.presentation.serializers import (
)
-class ChannelListPagination(LimitOffsetPagination):
+class ChannelListPagination(BoundedLimitOffsetPagination):
"""Opt-in paging for the channel list. ``default_limit = None`` keeps the plain
- array that clients read today when no ``limit`` is sent; a caller that asks for a
- page gets the standard ``count``/``next``/``previous`` envelope instead. ``list``
+ array that clients read when no ``limit`` is sent; a caller that asks for a
+ page gets the standard ``count``/``next``/``previous`` envelope instead, with
+ ``limit`` cut to ``max_limit``. ``list``
instantiates it directly, so the other paged actions on the viewset keep the
project-wide paginator."""
diff --git a/products/wizard/backend/presentation/artifacts/pagination.py b/products/wizard/backend/presentation/artifacts/pagination.py
index 9d83bcdf73c8..1af7e21fc1f0 100644
--- a/products/wizard/backend/presentation/artifacts/pagination.py
+++ b/products/wizard/backend/presentation/artifacts/pagination.py
@@ -1,6 +1,6 @@
-from rest_framework.pagination import LimitOffsetPagination
+from posthog.api.pagination import BoundedLimitOffsetPagination
-class WizardRunArtifactPagination(LimitOffsetPagination):
+class WizardRunArtifactPagination(BoundedLimitOffsetPagination):
default_limit = 100
max_limit = 100
diff --git a/products/wizard/backend/presentation/registry/pagination.py b/products/wizard/backend/presentation/registry/pagination.py
index a8fd39b3fcc9..51b36faa41c6 100644
--- a/products/wizard/backend/presentation/registry/pagination.py
+++ b/products/wizard/backend/presentation/registry/pagination.py
@@ -1,6 +1,6 @@
-from rest_framework.pagination import LimitOffsetPagination
+from posthog.api.pagination import BoundedLimitOffsetPagination
-class WizardRegistryPagination(LimitOffsetPagination):
+class WizardRegistryPagination(BoundedLimitOffsetPagination):
default_limit = 100
max_limit = 100
diff --git a/products/wizard/frontend/generated/api.schemas.ts b/products/wizard/frontend/generated/api.schemas.ts
index 789bf993f0dd..5e63d535588a 100644
--- a/products/wizard/frontend/generated/api.schemas.ts
+++ b/products/wizard/frontend/generated/api.schemas.ts
@@ -886,6 +886,7 @@ export const WizardRunPullRequestArtifactArtifactTypeEnumApi = {
export type WizardRegistryListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
@@ -927,6 +928,7 @@ export const WizardRunsListStatusItem = {
export type WizardRunsArtifactsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
diff --git a/services/mcp/src/api/generated.ts b/services/mcp/src/api/generated.ts
index c6327bfdc58b..ff92ee286c78 100644
--- a/services/mcp/src/api/generated.ts
+++ b/services/mcp/src/api/generated.ts
@@ -124445,6 +124445,7 @@ export namespace Schemas {
dataset: string;
/**
* Number of results to return per page.
+ * @maximum 25
*/
limit?: number;
/**
@@ -124498,6 +124499,7 @@ export namespace Schemas {
export type DatasetItemsVersionsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -124519,6 +124521,7 @@ export namespace Schemas {
id__in?: string[];
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -124565,6 +124568,7 @@ export namespace Schemas {
export type DatasetsRevisionsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -130277,6 +130281,7 @@ export namespace Schemas {
export type McpAnalyticsFeedbackListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number;
/**
@@ -130295,6 +130300,7 @@ export namespace Schemas {
export type McpAnalyticsMissingCapabilitiesListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number;
/**
@@ -135800,6 +135806,7 @@ export namespace Schemas {
export type WizardRegistryListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -135842,6 +135849,7 @@ export namespace Schemas {
export type WizardRunsArtifactsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
diff --git a/services/mcp/src/generated/ai_observability/api.ts b/services/mcp/src/generated/ai_observability/api.ts
index 4944eee9f83f..04da4f36d270 100644
--- a/services/mcp/src/generated/ai_observability/api.ts
+++ b/services/mcp/src/generated/ai_observability/api.ts
@@ -860,6 +860,7 @@ export const DatasetItemsListParams = () => zod.object({
})
export const datasetItemsListQueryArchivedDefault = false
+export const datasetItemsListQueryLimitMax = 25
export const DatasetItemsListQueryParams = () => zod.object({
archived: zod
@@ -867,7 +868,7 @@ export const DatasetItemsListQueryParams = () => zod.object({
.default(datasetItemsListQueryArchivedDefault)
.describe('Return archived items instead of active items.'),
dataset: zod.string().describe('Dataset whose items should be returned.'),
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod.number().max(datasetItemsListQueryLimitMax).optional().describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
revision: zod.number().min(1).optional().describe('Return the exact dataset snapshot at this revision.'),
})
@@ -1054,8 +1055,14 @@ export const DatasetItemsVersionsListParams = () => zod.object({
),
})
+export const datasetItemsVersionsListQueryLimitMax = 100
+
export const DatasetItemsVersionsListQueryParams = () => zod.object({
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(datasetItemsVersionsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
})
@@ -1073,6 +1080,8 @@ export const DatasetsListParams = () => zod.object({
export const datasetsListQueryArchivedDefault = false
export const datasetsListQueryIdInMax = 100
+export const datasetsListQueryLimitMax = 100
+
export const datasetsListQueryOrderByDefault = `-created_at`
export const datasetsListQueryTagMatchDefault = `any`
@@ -1088,7 +1097,7 @@ export const DatasetsListQueryParams = () => zod.object({
.max(datasetsListQueryIdInMax)
.optional()
.describe('Filter to these dataset IDs. Repeat the parameter or pass one comma-separated list, up to 100 IDs.'),
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod.number().max(datasetsListQueryLimitMax).optional().describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
order_by: zod
.string()
@@ -1240,8 +1249,14 @@ export const DatasetsRevisionsListParams = () => zod.object({
),
})
+export const datasetsRevisionsListQueryLimitMax = 100
+
export const DatasetsRevisionsListQueryParams = () => zod.object({
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(datasetsRevisionsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
})