phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-10-04 12:07:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: adding supplementary markdown content to API specs (#3632)
Some checks failed
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 1s
Details
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 1s
Details
Test External Providers Installed via Module / test-external-providers-from-module (venv) (push) Has been skipped
Details
Integration Tests (Replay) / Integration Tests (, , , client=, ) (push) Failing after 2s
Details
Python Package Build Test / build (3.13) (push) Failing after 2s
Details
Python Package Build Test / build (3.12) (push) Failing after 3s
Details
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 6s
Details
Vector IO Integration Tests / test-matrix (push) Failing after 4s
Details
API Conformance Tests / check-schema-compatibility (push) Successful in 8s
Details
Test External API and Providers / test-external (venv) (push) Failing after 5s
Details
Unit Tests / unit-tests (3.12) (push) Failing after 5s
Details
Unit Tests / unit-tests (3.13) (push) Failing after 4s
Details
UI Tests / ui-tests (22) (push) Successful in 45s
Details
Pre-commit / pre-commit (push) Successful in 1m27s
Details

Browse source 
# What does this PR do?

Adds supplementary static content to root API spec pages. This is useful for giving context behind a specific API group, adding information on supported features or work in progress, etc.

This PR introduces supplementary information for Agents (experimental, deprecated) and Responses (stable) APIs.

<!-- Provide a short summary of what this PR does and why. Link to relevant issues if applicable. -->

<!-- If resolving an issue, uncomment and update the line below -->

<!-- Closes #[issue-number] -->

## Test Plan

Documentation server renders rich static content for the Agents API group:

![image.png](https://app.graphite.dev/user-attachments/assets/fc521619-0320-4a22-9409-8ee3fb57ed0e.png)

<!-- Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.* -->
This commit is contained in:
Alexey Rybak 2025-10-01 10:15:30 -07:00 • committed by GitHub
parent b6a5bccadf
commit 28bbbcf2c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 381 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/supplementary/deprecated/agents-api.md Normal file
View file

@ -0,0 +1,9 @@
## Deprecated APIs
> **⚠️ DEPRECATED**: These APIs are provided for migration reference and will be removed in future versions. Not recommended for new projects.
### Migration Guidance
If you are using deprecated versions of the Agents or Responses APIs, please migrate to:
- **Responses API**: Use the stable v1 Responses API endpoints