Add endpoint for managing recycle bin by rohnsha0 · Pull Request #1920 · plone/plone.restapi

rohnsha0 · 2025-04-27T16:48:20Z

should be merged after #4166

📚 Documentation preview 📚: https://plonerestapi--1920.org.readthedocs.build/en/1920/endpoints/recycle-bin.html

…ment

mister-roboto · 2025-04-27T16:48:28Z

@rohnsha0 thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

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!

stevepiercy

Mostly just strings and docs matters.

Co-authored-by: Steve Piercy <web@stevepiercy.com>

stevepiercy · 2025-04-28T08:20:31Z

+```http-example
+GET /@recyclebin HTTP/1.1
+Accept: application/json
+```


This and all http example requests and responses should follow the pattern of other documentation in this directory. This allows tests to run both on the documentation and on the code. Here's example MyST markup that pulls in files as literal includes. You'll also need to create the included files.

plone.restapi/docs/source/endpoints/addons.md

Lines 17 to 30 in 70da1de

## Reading add-ons records

Reading a single record:

```{eval-rst}

.. http:example:: curl httpie python-requests

:request: ../../../src/plone/restapi/tests/http-examples/addons_get.req

```

Example response:

```{literalinclude} ../../../src/plone/restapi/tests/http-examples/addons_get.resp

:language: http

```

See also the contributing guide at https://6.docs.plone.org/plone.restapi/docs/source/contributing/index.html#generate-documentation-examples

Steve is right--look at some of the other services for examples. We're supposed to have tests like the ones in test_documentation.py which actually call the endpoint, then record the request and response so they can be included in the docs. That way we will notice if something changes the response in the future.

davisagli · 2025-06-17T05:58:42Z

+                        "purge": f"{self.context.absolute_url()}/@recyclebin-purge",
+                    },
+                }
+            )


This should paginate the results using the same batching utility that other services use. This service will also need to take params for the filters needed to support the UI.

This is resolved i think: i see pagination with HypermediaBatch

davisagli · 2025-06-17T05:59:50Z

+
+
+class RecycleBinPurge(Service):
+    """POST /@recyclebin-purge - Permanently delete an item from the recycle bin"""


This should be a DELETE request to /@recyclebin/<item_id>

We should also support a DELETE on /@recyclebin for emptying the entire recycle bin.

I guess this is resolved as well

davisagli · 2025-06-17T06:02:15Z

+
+
+class RecycleBinGet(Service):
+    """GET /@recyclebin - List items in the recycle bin"""


We'll also want a GET for /@recyclebin/<item_id> to get one specific item (for the detail page).

davisagli · 2025-06-17T06:04:32Z

+```http-example
+GET /@recyclebin HTTP/1.1
+Accept: application/json
+```


Steve is right--look at some of the other services for examples. We're supposed to have tests like the ones in test_documentation.py which actually call the endpoint, then record the request and response so they can be included in the docs. That way we will notice if something changes the response in the future.

…, and pagination

…actions

…djust related actions

…or handling

…etrieval with filtering and sorting options

cekk · 2026-03-19T10:55:01Z

@davisagli i've seen that tests here are all mocks.
Is it ok or is there a way to use a CMFPlone branch to test the real tool?

davisagli · 2026-03-19T17:19:27Z

@cekk I would definitely prefer to have tests using the real tool instead of mocks.

There is a plip configuration for buildout.coredev that installs all the in-progress branches together: https://github.com/plone/buildout.coredev/blob/6.2/plips/plip-recycle-bin.cfg

Or if you don't want to use buildout, you could add the checkouts to mx.ini in this branch, for now.

read-the-docs-community · 2026-03-20T09:30:33Z

Documentation build overview

📚 plone.restapi | 🛠️ Build #31904397 | 📁 Comparing f1fb472 against latest (abebc6b)

🔍 Preview build

Show files changed (5 files in total): 📝 4 modified | ➕ 1 added | ➖ 0 deleted

File	Status
index.html	📝 modified
endpoints/index.html	📝 modified
endpoints/querystringsearch.html	📝 modified
endpoints/recycle-bin.html	➕ added
endpoints/registry.html	📝 modified

Co-authored-by: Steve Piercy <web@stevepiercy.com>

rohnsha0 added 5 commits April 27, 2025 20:06

feat(recyclebin): add REST API services for recyclebin management

cdb3dda

feat(recyclebin): refactor and enhance REST API for recyclebin manage…

659bdc3

…ment

test(recyclebin): add tests for recycle bin REST API functionality

8055417

lint

76293ec

changelog

4f1ad73

rohnsha0 linked an issue Apr 27, 2025 that may be closed by this pull request

Add Endpoint for Recycle bin #1919

Open

stevepiercy requested changes Apr 27, 2025

View reviewed changes

rohnsha0 and others added 2 commits April 28, 2025 06:21

Apply suggestions from code review

97aa41f

Co-authored-by: Steve Piercy <web@stevepiercy.com>

add docs

04016ce

stevepiercy requested changes Apr 28, 2025

View reviewed changes

Update interface location

860422c

davisagli reviewed Jun 17, 2025

View reviewed changes

rohnsha0 mentioned this pull request Sep 16, 2025

PLIP: implement deletion to a recycle bin that allows users to restore items plone/Products.CMFPlone#2966

Open

rohnsha0 and others added 6 commits October 8, 2025 07:44

Merge branch 'main' into rohnsha0-feat-recyclebin-api

9bd36fe

feat(recyclebin): enhance recycle bin service with filtering, sorting…

a82bfcf

…, and pagination

feat(recyclebin): change purge endpoint to DELETE and update related …

a590b13

…actions

feat(recyclebin): update restore endpoint to use item_id in URL and a…

1487920

…djust related actions

feat(recyclebin): implement individual item retrieval and enhance err…

164245b

…or handling

feat(recyclebin): enhance documentation and implement detailed item r…

0561f49

…etrieval with filtering and sorting options

sneridagh added this to Bucharest Sprint 2026 Feb 28, 2026

github-project-automation Bot moved this to Todo in Bucharest Sprint 2026 Feb 28, 2026

Merge branch 'main' into rohnsha0-feat-recyclebin-api

cb85bfd

Apply suggestions from code review

f1fb472

Co-authored-by: Steve Piercy <web@stevepiercy.com>

pnicolli moved this from Todo to In progress in Bucharest Sprint 2026 Mar 24, 2026

	## Reading add-ons records

	Reading a single record:

	```{eval-rst}
	.. http:example:: curl httpie python-requests
	:request: ../../../src/plone/restapi/tests/http-examples/addons_get.req
	```

	Example response:

	```{literalinclude} ../../../src/plone/restapi/tests/http-examples/addons_get.resp
	:language: http
	```



		class RecycleBinPurge(Service):
		"""POST /@recyclebin-purge - Permanently delete an item from the recycle bin"""



		class RecycleBinGet(Service):
		"""GET /@recyclebin - List items in the recycle bin"""

Uh oh!

Conversation

rohnsha0 commented Apr 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mister-roboto commented Apr 27, 2025

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cekk commented Mar 19, 2026

Uh oh!

davisagli commented Mar 19, 2026

Uh oh!

read-the-docs-community Bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rohnsha0 commented Apr 27, 2025 •

edited

Loading

read-the-docs-community Bot commented Mar 20, 2026 •

edited

Loading