Enable compression in responses (#612)

* Support and document gzip accept encoding

* Enable by default

* Regenerate client from commit 7a4f3f3 of spec repo

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-10-01 10:28:40.479970",
-            "spec_repo_commit": "bc91052"
+            "regenerated": "2021-10-07 07:32:01.590429",
+            "spec_repo_commit": "7a4f3f3"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-10-01 10:29:03.830072",
-            "spec_repo_commit": "bc91052"
+            "regenerated": "2021-10-07 07:32:35.804199",
+            "spec_repo_commit": "7a4f3f3"
         }
     }
 }

.generator/templates/api_client.mustache

@@ -70,6 +70,8 @@ class ApiClient(object):
         self.default_headers = {}
         if header_name is not None:
             self.default_headers[header_name] = header_value
+        if self.configuration.compress:
+            self.default_headers["Accept-Encoding"] = "gzip"
         self.cookie = cookie
         # Set default User-Agent.
         self.user_agent = user_agent()

.generator/templates/configuration.mustache

@@ -72,8 +72,9 @@ class Configuration(object):
     :param server_operation_variables: Mapping from operation ID to a mapping with
       string values to replace variables in templated server configuration.
       The validation of enums is performed for variables with defined enum values before.
-    :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
+    :param ssl_ca_cert: The path to a file of concatenated CA certificates
       in PEM format
+    :param compress: Boolean indicating whether we accept encoding responses or not.
 
 {{#hasAuthMethods}}
     :Example:
@@ -174,6 +175,7 @@ conf = {{{packageName}}}.Configuration(
                  server_index=None, server_variables=None,
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
+                 compress=True,
                  ):
         """Constructor
         """
@@ -294,6 +296,9 @@ conf = {{{packageName}}}.Configuration(
         # Options to pass down to the underlying urllib3 socket
         self.socket_options = None
 
+        # Will translate to a Accept-Encoding header
+        self.compress = compress
+
         # Keep track of unstable operations
         self.unstable_operations = {
         {{#apiInfo}}

README.md

@@ -96,6 +96,15 @@ configuration.api_key["apiKeyAuth"] = "YOUR_API_KEY"
 configuration.api_key["appKeyAuth"] = "YOUR_APPLICATION_KEY"
 ```
 
+### Disable compressed payloads
+
+If you want to disable GZIP compressed responses, set the `compress` flag
+on your configuration object:
+
+```python
+configuration.compress = False
+```
+
 ## Author
 
 [email protected]

docs/README.md

@@ -96,6 +96,15 @@ configuration.api_key["apiKeyAuth"] = "YOUR_API_KEY"
 configuration.api_key["appKeyAuth"] = "YOUR_APPLICATION_KEY"
 ```
 
+### Disable compressed payloads
+
+If you want to disable GZIP compressed responses, set the `compress` flag
+on your configuration object:
+
+```python
+configuration.compress = False
+```
+
 ## Author
 
 [email protected]