actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Modified generator to generate 'options' and 'default value' for parameters in description (#519)

Browse Source 
Signed-off-by: saimedhi <saimedhi@amazon.com>
This commit is contained in:
Sai Medhini Reddy Maryada
2023-10-03 07:43:05 -07:00
committed by GitHub
parent 781744c6b1
commit 70db37a3c0
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
utils/generate-api.py
+7
View File
@@ -482,6 +482,10 @@ def read_modules():
for m in params:
A = dict(type=m["schema"]["type"], description=m["description"])
if "default" in m["schema"]:
A.update({"default": m["schema"]["default"]})
if "enum" in m["schema"]:
A.update({"type": "enum"})
A.update({"options": m["schema"]["enum"]})
@@ -508,6 +512,9 @@ def read_modules():
if "description" in n:
B.update({"description": n["description"]})
if "x-enum-options" in n["schema"]:
B.update({"options": n["schema"]["x-enum-options"]})
deprecated_new = {}
if "deprecated" in n:
B.update({"deprecated": n["deprecated"]})
utils/templates/base
+2 -1
View File
@@ -21,7 +21,8 @@
{% for p, info in api.params %}
{% filter wordwrap(72, wrapstring="\n ") %}
:arg {{ p }}{% if info.deprecated %} (Deprecated: {{ info['deprecation_message'][:-1] }}){% endif %}: {{ info.description }}{% if info.options %} Valid choices: {{ info.options|join(", ") }}{% endif %}{% if info.default %} Default: {{ info.default }}{% endif %}
:arg {{ p }}{% if info.deprecated %} (Deprecated: {{ info['deprecation_message'][:-1] }}){% endif %}: {{ info.description }}{% if info.options %} Valid choices: {{ info.options|join(", ") }}{% endif %}
{% if info.default is defined %}{% if info.default is not none %}{% if info.default is sameas(false) %} (default: false){% else %} (default: {{ info.default }}){% endif %}{% endif %}{% endif %}
{% endfilter %}
{% endfor %}