llama-stack-mirror

mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-12 04:50:39 +00:00

History

Sai Prashanth S cb7354a9ce docs: Add detailed docstrings to API models and update OpenAPI spec (#2889 ) 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>	2025-07-30 16:32:59 -07:00
..
__init__.py	chore: remove nested imports (#2515 )	2025-06-26 08:01:05 +05:30
vector_dbs.py	docs: Add detailed docstrings to API models and update OpenAPI spec (#2889 )	2025-07-30 16:32:59 -07:00

Sai Prashanth S cb7354a9ce

docs: Add detailed docstrings to API models and update OpenAPI spec (#2889 )

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>

2025-07-30 16:32:59 -07:00

__init__.py

chore: remove nested imports (#2515 )

2025-06-26 08:01:05 +05:30

vector_dbs.py

docs: Add detailed docstrings to API models and update OpenAPI spec (#2889 )

2025-07-30 16:32:59 -07:00