mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-08-12 04:50:39 +00:00
cb7354a9ce
This PR focuses on improving the developer experience by adding comprehensive docstrings to the API data models across the Llama Stack. These docstrings provide detailed explanations for each model and its fields, making the API easier to understand and use. **Key changes:** - **Added Docstrings:** Added reST formatted docstrings to Pydantic models in the `llama_stack/apis/` directory. This includes models for: - Agents (`agents.py`) - Benchmarks (`benchmarks.py`) - Datasets (`datasets.py`) - Inference (`inference.py`) - And many other API modules. - **OpenAPI Spec Update:** Regenerated the OpenAPI specification (`docs/_static/llama-stack-spec.yaml` and `docs/_static/llama-stack-spec.html`) to include the new docstrings. This will be reflected in the API documentation, providing richer information to users. **Impact:** - Developers using the Llama Stack API will have a better understanding of the data structures. - The auto-generated API documentation is now more informative. --------- Co-authored-by: Ashwin Bharambe <ashwin.bharambe@gmail.com>
36 lines
892 B
Python
36 lines
892 B
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 enum import Enum
|
|
from typing import Any
|
|
|
|
from pydantic import BaseModel
|
|
|
|
from llama_stack.schema_utils import json_schema_type
|
|
|
|
|
|
class Order(Enum):
|
|
"""Sort order for paginated responses.
|
|
:cvar asc: Ascending order
|
|
:cvar desc: Descending order
|
|
"""
|
|
|
|
asc = "asc"
|
|
desc = "desc"
|
|
|
|
|
|
@json_schema_type
|
|
class PaginatedResponse(BaseModel):
|
|
"""A generic paginated response that follows a simple format.
|
|
|
|
:param data: The list of items for the current page
|
|
:param has_more: Whether there are more items available after this set
|
|
:param url: The URL for accessing this list
|
|
"""
|
|
|
|
data: list[dict[str, Any]]
|
|
has_more: bool
|
|
url: str | None = None
|