docs: Document generated Client attributes.

Author: dbanty

end_to_end_tests/golden-record/my_test_api_client/client.py

@@ -6,7 +6,19 @@
 
 @attr.s(auto_attribs=True)
 class Client:
-    """A class for keeping track of data related to the API"""
+    """A class for keeping track of data related to the API
+
+    Attributes:
+        base_url: The base URL for the API, all requests are made to a relative path to this URL
+        cookies: A dictionary of cookies to be sent with every request
+        headers: A dictionary of headers to be sent with every request
+        timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if
+            this is exceeded.
+        verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+            but can be set to False for testing purposes.
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatusException if the API returns a
+            status code that was not documented in the source OpenAPI document.
+    """
 
     base_url: str
     cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)

integration-tests/integration_tests/client.py

@@ -6,7 +6,19 @@
 
 @attr.s(auto_attribs=True)
 class Client:
-    """A class for keeping track of data related to the API"""
+    """A class for keeping track of data related to the API
+
+    Attributes:
+        base_url: The base URL for the API, all requests are made to a relative path to this URL
+        cookies: A dictionary of cookies to be sent with every request
+        headers: A dictionary of headers to be sent with every request
+        timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if
+            this is exceeded.
+        verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+            but can be set to False for testing purposes.
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatusException if the API returns a
+            status code that was not documented in the source OpenAPI document.
+    """
 
     base_url: str
     cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)

openapi_python_client/templates/README.md.jinja

@@ -61,6 +61,9 @@ client = AuthenticatedClient(
 )
 ```
 
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the
+docstring on that class for more info.
+
 Things to know:
 1. Every path/method combo becomes a Python module with four functions:
     1. `sync`: Blocking request that returns parsed data (if successful) or `None`

openapi_python_client/templates/client.py.jinja

@@ -4,7 +4,19 @@ import attr
 
 @attr.s(auto_attribs=True)
 class Client:
-    """ A class for keeping track of data related to the API """
+    """ A class for keeping track of data related to the API
+
+    Attributes:
+        base_url: The base URL for the API, all requests are made to a relative path to this URL
+        cookies: A dictionary of cookies to be sent with every request
+        headers: A dictionary of headers to be sent with every request
+        timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if
+            this is exceeded.
+        verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+            but can be set to False for testing purposes.
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatusException if the API returns a
+            status code that was not documented in the source OpenAPI document.
+    """
 
     base_url: str
     cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)