Skip to content

Commit 15afbf6

Browse files
authored
Deprecate Hub Instance
Many of the new issues an outstanding issues relate to Hub Instance which we have previously discussed deprecating in favour of the client interface. Instead of forcing a hard switch, I'm proposing that we instead opt for a phased approach, starting with our examples directory: * Any new or modified examples/scripts should make use of the client interface, * Any issues related to examples/scripts using Hub Instance should be closed as `Won't Fix`
1 parent c607c77 commit 15afbf6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ In v2022.2 of Black Duck the REST API introduced a max page size to protect syst
88

99
**The old HubInstance interface and many of the examples using it do not perform paging and will break as a result of the changes in v2022.2**.
1010

11+
Any issues related to the HubInstance Interface will be closed as *Won't Fix*
12+
13+
Any PRs with new or modified example scripts/utilities **must** use the client interface.
14+
1115
# New in 1.0.0
1216

1317
Introducing the new Client class.
@@ -61,6 +65,8 @@ for project in bd.get_resource(name='projects'):
6165

6266
Example code showing how to work with the new Client can be found in the *examples/client* folder.
6367

68+
**Examples which use the old HubInstance interface -which is not maintained- are not guaranteed to work. Use at your own risk.**
69+
6470
# Test #
6571
Using [pytest](https://pytest.readthedocs.io/en/latest/contents.html)
6672

0 commit comments

Comments
 (0)