api: Deprecate BaseAPI

We do not want to maintain this anymore. codesearch.o.o shows two
users.

Change-Id: Ic925fa40b099a04fa4904b894d8c54f3c8e4b6da
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

osc_lib/api/api.py

@@ -15,6 +15,7 @@
 
 import builtins
 import typing as ty
+import warnings
 
 from keystoneauth1 import exceptions as ksa_exceptions
 from keystoneauth1 import session as ksa_session
@@ -65,6 +66,12 @@ class BaseAPI:
             Keyword arguments passed to keystoneauth1.session.Session().
         """
 
+        warnings.warn(
+            'The BaseAPI class is deprecated for removal. Consider using '
+            'openstacksdk instead else vendoring this code into your client',
+            category=DeprecationWarning,
+        )
+
         super().__init__()
 
         # Create a keystoneauth1.session.Session if one is not supplied

releasenotes/notes/deprecate-BaseAPI-09abd3cb955c2bb6.yaml

@@ -0,0 +1,6 @@
+---
+deprecations:
+  - |
+    The ``osc_lib.api.api.BaseAPI`` class has been deprecated for removal.
+    Consider using ``openstacksdk`` instead or vendoring the class into
+    your client.