Function search_repositories

openhands/app_server/git/git_router.py:103–197

Get or search repositories. If query is provided, searches repositories across the git provider. If query is not provided, returns a paginated list of the authenticated user's repositories.

(
    provider: ProviderType,
    query: Annotated[
        str | None,
        Query(
            title='Search query for finding repositories. If not provided, returns user repositories.'
        ),
    ] = None,
    installation_id: Annotated[
        str | None,
        Query(title='Filter by installation/app ID'),
    ] = None,
    page_id: Annotated[
        str | None,
        Query(title='Optional next_page_id from the previously returned page'),
    ] = None,
    limit: Annotated[
        int,
        Query(title='The max number of results in the page', gt=0, le=100),
    ] = 100,
    sort_order: Annotated[
        SortOrder | None,
        Query(title='Sort order for search results (e.g., stars-desc, forks-asc)'),
    ] = None,
    user_context: UserContext = user_context_dependency,
)

@router.get('/repositories/search')
async def search_repositories(
    provider: ProviderType,
    query: Annotated[
        str | None,
        Query(
            title='Search query for finding repositories. If not provided, returns user repositories.'
        ),
    ] = None,
    installation_id: Annotated[
        str | None,
        Query(title='Filter by installation/app ID'),
    ] = None,
    page_id: Annotated[
        str | None,
        Query(title='Optional next_page_id from the previously returned page'),
    ] = None,
    limit: Annotated[
        int,
        Query(title='The max number of results in the page', gt=0, le=100),
    ] = 100,
    sort_order: Annotated[
        SortOrder | None,
        Query(title='Sort order for search results (e.g., stars-desc, forks-asc)'),
    ] = None,
    user_context: UserContext = user_context_dependency,
) -> RepositoryPage:
    """Get or search repositories.

    If query is provided, searches repositories across the git provider.
    If query is not provided, returns a paginated list of the authenticated user's repositories.
    """
    # Get provider tokens from user context
    provider_tokens = await user_context.get_provider_tokens()
    if not provider_tokens:
        raise HTTPException(
            status_code=status.HTTP_403_FORBIDDEN,  # 403 not 401 to avoid frontend logout
            detail='Git provider token required (such as GitHub).',
        )

    user_id = await user_context.get_user_id()
    # Cast to the expected type since we validated provider_tokens exists
    typed_provider_tokens: PROVIDER_TOKEN_TYPE = provider_tokens  # type: ignore[assignment]
    client = ProviderHandler(
        provider_tokens=MappingProxyType(typed_provider_tokens),
        external_auth_id=user_id,
    )

    page = 1
    decoded_page_id = decode_page_id(page_id)
    if decoded_page_id is not None:
        page = decoded_page_id

    # If query is provided, use search; otherwise get user's repositories
    if query:
        # Parse sort_order into sort and order components (if provided)
        if sort_order:
            search_sort, order = sort_order.value.rsplit('-', 1)
        else: