From c9f0bebcb70d5a5d617d3aefaf3e78e9bdd4e443 Mon Sep 17 00:00:00 2001 From: Alexey Rybak <50731695+reluctantfuturist@users.noreply.github.com> Date: Fri, 17 Oct 2025 10:17:58 -0700 Subject: [PATCH] chore: update API leveling docs with deprecation flag (#3837) # What does this PR do? Adds information on the `deprecated=True` flags to the documentation for extra clarity. ## Test Plan * Manual testing --- docs/docs/concepts/apis/api_leveling.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/concepts/apis/api_leveling.mdx b/docs/docs/concepts/apis/api_leveling.mdx index e3e118d0f..fec65235a 100644 --- a/docs/docs/concepts/apis/api_leveling.mdx +++ b/docs/docs/concepts/apis/api_leveling.mdx @@ -62,6 +62,10 @@ The new `/v2` API must be introduced alongside the existing `/v1` API and run in When a `/v2` API is introduced, a clear and generous deprecation policy for the `/v1` API must be published simultaneously. This policy must outline the timeline for the eventual removal of the `/v1` API, giving users ample time to migrate. +### Deprecated APIs + +Deprecated APIs are those that are no longer actively maintained or supported. Depreated APIs are marked with the flag `deprecated = True` in the OpenAPI spec. These APIs will be removed in a future release. + ### API Stability vs. Provider Stability The leveling introduced in this document relates to the stability of the API and not specifically the providers within the API.