Skip to content

Commit b44d418

Browse files
committed
Merge remote-tracking branch 'upstream/main' into leseb/remove-safety-api
Signed-off-by: Sébastien Han <seb@redhat.com>
2 parents 7c19d18 + dbd03f6 commit b44d418

2 files changed

Lines changed: 184 additions & 13 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ When modifying or extending APIs:
142142
enforces backward compatibility.
143143
4. Include a test plan with a testing script and execution output in your PR description.
144144

145+
The full stability contract — HTTP API levels (`/v1alpha`, `/v1beta`, `/v1`),
146+
the two `ogx-api` package surfaces (`ogx_api.types`, `ogx_api.provider`),
147+
config schema rules, and the data storage compatibility guarantees across
148+
Z/Y/X-stream upgrades — is documented in
149+
[`docs/docs/concepts/apis/api_leveling.mdx`](docs/docs/concepts/apis/api_leveling.mdx).
150+
Read it before adding a new API, graduating an API between levels, removing
151+
or renaming a field on a `v1` datatype, or changing on-disk storage schemas.
152+
145153
## Common Patterns
146154

147155
### Adding a new parameter to an existing API

0 commit comments

Comments
 (0)