paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-13 18:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

bugdown: Rename pocket to param in generate_curl_example.

Browse Source
This commit is contained in:
Vishnu Ks
2019-10-03 12:39:05 +00:00
committed by Tim Abbott
parent 1235dc3bec
commit f4e3e6068f
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
zerver/lib/bugdown/api_code_examples.py
View File

@@ -138,13 +138,13 @@ def generate_curl_example(endpoint: str, method: str,
lines.append(" -u %s:%s" % (auth_email, auth_api_key)) lines.append(" -u %s:%s" % (auth_email, auth_api_key))
openapi_example_params = get_openapi_parameters(endpoint, method) openapi_example_params = get_openapi_parameters(endpoint, method)
for packet in openapi_example_params: for param in openapi_example_params:
param_name = packet["name"] param_name = param["name"]
if param_name in exclude: if param_name in exclude:
continue continue
param_type = packet["schema"]["type"] param_type = param["schema"]["type"]
if param_type in ["object", "array"]: if param_type in ["object", "array"]:
example_value = packet.get("example", None) example_value = param.get("example", None)
if not example_value: if not example_value:
msg = """All array and object type request parameters must have msg = """All array and object type request parameters must have
concrete examples. The openAPI documentation for {}/{} is missing an example concrete examples. The openAPI documentation for {}/{} is missing an example
@@ -154,7 +154,7 @@ cURL example.""".format(endpoint, method, param_name)
ordered_ex_val_str = json.dumps(example_value, sort_keys=True) ordered_ex_val_str = json.dumps(example_value, sort_keys=True)
line = " --data-urlencode {}='{}'".format(param_name, ordered_ex_val_str) line = " --data-urlencode {}='{}'".format(param_name, ordered_ex_val_str)
else: else:
example_value = packet.get("example", DEFAULT_EXAMPLE[param_type]) example_value = param.get("example", DEFAULT_EXAMPLE[param_type])
if type(example_value) == bool: if type(example_value) == bool:
example_value = str(example_value).lower() example_value = str(example_value).lower()
line = " -d '{}={}'".format(param_name, example_value) line = " -d '{}={}'".format(param_name, example_value)