mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-12 20:12:33 +00:00
c9dfd26385
The AuthenticationMiddleware was blocking all requests without an Authorization header, including health and version endpoints that are needed by monitoring tools, load balancers, and Kubernetes probes. This commit adds a `require_authentication` parameter to the @webmethod decorator (defaults to True). Endpoints can opt out of authentication by setting `require_authentication=False`. The /health and /version endpoints now use this parameter to allow unauthenticated access. Changes: - Add `require_authentication` field to WebMethod dataclass - Update @webmethod decorator to accept `require_authentication` parameter - Mark /health and /version endpoints with `require_authentication=False` - Update middleware to check webmethod.require_authentication dynamically Closes: #3735 Signed-off-by: Derek Higgins <derekh@redhat.com>
94 lines
2.5 KiB
Python
94 lines
2.5 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
from typing import Protocol, runtime_checkable
|
|
|
|
from pydantic import BaseModel
|
|
|
|
from llama_stack.apis.version import LLAMA_STACK_API_V1
|
|
from llama_stack.providers.datatypes import HealthStatus
|
|
from llama_stack.schema_utils import json_schema_type, webmethod
|
|
|
|
|
|
@json_schema_type
|
|
class RouteInfo(BaseModel):
|
|
"""Information about an API route including its path, method, and implementing providers.
|
|
|
|
:param route: The API endpoint path
|
|
:param method: HTTP method for the route
|
|
:param provider_types: List of provider types that implement this route
|
|
"""
|
|
|
|
route: str
|
|
method: str
|
|
provider_types: list[str]
|
|
|
|
|
|
@json_schema_type
|
|
class HealthInfo(BaseModel):
|
|
"""Health status information for the service.
|
|
|
|
:param status: Current health status of the service
|
|
"""
|
|
|
|
status: HealthStatus
|
|
|
|
|
|
@json_schema_type
|
|
class VersionInfo(BaseModel):
|
|
"""Version information for the service.
|
|
|
|
:param version: Version number of the service
|
|
"""
|
|
|
|
version: str
|
|
|
|
|
|
class ListRoutesResponse(BaseModel):
|
|
"""Response containing a list of all available API routes.
|
|
|
|
:param data: List of available route information objects
|
|
"""
|
|
|
|
data: list[RouteInfo]
|
|
|
|
|
|
@runtime_checkable
|
|
class Inspect(Protocol):
|
|
"""Inspect
|
|
|
|
APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
|
|
"""
|
|
|
|
@webmethod(route="/inspect/routes", method="GET", level=LLAMA_STACK_API_V1)
|
|
async def list_routes(self) -> ListRoutesResponse:
|
|
"""List routes.
|
|
|
|
List all available API routes with their methods and implementing providers.
|
|
|
|
:returns: Response containing information about all available routes.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/health", method="GET", level=LLAMA_STACK_API_V1, require_authentication=False)
|
|
async def health(self) -> HealthInfo:
|
|
"""Get health status.
|
|
|
|
Get the current health status of the service.
|
|
|
|
:returns: Health information indicating if the service is operational.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/version", method="GET", level=LLAMA_STACK_API_V1, require_authentication=False)
|
|
async def version(self) -> VersionInfo:
|
|
"""Get version.
|
|
|
|
Get the version of the service.
|
|
|
|
:returns: Version information containing the service version number.
|
|
"""
|
|
...
|