traversys · codefitz · Dec 9, 2025 · Dec 9, 2025 · Dec 9, 2025 · Dec 9, 2025
diff --git a/AGENTS b/AGENTS
@@ -0,0 +1,17 @@
+Repository: Tideway (BMC Discovery API client)
+
+Mission
+- Add or adjust API helpers using the top-level REST wrappers in `tideway/main.py` (`Appliance.get/post/patch/put/delete`). Do not call `requests` or `discoRequests` directly from feature modules, except the explicit non-standard schema endpoints (`/about`, swagger/openapi) which are intentionally direct in `main.py`.
+- Preserve parameter handling: set `self.params[...]` before calling a wrapper; the appliance layer resets params after each request.
+- Maintain existing deprecation warnings; when adding aliases, warn with `DeprecationWarning` and point to the preferred helper.
+
+Uploads and special payloads
+- Use `Appliance.post(..., files=..., content_type=...)` for multipart uploads (TKU/knowledge, Kerberos keytabs/ccaches). Do not reintroduce `discoRequests` helpers in new code.
+- When a response needs a specific MIME type (e.g., licensing CSV/raw), pass `response="application/zip"` or similar via the wrapper.
+
+Style and safety
+- Keep code ASCII-only unless the file already uses Unicode. Keep comments minimal and clarifying, not redundant.
+- Do not remove or overwrite user changes; avoid destructive git commands.
+
+Validation
+- Preferred quick check: `python3 -m compileall tideway`.
diff --git a/README.md b/README.md
@@ -6,14 +6,14 @@ Simplified Python library for BMC Discovery API Interface that makes use of the
 ```python
 >>> import tideway
 >>> tw = tideway.appliance('appliance-hostname','auth-token')
->>> tw.about().url
+>>> tw.api_about.url
 'https://appliance-hostname/api/about'
->>> tw.about().status_code
+>>> tw.api_about.status_code
 200
->>> tw.about().text
+>>> tw.api_about.text
 {
     "api_versions": [
-        "1.0","1.1","1.2","1.3","1.4","1.5","1.6","1.7","1.8","1.9","1.10","1.11","1.12","1.13","1.14"
+        "1.0","1.1","1.2","1.3","1.4","1.5","1.6","1.7","1.8","1.9","1.10","1.11","1.12","1.13","1.14","1.15","1.16"
     ],
     "component": "REST API",
     "version":"DaaS",
@@ -30,6 +30,8 @@ Tideway removes the extra layer of manually constructing a URL and parameters fo
 
 Documentation can be found at [https://traversys.github.io/Tideway/](https://traversys.github.io/Tideway/).
 
+- Example notebook: [`notebooks/admin_api.ipynb`](https://github.com/traversys/Tideway/blob/main/notebooks/admin_api.ipynb) (download via `curl -O https://raw.githubusercontent.com/traversys/Tideway/main/notebooks/admin_api.ipynb`)
+
 ## Installation
 
 - Tideway can be installed via PyPI:
