feat: add public tag for api reference docs (#7227)

Author: wenxi-onyx

backend/ee/onyx/server/analytics/api.py

@@ -21,8 +21,9 @@
 from onyx.auth.users import current_user
 from onyx.db.engine.sql_engine import get_session
 from onyx.db.models import User
+from onyx.server.utils import PUBLIC_API_TAGS
 
-router = APIRouter(prefix="/analytics")
+router = APIRouter(prefix="/analytics", tags=PUBLIC_API_TAGS)
 
 
 _DEFAULT_LOOKBACK_DAYS = 30

backend/ee/onyx/server/query_history/api.py

@@ -48,6 +48,7 @@
 from onyx.server.documents.models import PaginatedReturn
 from onyx.server.query_and_chat.models import ChatSessionDetails
 from onyx.server.query_and_chat.models import ChatSessionsResponse
+from onyx.server.utils import PUBLIC_API_TAGS
 from onyx.utils.threadpool_concurrency import parallel_yield
 from shared_configs.contextvars import get_current_tenant_id
 
@@ -294,7 +295,7 @@ def list_all_query_history_exports(
         )
 
 
-@router.post("/admin/query-history/start-export")
+@router.post("/admin/query-history/start-export", tags=PUBLIC_API_TAGS)
 def start_query_history_export(
     _: User | None = Depends(current_admin_user),
     db_session: Session = Depends(get_session),
@@ -340,7 +341,7 @@ def start_query_history_export(
     return {"request_id": task_id}
 
 
-@router.get("/admin/query-history/export-status")
+@router.get("/admin/query-history/export-status", tags=PUBLIC_API_TAGS)
 def get_query_history_export_status(
     request_id: str,
     _: User | None = Depends(current_admin_user),
@@ -374,7 +375,7 @@ def get_query_history_export_status(
     return {"status": TaskStatus.SUCCESS}
 
 
-@router.get("/admin/query-history/download")
+@router.get("/admin/query-history/download", tags=PUBLIC_API_TAGS)
 def download_query_history_csv(
     request_id: str,
     _: User | None = Depends(current_admin_user),

backend/ee/onyx/server/token_rate_limits/api.py

@@ -16,8 +16,9 @@
 from onyx.server.query_and_chat.token_limit import any_rate_limit_exists
 from onyx.server.token_rate_limits.models import TokenRateLimitArgs
 from onyx.server.token_rate_limits.models import TokenRateLimitDisplay
+from onyx.server.utils import PUBLIC_API_TAGS
 
-router = APIRouter(prefix="/admin/token-rate-limits")
+router = APIRouter(prefix="/admin/token-rate-limits", tags=PUBLIC_API_TAGS)
 
 
 """

backend/ee/onyx/server/user_group/api.py

@@ -21,11 +21,12 @@
 from onyx.db.engine.sql_engine import get_session
 from onyx.db.models import User
 from onyx.db.models import UserRole
+from onyx.server.utils import PUBLIC_API_TAGS
 from onyx.utils.logger import setup_logger
 
 logger = setup_logger()
 
-router = APIRouter(prefix="/manage")
+router = APIRouter(prefix="/manage", tags=PUBLIC_API_TAGS)
 
 
 @router.get("/admin/user-group")

backend/onyx/server/documents/cc_pair.py

@@ -65,6 +65,7 @@
 from onyx.server.documents.models import PaginatedReturn
 from onyx.server.documents.models import PermissionSyncAttemptSnapshot
 from onyx.server.models import StatusResponse
+from onyx.server.utils import PUBLIC_API_TAGS
 from onyx.utils.logger import setup_logger
 from onyx.utils.variable_functionality import fetch_ee_implementation_or_noop
 from shared_configs.contextvars import get_current_tenant_id
@@ -73,7 +74,7 @@
 router = APIRouter(prefix="/manage")
 
 
-@router.get("/admin/cc-pair/{cc_pair_id}/index-attempts")
+@router.get("/admin/cc-pair/{cc_pair_id}/index-attempts", tags=PUBLIC_API_TAGS)
 def get_cc_pair_index_attempts(
     cc_pair_id: int,
     page_num: int = Query(0, ge=0),
@@ -147,7 +148,7 @@ def get_cc_pair_permission_sync_attempts(
     )
 
 
-@router.get("/admin/cc-pair/{cc_pair_id}")
+@router.get("/admin/cc-pair/{cc_pair_id}", tags=PUBLIC_API_TAGS)
 def get_cc_pair_full_info(
     cc_pair_id: int,
     user: User | None = Depends(current_curator_or_admin_user),
@@ -240,7 +241,7 @@ def get_cc_pair_full_info(
     )
 
 
-@router.put("/admin/cc-pair/{cc_pair_id}/status")
+@router.put("/admin/cc-pair/{cc_pair_id}/status", tags=PUBLIC_API_TAGS)
 def update_cc_pair_status(
     cc_pair_id: int,
     status_update_request: CCStatusUpdateRequest,
@@ -414,7 +415,7 @@ def get_cc_pair_last_pruned(
     return cc_pair.last_pruned
 
 
-@router.post("/admin/cc-pair/{cc_pair_id}/prune")
+@router.post("/admin/cc-pair/{cc_pair_id}/prune", tags=PUBLIC_API_TAGS)
 def prune_cc_pair(
     cc_pair_id: int,
     user: User = Depends(current_curator_or_admin_user),
@@ -480,7 +481,7 @@ def get_docs_sync_status(
     return [DocumentSyncStatus.from_model(doc) for doc in all_docs_for_cc_pair]
 
 
-@router.get("/admin/cc-pair/{cc_pair_id}/errors")
+@router.get("/admin/cc-pair/{cc_pair_id}/errors", tags=PUBLIC_API_TAGS)
 def get_cc_pair_indexing_errors(
     cc_pair_id: int,
     include_resolved: bool = Query(False),
@@ -521,7 +522,9 @@ def get_cc_pair_indexing_errors(
     )
 
 
-@router.put("/connector/{connector_id}/credential/{credential_id}")
+@router.put(
+    "/connector/{connector_id}/credential/{credential_id}", tags=PUBLIC_API_TAGS
+)
 def associate_credential_to_connector(
     connector_id: int,
     credential_id: int,
@@ -600,7 +603,9 @@ def associate_credential_to_connector(
         raise HTTPException(status_code=500, detail="Unexpected error")
 
 
-@router.delete("/connector/{connector_id}/credential/{credential_id}")
+@router.delete(
+    "/connector/{connector_id}/credential/{credential_id}", tags=PUBLIC_API_TAGS
+)
 def dissociate_credential_from_connector(
     connector_id: int,
     credential_id: int,

backend/onyx/server/documents/connector.py

@@ -144,6 +144,7 @@
 from onyx.server.documents.models import SourceSummary
 from onyx.server.federated.models import FederatedConnectorStatus
 from onyx.server.models import StatusResponse
+from onyx.server.utils import PUBLIC_API_TAGS
 from onyx.utils.logger import setup_logger
 from onyx.utils.telemetry import mt_cloud_telemetry
 from onyx.utils.threadpool_concurrency import CallableProtocol
@@ -553,15 +554,15 @@ def _normalize_file_names_for_backwards_compatibility(
     return file_names + file_locations[len(file_names) :]
 
 
-@router.post("/admin/connector/file/upload")
+@router.post("/admin/connector/file/upload", tags=PUBLIC_API_TAGS)
 def upload_files_api(
     files: list[UploadFile],
     _: User = Depends(current_curator_or_admin_user),
 ) -> FileUploadResponse:
     return upload_files(files, FileOrigin.OTHER)
 
 
-@router.get("/admin/connector/{connector_id}/files")
+@router.get("/admin/connector/{connector_id}/files", tags=PUBLIC_API_TAGS)
 def list_connector_files(
     connector_id: int,
     user: User = Depends(current_curator_or_admin_user),
@@ -621,7 +622,7 @@ def list_connector_files(
     return ConnectorFilesResponse(files=files)
 
 
-@router.post("/admin/connector/{connector_id}/files/update")
+@router.post("/admin/connector/{connector_id}/files/update", tags=PUBLIC_API_TAGS)
 def update_connector_files(
     connector_id: int,
     files: list[UploadFile] | None = File(None),
@@ -784,7 +785,7 @@ def update_connector_files(
     )
 
 
-@router.get("/admin/connector")
+@router.get("/admin/connector", tags=PUBLIC_API_TAGS)
 def get_connectors_by_credential(
     _: User = Depends(current_curator_or_admin_user),
     db_session: Session = Depends(get_session),
@@ -817,7 +818,7 @@ def get_connectors_by_credential(
 
 
 # Retrieves most recent failure cases for connectors that are currently failing
-@router.get("/admin/connector/failed-indexing-status")
+@router.get("/admin/connector/failed-indexing-status", tags=PUBLIC_API_TAGS)
 def get_currently_failed_indexing_status(
     secondary_index: bool = False,
     user: User = Depends(current_curator_or_admin_user),
@@ -905,7 +906,7 @@ def get_currently_failed_indexing_status(
     return indexing_statuses
 
 
-@router.get("/admin/connector/status")
+@router.get("/admin/connector/status", tags=PUBLIC_API_TAGS)
 def get_connector_status(
     user: User = Depends(current_curator_or_admin_user),
     db_session: Session = Depends(get_session),
@@ -944,7 +945,7 @@ def get_connector_status(
     ]
 
 
-@router.post("/admin/connector/indexing-status")
+@router.post("/admin/connector/indexing-status", tags=PUBLIC_API_TAGS)
 def get_connector_indexing_status(
     request: IndexingStatusRequest,
     user: User = Depends(current_curator_or_admin_user),
@@ -1361,7 +1362,7 @@ def _validate_connector_allowed(source: DocumentSource) -> None:
     )
 
 
-@router.post("/admin/connector")
+@router.post("/admin/connector", tags=PUBLIC_API_TAGS)
 def create_connector_from_model(
     connector_data: ConnectorUpdateRequest,
     user: User = Depends(current_curator_or_admin_user),
@@ -1482,7 +1483,7 @@ def create_connector_with_mock_credential(
         raise HTTPException(status_code=400, detail=str(e))
 
 
-@router.patch("/admin/connector/{connector_id}")
+@router.patch("/admin/connector/{connector_id}", tags=PUBLIC_API_TAGS)
 def update_connector_from_model(
     connector_id: int,
     connector_data: ConnectorUpdateRequest,
@@ -1529,7 +1530,11 @@ def update_connector_from_model(
     )
 
 
-@router.delete("/admin/connector/{connector_id}", response_model=StatusResponse[int])
+@router.delete(
+    "/admin/connector/{connector_id}",
+    response_model=StatusResponse[int],
+    tags=PUBLIC_API_TAGS,
+)
 def delete_connector_by_id(
     connector_id: int,
     _: User = Depends(current_curator_or_admin_user),
@@ -1545,7 +1550,7 @@ def delete_connector_by_id(
         raise HTTPException(status_code=400, detail="Connector is not deletable")
 
 
-@router.post("/admin/connector/run-once")
+@router.post("/admin/connector/run-once", tags=PUBLIC_API_TAGS)
 def connector_run_once(
     run_info: RunConnectorRequest,
     _: User = Depends(current_curator_or_admin_user),
@@ -1699,7 +1704,7 @@ def google_drive_callback(
     return StatusResponse(success=True, message="Updated Google Drive access tokens")
 
 
-@router.get("/connector")
+@router.get("/connector", tags=PUBLIC_API_TAGS)
 def get_connectors(
     _: User = Depends(current_user),
     db_session: Session = Depends(get_session),
@@ -1714,7 +1719,7 @@ def get_connectors(
     ]
 
 
-@router.get("/indexed-sources")
+@router.get("/indexed-sources", tags=PUBLIC_API_TAGS)
 def get_indexed_sources(
     _: User | None = Depends(current_user),
     db_session: Session = Depends(get_session),
@@ -1725,7 +1730,7 @@ def get_indexed_sources(
     return IndexedSourcesResponse(sources=sources)
 
 
-@router.get("/connector/{connector_id}")
+@router.get("/connector/{connector_id}", tags=PUBLIC_API_TAGS)
 def get_connector_by_id(
     connector_id: int,
     _: User = Depends(current_user),
@@ -1759,7 +1764,7 @@ class BasicCCPairInfo(BaseModel):
     source: DocumentSource
 
 
-@router.get("/connector-status")
+@router.get("/connector-status", tags=PUBLIC_API_TAGS)
 def get_basic_connector_indexing_status(
     user: User = Depends(current_chat_accessible_user),
     db_session: Session = Depends(get_session),

backend/onyx/server/documents/credential.py

@@ -36,13 +36,14 @@
 from onyx.server.documents.private_key_types import PrivateKeyFileTypes
 from onyx.server.documents.private_key_types import ProcessPrivateKeyFileProtocol
 from onyx.server.models import StatusResponse
+from onyx.server.utils import PUBLIC_API_TAGS
 from onyx.utils.logger import setup_logger
 from onyx.utils.variable_functionality import fetch_ee_implementation_or_noop
 
 logger = setup_logger()
 
 
-router = APIRouter(prefix="/manage")
+router = APIRouter(prefix="/manage", tags=PUBLIC_API_TAGS)
 
 
 def _ignore_credential_permissions(source: DocumentSource) -> bool:

backend/onyx/server/features/persona/api.py

@@ -58,6 +58,7 @@
 from onyx.server.manage.llm.api import get_valid_model_names_for_persona
 from onyx.server.models import DisplayPriorityRequest
 from onyx.server.settings.store import load_settings
+from onyx.server.utils import PUBLIC_API_TAGS
 from onyx.utils.logger import setup_logger
 from onyx.utils.telemetry import mt_cloud_telemetry
 from shared_configs.contextvars import get_current_tenant_id
@@ -173,7 +174,7 @@ def patch_agents_display_priorities(
         raise HTTPException(status_code=403, detail=str(e))
 
 
-@admin_router.get("")
+@admin_router.get("", tags=PUBLIC_API_TAGS)
 def list_personas_admin(
     user: User | None = Depends(current_curator_or_admin_user),
     db_session: Session = Depends(get_session),
@@ -188,7 +189,7 @@ def list_personas_admin(
     )
 
 
-@admin_agents_router.get("")
+@admin_agents_router.get("", tags=PUBLIC_API_TAGS)
 def get_agents_admin_paginated(
     page_num: int = Query(0, ge=0, description="Page number (0-indexed)."),
     page_size: int = Query(10, ge=1, le=1000, description="Items per page."),
@@ -233,7 +234,7 @@ def get_agents_admin_paginated(
     )
 
 
-@admin_router.patch("/{persona_id}/undelete")
+@admin_router.patch("/{persona_id}/undelete", tags=PUBLIC_API_TAGS)
 def undelete_persona(
     persona_id: int,
     user: User | None = Depends(current_admin_user),
@@ -266,7 +267,7 @@ def upload_file(
 """Endpoints for all"""
 
 
-@basic_router.post("")
+@basic_router.post("", tags=PUBLIC_API_TAGS)
 def create_persona(
     persona_upsert_request: PersonaUpsertRequest,
     user: User | None = Depends(current_user),
@@ -294,7 +295,7 @@ def create_persona(
 # NOTE: This endpoint cannot update persona configuration options that
 # are core to the persona, such as its display priority and
 # whether or not the assistant is a built-in / default assistant
-@basic_router.patch("/{persona_id}")
+@basic_router.patch("/{persona_id}", tags=PUBLIC_API_TAGS)
 def update_persona(
     persona_id: int,
     persona_upsert_request: PersonaUpsertRequest,
@@ -399,7 +400,7 @@ def share_persona(
             )
 
 
-@basic_router.delete("/{persona_id}")
+@basic_router.delete("/{persona_id}", tags=PUBLIC_API_TAGS)
 def delete_persona(
     persona_id: int,
     user: User | None = Depends(current_user),
@@ -432,7 +433,7 @@ def list_personas(
     return personas
 
 
-@agents_router.get("")
+@agents_router.get("", tags=PUBLIC_API_TAGS)
 def get_agents_paginated(
     page_num: int = Query(0, ge=0, description="Page number (0-indexed)."),
     page_size: int = Query(10, ge=1, le=1000, description="Items per page."),
@@ -480,7 +481,7 @@ def get_agents_paginated(
     )
 
 
-@basic_router.get("/{persona_id}")
+@basic_router.get("/{persona_id}", tags=PUBLIC_API_TAGS)
 def get_persona(
     persona_id: int,
     user: User | None = Depends(current_limited_user),