llama-stack-mirror/docs/openapi_generator
Ashwin Bharambe 5547ef953c
feat: enhance OpenAPI spec to include Error types (#1320)
# What does this PR do?

An API spec must talk about Error handling. This was a pretty glaring
omission so far. This PR begins to address it by adding a set of
standard error responses we can attach to all our API calls.

At a future point, we can add specific error types where necessary
(although we should not hurry to do that; it is best done very late.)

## Test Plan

Checked that Stainless SDK generation succeeds.
2025-02-28 11:16:12 -08:00
..
pyopenapi feat: enhance OpenAPI spec to include Error types (#1320) 2025-02-28 11:16:12 -08:00
generate.py feat: enhance OpenAPI spec to include Error types (#1320) 2025-02-28 11:16:12 -08:00
README.md docs: Remove unused python-openapi and json-strong-typing in openapi_generator (#1167) 2025-02-19 22:06:29 -08:00
run_openapi_generator.sh Several documentation fixes and fix link to API reference 2025-02-04 14:00:43 -08:00

The RFC Specification (OpenAPI format) is generated from the set of API endpoints located in llama_stack/distribution/server/endpoints.py using the generate.py utility.

Please install the following packages before running the script:

pip install fire PyYAML llama-models

Then simply run sh run_openapi_generator.sh