From cc712dbade83bdc4becf83872a964b8a1061707e Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Wed, 2 Feb 2022 17:45:19 +0100 Subject: [PATCH] api_docs: Add check for extra `additionalProperties` in return vals. Adds a check for `additionalProperties: true` when there are no properties listed in the schema. This currently only happens in one place, but will be helpful for deduplicating text between the `register-queue` and `get-events` endpoints. --- zerver/lib/markdown/api_return_values_table_generator.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/zerver/lib/markdown/api_return_values_table_generator.py b/zerver/lib/markdown/api_return_values_table_generator.py index 0834ec2f83..360387f8b2 100644 --- a/zerver/lib/markdown/api_return_values_table_generator.py +++ b/zerver/lib/markdown/api_return_values_table_generator.py @@ -157,6 +157,15 @@ class APIReturnValuesTablePreprocessor(Preprocessor): return_values[return_value]["additionalProperties"]["properties"], spacing + 8, ) + elif return_values[return_value]["additionalProperties"].get( + "additionalProperties", False + ): + ans += self.render_table( + return_values[return_value]["additionalProperties"]["additionalProperties"][ + "properties" + ], + spacing + 8, + ) if ( "items" in return_values[return_value] and "properties" in return_values[return_value]["items"]