Skip to content

Commit

Permalink
v0.2.0
Browse files Browse the repository at this point in the history
* Merge from Main into Dev (#7)

* Update to 0.1.4

* v0.1.4
Include headers for unformatted search_bulk()

* Updated known issues

* v0.1.5_dev.01

- Updated Authorisation Bearer string for API v1.3 support
- Added check for search_bulk() and return the same response as search() in the event of failure

* v0.1.6_dev.01

- Updated default API version
- Added new property methods for data, discovery, main

* v0.1.6_dev.02

- Added requests import to modules.

* v0.2.0_alpha.01

- Updated GH readme
- Added endpoints for kerberos, models, taxonomy
- Added property decorators to function calls, alternative function names
- Updated graph node method to include 'complete' parameter
- Added direct endpoint call methods (to allow for some future proofing - if needed)
- Updated help docs
- Added /data/condition endpoints
- Added /data/partitions POST method
- Added /discovery/excludes endpoints
- Added /discovery/runs/scheduled endpoints
- Updated help docs to output fancy_grid when no filter is applied

* v0.2.0_alpha.02

- Fixed responses on admin functions
- Updated some inaccurate descriptions
- Documentation updated with new versions and functions
  • Loading branch information
codefitz committed Jul 12, 2022
1 parent f16f4dc commit 80b8ad3
Show file tree
Hide file tree
Showing 32 changed files with 2,567 additions and 383 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ Simplified Python library for BMC Discovery API Interface that makes use of the
"api_versions": [
"1.0",
"1.1",
"1.2"
"1.2",
"1.3",
"1.4",
"1.5"
],
"component": "REST API",
"product": "BMC Discovery",
"version": "12.2"
"version": "12.5"
}
```

Expand All @@ -33,11 +36,11 @@ Documentation can be found at [https://traversys.github.io/Tideway/](https://tra

## Releases

| Version | Summary | Known Issues | Fixed |
| :-----: | ------------------------------------------------------ | -------------------------------------------------------------- | ------------------------------ |
| 0.1.0 | Initial release, compatible with API v1.1 | | |
| 0.1.1 | Updated to API v1.2<br>Added `help()`, `search_bulk()` | search call retains last parameters for `offset`, `results_id` | |
| 0.1.2 | Bug Fixes | Bulk search with larger limit than dataset will fail on missing `next_offset` | Fixed issue with `offset` and `results_id` values<br>Fixed issue with bulk search parameter lower limit. |
| 0.1.3 | Bug Fixes | | Added check for `next_offset`. |
| 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) | | Fixed issue with Bearer capitalisation.<br>Search Bulk will now return the full response on failure |
| Version | Summary | Known Issues | Fixed |
| :-----: | ------------------------- | -------------------------------------------------- | -------------------------------- |
| 0.1.1 | - Updated to API v1.2<br>- Added `help()`, `search_bulk()` | search call retains last parameters for `offset`, `results_id` | |
| 0.1.2 | Bug Fixes | Bulk search with larger limit than dataset will fail on missing `next_offset` | - Fixed issue with `offset` and `results_id` values<br>- Fixed issue with bulk search parameter lower limit. |
| 0.1.3 | Bug Fixes | | Added check for `next_offset`. |
| 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 | Not all new unctions have been tested. | Added 'complete' parameter to `get_data_nodes_graph()` (replaces `graphNode()`) |
30 changes: 21 additions & 9 deletions docs/endpoints/admin.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sort: 9
sort: 1
---

# Admin
Expand All @@ -16,42 +16,54 @@ Initiation:

```python
>>> import tideway
>>> tw = tideway.admin('appliance-hostname','auth-token')
>>> tw = tideway.admin('hostname','auth-token')
```

## baseline()
## get_admin_baseline

- Get a summary of the appliance status, and details of which baseline checks have passed or failed.
Get a summary of the appliance status, and details of which baseline checks have passed or failed.

Syntax:

```
.baseline()
.get_admin_baseline
```

Example:

```python
>>> tw.baseline().json()['results']['FAILED'][0]
>>> tw.get_admin_baseline.json()['results']['FAILED'][0]
{'enabled': True, 'message': 'MAJOR: This appliance has insufficent resources', 'name': 'Appliance Specification', 'severity': 'MAJOR'}
```

## about()
## get_admin_about

Get the versions of the API supported by a BMC Discovery version.

Syntax:

```
.about()
.get_admin_about
```

Example:
```python
>>> tw.about().json()
>>> tw.get_admin_about.json()
{'api_versions': ['1.0', '1.1', '1.2'], 'component': 'REST API', 'product': 'BMC Discovery', 'version': '12.2'}
```

## baseline()

[Deprecated] See [get_admin_baseline](#get_admin_baseline) for usage.

Syntax: `.baseline()`

## about()

[Deprecated] See [get_admin_about](#get_admin_about) for usage.

Syntax: `.about()`

## licensing()

Get the latest signed licensing report.
Expand Down
Loading

0 comments on commit 80b8ad3

Please sign in to comment.