Skip to content

Commit 8bf5050

Browse files
authored
Merge branch 'blackducksoftware:master' into master
2 parents 1cfd0b7 + 392d57d commit 8bf5050

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ The defect was fixed in version 0.0.53.
1010

1111
Customers using the [blackduck library](https://pypi.org/project/blackduck) should upgrade to version 0.0.53, or later, to implement the fix.
1212

13+
# Paging and Black Duck v2022.2
14+
15+
In v2022.2 of Black Duck the REST API introduced a max page size to protect system resource usage. See the Black Duck [release notes on Synopsys Community](https://community.synopsys.com/s/article/Black-Duck-Release-Notes) for the details of which API endpoints are affected. Users of the the python bindings here should leverage the Client interface which provides automatic paging support to make best use of these endpoints.
16+
17+
**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**.
18+
1319
# New in 1.0.0
1420

1521
Introducing the new Client class.
@@ -29,12 +35,10 @@ See [Client versus HubInstance Comparison](https://github.com/blackducksoftware/
2935
and also read the [Client User Guide](https://github.com/blackducksoftware/hub-rest-api-python/wiki/Client-User-Guide)
3036
on the [Hub REST API Python Wiki](https://github.com/blackducksoftware/hub-rest-api-python/wiki).
3137

32-
### Important Note
33-
The old HubInstance (in HubRestApi.py) keeps its existing functionality for backwards compatibility and therefore does
34-
**not** currently leverage any of the new features in the Client class.
38+
### Important Notes
39+
The old HubInstance (in HubRestApi.py) keeps its existing functionality for backwards compatibility and therefore does **not** currently leverage any of the new features in the Client class.
3540

36-
We believe that the new features are compelling enough to strongly encourage users to consider moving from HubInstance
37-
to Client.
41+
We believe that the new features are compelling enough to strongly encourage users to consider moving from HubInstance to Client.
3842
See [Client versus HubInstance Comparison](https://github.com/blackducksoftware/hub-rest-api-python/wiki/Client-versus-HubInstance-Comparison).
3943

4044

0 commit comments

Comments
 (0)