clarify failure behavior on CNA API errors

Signed-off-by: Gerd Oberlechner <[email protected]>
app-sre · Dec 20, 2022 · 443690b · 443690b
1 parent a577a1c
commit 443690b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/reconcile/cna/client.py b/reconcile/cna/client.py
@@ -18,6 +18,9 @@ class CNAClient:
     """
     Client used to interact with CNA. CNA API doc can be found here:
     https://gitlab.cee.redhat.com/service/cna-management/-/blob/main/openapi/openapi.yaml#/
+
+    All HTTP errors while communicating with the CNA API are raised
+    as a `requests.exceptions.HTTPError`.
     """
 
     def __init__(self, ocm_client: OCMBaseClient, init_metadata: bool = False):