Modified generator to generate api deprecation warnings (opensearch-p…

…roject#527) Signed-off-by: saimedhi <[email protected]> Signed-off-by: roma2023 <[email protected]>
roma2023 · Dec 28, 2023 · 2f42f68 · 2f42f68
1 parent 36df6e8
commit 2f42f68
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/utils/generate-api.py b/utils/generate-api.py
@@ -263,6 +263,7 @@ def __init__(self, namespace, name, definition, is_pyi=False):
         self.description = ""
         self.doc_url = ""
         self.stability = self._def.get("stability", "stable")
+        self.deprecation_message = self._def.get("deprecation_message")
 
         if isinstance(definition["documentation"], str):
             self.doc_url = definition["documentation"]
@@ -560,6 +561,9 @@ def read_modules():
                     documentation = {"description": z["description"]}
                     api.update({"documentation": documentation})
 
+                if "deprecation_message" not in api and "x-deprecation-message" in z:
+                    api.update({"deprecation_message": z["x-deprecation-message"]})
+
                 if "params" not in api and "params" in z:
                     api.update({"params": z["params"]})
 

diff --git a/utils/templates/base b/utils/templates/base
@@ -28,6 +28,10 @@
         {% endfor %}
         {% endif %}
         """
+        {% if api.deprecation_message %}
+        from warnings import warn
+        warn("Deprecated: {{ api.deprecation_message }}")
+        {% endif %}
         {% include "substitutions" %}
         {% include "required" %}
         {% if api.body.serialize == "bulk" %}