Add items_total to linkintegrity endpoint #1636
Conversation
|
@davisagli thanks for creating this Pull Request and helping to improve Plone! TL;DR: Finish pushing changes, pass all other checks, then paste a comment: To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically. Happy hacking! |
✅ Deploy Preview for plone-restapi ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@jenkins-plone-org please run jobs |
|
@stevepiercy Could you please review the doc updates here? |
|
@davisagli am I correct assuming that we just add an "items_total" attribute to the response here? Then I'd say we can merge that and release it as a feature release. |
|
@jenkins-plone-org please run jobs |
| @@ -12,6 +12,30 @@ myst: | |||
| This upgrade guide lists all breaking changes in `plone.restapi`. | |||
| It explains the steps that are needed to upgrade to the latest version. | |||
|
|
|||
| ## Upgrading to `plone.restapi` 9.x | |||
There was a problem hiding this comment.
@davisagli can you check that what I wrote here is correct?
There was a problem hiding this comment.
@tisto yes, basically, but one nuance: The endpoint accepts multiple UIDs. Before, objects with no breaches were left out of the result. Now they are always included, so that we can also show how many items are contained. So, the old result might not be an empty list if multiple UIDs were requested (I.e. multiple checkboxes selected to delete in folder contents) and some of them have breaches
There was a problem hiding this comment.
@davisagli not sure I fully get this. Could you add this to the upgrade guide?
There was a problem hiding this comment.
@davisagli I merged this PR, feel free to add to main or create a new PR.
|
@jenkins-plone-org please run jobs |
|
@jenkins-plone-org please run jobs |
1 similar comment
|
@jenkins-plone-org please run jobs |
This will be used by the linkintegrity check when an object is deleted, to add the number of contained items that will be deleted.
It is a backwards-incompatible change, because current versions of volto expect that the result will include items only if there were some linkintegrity breaches.
Also fixes #1511 by adding the missing documentation for this endpoint