Migrate OpenRouter catalog assets to keyed configuration
This commit is contained in:
20
README.md
20
README.md
@@ -6,7 +6,7 @@ credentials, or make network requests.
|
||||
|
||||
Promptkit owns catalog parsing, validation, runtime behavior, credential
|
||||
handling, and consumer documentation. This module owns the OpenRouter backend
|
||||
manifest and its maintained profile data. Consumers should use versions chosen
|
||||
definition and its maintained profile data. Consumers should use versions chosen
|
||||
by their Promptkit release rather than treating this module as a standalone
|
||||
runtime integration.
|
||||
|
||||
@@ -16,17 +16,25 @@ and documentation.
|
||||
|
||||
## Compatibility
|
||||
|
||||
This compatibility policy applies to the `/v2` module. Catalog profiles track
|
||||
This compatibility policy applies to the `/v3` module. Catalog profiles track
|
||||
upstream availability and may be added, removed, renamed, or modified without
|
||||
deprecation or advance notice. Consumers that need a particular profile set
|
||||
should use the catalog version selected by their Promptkit release.
|
||||
|
||||
Backend definitions, the exported Go API, and the catalog manifest schema do
|
||||
Backend definitions, the exported Go API, and the catalog asset format do
|
||||
not share that profile-data exception. Their compatibility follows the normal
|
||||
semantic-versioning rules. Published v1 releases retain their historical
|
||||
contract; this README does not retroactively alter it.
|
||||
semantic-versioning rules. Published v1 and `/v2` releases retain their historical
|
||||
contracts; this README does not retroactively alter them.
|
||||
|
||||
Catalog releases use dated versions in the form `v2.YYYYMMDD.N`. The date
|
||||
The `/v3` module replaces the `/v2` manifest and flat profile documents with
|
||||
ordinary keyed ConfigKit inputs: `catalog/backend.yml` defines
|
||||
`backends.openrouter`, and each file under `catalog/profiles/` defines one
|
||||
literal ID beneath `profiles`. Profile inheritance uses `extends` instead of
|
||||
`base_profile`. This asset-format change is incompatible with `/v2` consumers;
|
||||
they should remain on a published `/v2` version. The exported `FS` and `Root`
|
||||
remain the asset access surface.
|
||||
|
||||
Catalog releases use dated versions in the form `v3.YYYYMMDD.N`. The date
|
||||
identifies when the catalog snapshot was published in UTC; it does not certify
|
||||
that a provider currently offers a model or endpoint named by the data.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user