mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-03 09:53:45 +00:00
e3cb8ed74a
Removes the need for the strong_typing and pyopenapi packages and purely
use Pydantic for schema generation.
Our generator now purely relies on Pydantic and FastAPI, it is available
at `scripts/fastapi_generator.py`, you can run it like so:
```
uv run ./scripts/run_openapi_generator.sh
```
The generator will:
* Generate the deprecated, experimental, stable and combined specs
* Validate all the spec it generates against OpenAPI standards
A few changes in the schema required for oasdiff some updates so I've
made the following ignore rules. The new Pydantic-based generator is
likely more correct and follows OpenAPI standards better than the old
pyopenapi generator. Instead of trying to make the new generator match
the old one's quirks, we should focus on what's actually correct
according to OpenAPI standards.
These are non-critical changes:
* response-property-became-nullable: Backward compatible:
existing non-null values still work, now also accepts null
* response-required-property-removed: oasdiff reports a false
positive because it doesn't resolve $refs inside anyOf; we could use
tool like 'redocly' to flatten the schema to a single file.
* response-property-type-changed: properties are still object
types, but oasdiff doesn't resolve $refs, so it flags the missing
inline type: object even though the referenced schemas define type:
object
* request-property-one-of-removed: These are false positives
caused by schema restructuring (wrapping in anyOf for nullability,
using -Input variants, or simplifying nested oneOf structures)
that don't change the actual API contract - the same data types are
still accepted, just represented differently in the schema.
* request-parameter-enum-value-removed: These are false
positives caused by oasdiff not resolving $refs - the enum values
(asc, desc, assistants, batch) are still present in the referenced
schemas (Order and OpenAIFilePurpose), just represented via schema
references instead of inline enums.
* request-property-enum-value-removed: this is a false positive caused
by oasdiff not resolving $refs - the enum values (llm, embedding,
rerank) are still present in the referenced ModelType schema,
just represented via schema reference instead of inline enums.
* request-property-type-changed: These are schema quality issues
where type information is missing (due to Any fallback in dynamic
model creation), but the API contract remains unchanged -
properties still exist with correct names and defaults, so the same
requests will work.
* response-body-type-changed: These are false positives caused
by schema representation changes (from inferred/empty types to
explicit $ref schemas, or vice versa) - the actual response types
an API contract remain unchanged, just how they're represented in the
OpenAPI spec.
* response-media-type-removed: This is a false positive caused
by FastAPI's OpenAPI generator not documenting union return types with
AsyncIterator - the streaming functionality with text/event-stream
media type still works when stream=True is passed, it's just not
reflected in the generated OpenAPI spec.
* request-body-type-changed: This is a schema correction - the
old spec incorrectly represented the request body as an object, but
the function signature shows chunks: list[Chunk], so the new spec
correctly shows it as an array, matching the actual API
implementation.
Signed-off-by: Sébastien Han <seb@redhat.com>
|
||
|---|---|---|
| .. | ||
| backward-compat.yml | ||
| changelog.yml | ||
| conformance.yml | ||
| install-script-ci.yml | ||
| integration-auth-tests.yml | ||
| integration-sql-store-tests.yml | ||
| integration-tests.yml | ||
| integration-vector-io-tests.yml | ||
| pre-commit.yml | ||
| providers-build.yml | ||
| providers-list-deps.yml | ||
| python-build-test.yml | ||
| README.md | ||
| record-integration-tests.yml | ||
| semantic-pr.yml | ||
| stainless-builds.yml | ||
| stale_bot.yml | ||
| test-external-provider-module.yml | ||
| test-external.yml | ||
| ui-unit-tests.yml | ||
| unit-tests.yml | ||
Llama Stack CI
Llama Stack uses GitHub Actions for Continuous Integration (CI). Below is a table detailing what CI the project includes and the purpose.
| Name | File | Purpose |
|---|---|---|
| Backward Compatibility Check | backward-compat.yml | Check backward compatibility for run.yaml configs |
| Update Changelog | changelog.yml | Creates PR for updating the CHANGELOG.md |
| API Conformance Tests | conformance.yml | Run the API Conformance test suite on the changes. |
| Installer CI | install-script-ci.yml | Test the installation script |
| Integration Auth Tests | integration-auth-tests.yml | Run the integration test suite with Kubernetes authentication |
| SqlStore Integration Tests | integration-sql-store-tests.yml | Run the integration test suite with SqlStore |
| Integration Tests (Replay) | integration-tests.yml | Run the integration test suites from tests/integration in replay mode |
| Vector IO Integration Tests | integration-vector-io-tests.yml | Run the integration test suite with various VectorIO providers |
| Pre-commit | pre-commit.yml | Run pre-commit checks |
| Test Llama Stack Build | providers-build.yml | Test llama stack build |
| Test llama stack list-deps | providers-list-deps.yml | Test llama stack list-deps |
| Python Package Build Test | python-build-test.yml | Test building the llama-stack PyPI project |
| Integration Tests (Record) | record-integration-tests.yml | Run the integration test suite from tests/integration |
| Check semantic PR titles | semantic-pr.yml | Ensure that PR titles follow the conventional commit spec |
| Stainless SDK Builds | stainless-builds.yml | Build Stainless SDK from OpenAPI spec changes |
| Close stale issues and PRs | stale_bot.yml | Run the Stale Bot action |
| Test External Providers Installed via Module | test-external-provider-module.yml | Test External Provider installation via Python module |
| Test External API and Providers | test-external.yml | Test the External API and Provider mechanisms |
| UI Tests | ui-unit-tests.yml | Run the UI test suite |
| Unit Tests | unit-tests.yml | Run the unit test suite |