You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,12 @@ The defect was fixed in version 0.0.53.
10
10
11
11
Customers using the [blackduck library](https://pypi.org/project/blackduck) should upgrade to version 0.0.53, or later, to implement the fix.
12
12
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
+
13
19
# New in 1.0.0
14
20
15
21
Introducing the new Client class.
@@ -29,12 +35,10 @@ See [Client versus HubInstance Comparison](https://github.com/blackducksoftware/
29
35
and also read the [Client User Guide](https://github.com/blackducksoftware/hub-rest-api-python/wiki/Client-User-Guide)
30
36
on the [Hub REST API Python Wiki](https://github.com/blackducksoftware/hub-rest-api-python/wiki).
31
37
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.
35
40
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.
38
42
See [Client versus HubInstance Comparison](https://github.com/blackducksoftware/hub-rest-api-python/wiki/Client-versus-HubInstance-Comparison).
0 commit comments