@@ -38,7 +40,7 @@ Documentation can be found at [https://traversys.github.io/Tideway/](https://tra
 $ python -m pip install tideway
 ```
 
-- Tideway supports BMC Discovery 11.3+, API v1.0-1.14 using Python 3.
+- Tideway supports BMC Discovery 11.3+, API v1.0-1.16 using Python 3.
 
 ## Releases
 
@@ -50,4 +52,5 @@ $ python -m pip install tideway
 | 0.1.4   | Search bulk update        | Discovery 12.3 (21.3) enforces strict case for "Bearer" header - api calls will not current work. | Now includes headers for non-formatted search. |
 | 0.1.5   | Updated to support Discovery 12.3 (API version 1.3) | - Missing 'complete' parameter option on graphNode() function. | - Fixed issue with Bearer capitalisation.<br>- Search Bulk will now return the full response on failure |
 | 0.2.0   | Updated to include Kerberos, Models and Taxonomy endpoints.<br><br>Added new high level generic endpoint function calls<br><br>Refactored function names/decorators to match API endpoints as close as possible.<br><br>Supports Discovery 22.2 (12.5) (API version 1.5) and Outpost API version 1.0 | Project missing tkinter module: https://github.com/traversys/Tideway/issues/15 | Added 'complete' parameter to `get_data_nodes_graph()` (replaces `graphNode()`) |
-| 0.2.1   | Added `complete` flag for graph calls, bug fixes to pagination and default focus.<br><br>Can retrieve condition templates without an ID.<br><br>Kerberos realm detection fixed and parameters are reset after each request.<br><br>Removed unused Tkinter library.<br><br>Updated to support API version 1.14 | May not work with all new endpoints. | | Issue: https://github.com/traversys/Tideway/issues/15 |
+| 0.2.1   | Added `complete` flag for graph calls, bug fixes to pagination and default focus.<br><br>Can retrieve condition templates without an ID.<br><br>Kerberos realm detection fixed and parameters are reset after each request.<br><br>Removed unused Tkinter library.<br><br>Updated to support API version 1.14 | May not work with all new endpoints. | | Issue: https://github.com/traversys/Tideway/issues/15 |
+| 0.3.0   | Removed deprecated helper aliases and routed all modules through the top-level REST wrappers.<br><br>Documentation refreshed to reflect the lean API surface. | | Deprecated helper functions removed; docs and examples updated. |
diff --git a/docs/endpoints/admin.md b/docs/endpoints/admin.md
@@ -52,45 +52,34 @@ Example:
 {'api_versions': ['1.0', '1.1', '1.2'], 'component': 'REST API', 'product': 'BMC Discovery', 'version': '12.2'}
 ```
 
-## baseline()
+## get_admin_licensing
 
-[Deprecated] See [get_admin_baseline](#get_admin_baseline) for usage.
+Get the latest signed licensing report (plain text by default).
 
-Syntax: `.baseline()`
-
-## about()
-
-[Deprecated] See [get_admin_about](#get_admin_about) for usage.
-
-Syntax: `.about()`
+Syntax:
 
-## licensing()
+```
+.get_admin_licensing
+```
 
-Get the latest signed licensing report.
+## get_admin_licensing_csv
 
-- CSV option returns raw license data in CSV format as a zip file for offline analysis.
-- RAW option return an encrypted raw license object for import to another appliance.
+Get the latest raw license data in CSV format as a zip file for offline analysis.
 
 Syntax:
 
 ```
-.licensing([ _content_type_ ])
+.get_admin_licensing_csv
 ```
 
-| Parameters   | Type   | Required | Default Value | Options |
-| ------------ | ------ | :------: | ------------- | ------- | 
-| content_type | String | No       | "text/plain"  | <ul><li>"text/plain"</li><li>"csv"</li><li>"raw"</li></ul>
+## get_admin_licensing_raw
 
-Example:
-```python
->>> tw.licensing()
------BEGIN LICENSE REPORT-----
-License report
-==============
+Get the latest license data as an encrypted raw license object for import to another appliance.
+
+Syntax:
 
-Report start time: 2021-01-18 23:00:00.409987+00:00
-Report end time  : 2021-01-21 23:00:00.410085+00:00
-...
+```
+.get_admin_licensing_raw
 ```
 
 ## get_admin_instance
@@ -217,4 +206,4 @@ Example:
 {
     ...
 }
-```
+```
diff --git a/docs/endpoints/appliance.md b/docs/endpoints/appliance.md
@@ -355,59 +355,6 @@ Example:
 
 ```
 
-## about()
-
-[Deprecated] See [api_about](#api_about) for usage.
-
-Syntax: `.about()`
-
-## admin()
-
-[Deprecated] See [get_admin_about](#get_admin_about) for usage.
-
-Syntax: `.admin()`
-
-## swagger()
-
-[Deprecated] See [api_swagger](#api_swagger) for usage.
-
-Syntax: `.swagger()`
-
-## baseline()
-
-[Deprecated] See [get_admin_baseline](#get_admin_baseline) for usage.
-
-Syntax: `.baseline()`
-
-## licensing()
-
-Get the latest signed licensing report.
-
-- CSV option returns raw license data in CSV format as a zip file for offline analysis.
-- RAW option return an encrypted raw license object for import to another appliance.
-
-Syntax:
-
-```
-.licensing([ _content_type_ ])
-```
-
-| Parameters   | Type   | Required | Default Value | Options |
-| ------------ | ------ | :------: | ------------- | ------- | 
-| content_type | String | No       | "text/plain"  | <ul><li>"text/plain"</li><li>"csv"</li><li>"raw"</li></ul>
-
-Example:
-```python
->>> tw.licensing()
------BEGIN LICENSE REPORT-----
-License report
-==============
-
-Report start time: 2021-01-18 23:00:00.409987+00:00
-Report end time  : 2021-01-21 23:00:00.410085+00:00
-...
-```
-
 ## help()
 
 - Get help on specific Discovery API endpoint and function to use. Outputs full list by default.
@@ -433,4 +380,4 @@ Endpoint                      Function                          Description
 /vault/credentials/{cred_id}  updateCredential(cred_id, body)   Updates partial resources of a credential. Missing properties are left unchanged.
 /vault/credentials/{cred_id}  replaceCredential(cred_id, body)  Replaces a single credential. All required credential properties must be present.
 
-```
+```
diff --git a/docs/endpoints/data.md b/docs/endpoints/data.md
@@ -334,7 +334,7 @@ Syntax:
 
 ## get_data_partitions
 
-Graph data represents a set of nodes and relationships that are associated to the given node.
+Get names and IDs of partitions available on the appliance.
 
 Syntax:
 
@@ -359,36 +359,6 @@ Example:
 }
 ```
 
-## searchQuery()
-
-[Deprecated] See [search](#search) for usage.
-
-Syntax: `.searchQuery(__json__ [, _offset_ ] [, _results_id_ ] [, _format_ ] [, _limit_ ] [, _delete_ ])`
-
-## nodeLookup()
-
-[Deprecated] See [get_data_nodes](#get_data_nodes) for usage.
-
-Syntax: `.nodeLookup(__node_id__ [, _relationships_ ] [, _traverse_ ] [, _flags_ ])`
-
-## lookupNodeKind()
-
-[Deprecated] See [get_data_kinds](#get_data_kinds) for usage.
-
-Syntax: `.lookupNodeKind(__kind__ [, _offset_ ] [, _results_id_ ] [, _format_ ] [, _limit_ ] [, _delete_ ])`
-
-## graphNode()
-
-[Deprecated] See [get_data_nodes_graph](#get_data_nodes_graph) for usage.
-
-Syntax: `.graphNode(__node_id__ [, _focus_ ] [, _apply_rules_ ]))`
-
-## partitions()
-
-[Deprecated] See [get_data_nodes_graph](#get_data_nodes_graph) for usage.
-
-Syntax: `.partitions()`
-
 ## post_data_partitions()
 
 Create a Partition.
@@ -507,27 +477,3 @@ Syntax:
 | ------------- | ------ | :------: | ------------- | ------- |
 | consumer_name | String | Yes      | N/A           | N/A     |
 | path          | String | No       | N/A           | N/A     |
-
-## best_candidate()
-
-[Deprecated] See [post_data_candidate](#post_data_candidate) for usage.
-
-Syntax: `.post_data_candidate(__JSON__)`
-
-## top_candidates()
-
-[Deprecated] See [post_data_candidates](#post_data_candidates) for usage.
-
-Syntax: `.post_data_candidates(__json__)`
-
-## twImport()
-
-[Deprecated] See [post_data_import](#post_data_import) for usage.
-
-Syntax: `.twImport(__json__)`
-
-## twWrite()
-
-[Deprecated] See [post_data_write](#post_data_write) for usage.
-
-Syntax: `.twWrite(__json__)`
diff --git a/docs/endpoints/topology.md b/docs/endpoints/topology.md
@@ -65,24 +65,6 @@ Syntax:
 | ------------- | ----------- | :------: | ------------- | -------- |
 | json          | JSON Object | Yes      | N/A           | N/A      |
 
-## graphNode()
-
-[Deprecated] See [get_data_nodes_graph](#get_data_nodes_graph) for usage.
-
-Syntax: `.graphNode(__node_id__ [, _focus_ ] [, _apply_rules_ ])`
-
-## getNodes()
-
-[Deprecated] See [post_topology_nodes](#post_topology_nodes) for usage.
-
-Syntax: `.getNodes(__json__)`
-
-## getNodeKinds()
-
-[Deprecated] See [post_topology_nodes_kinds](#post_topology_nodes_kinds) for usage.
-
-Syntax: `.getNodeKinds(__json__)`
-
 ## get_topology_viz_state
 
 Get the current state of the visualization for the authenticated user.
@@ -106,7 +88,6 @@ Syntax:
 | ------------- | ----------- | :------: | ------------- | -------- |
 | json          | JSON Object | Yes      | N/A           | N/A      |
 
-
 ## put_topology_viz_state()
 
 Update any or all of the attributes of the current state of the visualization for the authenticated user.
@@ -119,21 +100,3 @@ put_topology_viz_state(__json__)
 | Parameters    | Type        | Required | Default Value | Options  |
 | ------------- | ----------- | :------: | ------------- | -------- |
 | json          | JSON Object | Yes      | N/A           | N/A      |
-
-## visualizationState()
-
-[Deprecated] See [get_topology_viz_state](#get_topology_viz_state) for usage.
-
-Syntax: `.visualizationState()`
-
-## updateVizState()
-
-[Deprecated] See [patch_topology_viz_state](#patch_topology_viz_state) for usage.
-
-Syntax: `.updateVizState(__json__)`
-
-## replaceVizState()
-
-[Deprecated] See [put_topology_viz_state](#put_topology_viz_state) for usage.
-
-Syntax: `.replaceVizState(__json__)`
diff --git a/docs/index.md b/docs/index.md
@@ -6,14 +6,14 @@ Simplified Python library for BMC Discovery API Interface that makes use of the
 ```python
 >>> import tideway
 >>> tw = tideway.appliance('appliance-hostname','auth-token')
->>> tw.about().url
+>>> tw.api_about.url
 'https://appliance-hostname/api/about'
->>> tw.about().status_code
+>>> tw.api_about.status_code
 200
->>> tw.about().text
+>>> tw.api_about.text
 {
     "api_versions": [
-        "1.0","1.1","1.2","1.3","1.4","1.5","1.6","1.7","1.8","1.9","1.10","1.11","1.12","1.13","1.14"
+        "1.0","1.1","1.2","1.3","1.4","1.5","1.6","1.7","1.8","1.9","1.10","1.11","1.12","1.13","1.14","1.15","1.16"
     ],
     "component": "REST API",
     "version":"DaaS",
@@ -26,6 +26,8 @@ Tideway follows BMC Discovery's well-structured and documented REST API which ca
 
 Tideway removes the extra layer of manually constructing a URL and parameters for python requests allowing you to query API supported features of Discovery seamlessly and faster than if you were to navigate via the GUI.
 
+Example notebook: [`notebooks/admin_api.ipynb`](https://github.com/traversys/Tideway/blob/main/notebooks/admin_api.ipynb) (download via `curl -O https://raw.githubusercontent.com/traversys/Tideway/main/notebooks/admin_api.ipynb`)
+
 ## Installation
 
 - Tideway can be installed via PyPI:
@@ -34,7 +36,7 @@ Tideway removes the extra layer of manually constructing a URL and parameters fo
 $ python -m pip install tideway
 ```
 
-- Tideway supports BMC Discovery 11.3+, API v1.0-1.14 using Python 3.
+- Tideway supports BMC Discovery 11.3+, API v1.0-1.16 using Python 3.
 
 ## Contents
 
@@ -51,3 +53,4 @@ $ python -m pip install tideway
 | 0.1.5   | Updated to support Discovery 12.3 (API version 1.3) | - Missing 'complete' parameter option on graphNode() function. | - Fixed issue with Bearer capitalisation.<br>- Search Bulk will now return the full response on failure |
 | 0.2.0   | Updated to include Kerberos, Models and Taxonomy endpoints.<br><br>Added new high level generic endpoint function calls<br><br>Refactored function names/decorators to match API endpoints as close as possible.<br><br>Supports Discovery 22.2 (12.5) (API version 1.5) and Outpost API version 1.0 | Project missing tkinter module: https://github.com/traversys/Tideway/issues/15 | Added 'complete' parameter to `get_data_nodes_graph()` (replaces `graphNode()`) |
 | 0.2.1   | Added `complete` flag for graph calls, bug fixes to pagination and default focus.<br><br>Can retrieve condition templates without an ID.<br><br>Kerberos realm detection fixed and parameters are reset after each request.<br><br>Removed unused Tkinter library.<br><br>Updated to support API version 1.14 | May not work with all new endpoints. | | Issue: https://github.com/traversys/Tideway/issues/15 |
+| 0.3.0   | Removed deprecated helper aliases and routed all modules through the top-level REST wrappers.<br><br>Documentation refreshed to reflect the lean API surface. | | Deprecated helper functions removed; docs and examples updated. |
diff --git a/docs/quickstart/initiation.md b/docs/quickstart/initiation.md
@@ -32,5 +32,5 @@ Upon initiation the following parameters can be used:
 | - | - | - | - | -
 | target | Required | String | | The Hostname, FQDN or IP Address of the Discovery instance.
 | token | Required | String | | The authentication token of the API user. It is not necessary to include the "bearer" pre-text.
-| api_version | | String | "1.5" | This should be the supported version of the API. Discovery 22.2 supports API versions up to 1.5 (outpost 1.0).
-| ssl_verify | | Boolean | False | Choose whether to query the API using a valid SSL certificate. If you are using self-signed HTTPS then you should leave this with the default value.
+| api_version | | String | "1.16" | This should be the supported version of the API. Discovery 25.x supports API versions up to 1.16 (outpost 1.0).
+| ssl_verify | | Boolean | False | Choose whether to query the API using a valid SSL certificate. If you are using self-signed HTTPS then you should leave this with the default value.
-| ssl_verify | | Boolean | False | Choose whether to query the API using a valid SSL certificate. If you are using self-signed HTTPS then you should leave this with the default value.
+| ssl_verify | | Boolean | True | Choose whether to verify the API's HTTPS certificate against a trusted CA bundle. For self-signed HTTPS, prefer configuring a trusted CA/certificate; only set this to `False` for exceptional, short-lived testing.
-| ssl_verify | | Boolean | False | Choose whether to query the API using a valid SSL certificate. If you are using self-signed HTTPS then you should leave this with the default value.
+| ssl_verify | | Boolean | True | Choose whether to verify the API's HTTPS certificate against a trusted CA bundle. For self-signed HTTPS, prefer configuring a trusted CA/certificate; only set this to `False` for exceptional, short-lived testing.