Skip to content

Commit ef5ea9e

Browse files
committed
Add new search operations to retrieve a list of DSOs based on specific permissions
1 parent 0e60c5e commit ef5ea9e

File tree

3 files changed

+62
-1
lines changed

3 files changed

+62
-1
lines changed

collections.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Return codes:
158158
The supported parameters are:
159159
* page, size [see pagination](README.md#Pagination)
160160
* uuid: mandatory, the uuid of the community
161-
* entityType: mandatory, the label of the entity type field the collection must have
161+
* entityType: mandatory, the label of the entity type field the collection must have
162162

163163
It returns the list of collections where the current user is authorized to submit and deal with the request entity type
164164

@@ -187,6 +187,21 @@ Return codes:
187187
* 200 OK - if the operation succeeds
188188
* 401 Unauthorized - if you are not authenticated
189189

190+
#### findEditAuthorized
191+
**/api/core/collections/search/findEditAuthorized**
192+
193+
Get the list of all collections the current user is authorized to edit.
194+
195+
The supported parameters are:
196+
* `query`: limit the returned collections to those with metadata values matching the query terms.
197+
The query is also used to build a prefix query. It can be used to implement
198+
an autosuggest feature over the collection name
199+
* `page`, `size` [see pagination](README.md#Pagination)
200+
201+
Return codes:
202+
* 200 OK - if the operation succeeds
203+
* 401 Unauthorized - if you are not authenticated
204+
190205
## Patch operations
191206

192207
Collection metadata can be modified as described in [Modifying metadata via Patch](metadata-patch.md).

communities.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,36 @@ Return codes:
299299
* 200 OK - if the operation succeeds
300300
* 401 Unauthorized - if you are not authenticated
301301

302+
#### findEditAuthorized
303+
**/api/core/communities/search/findEditAuthorized**
304+
305+
Get the list of all communities the current user is authorized to edit.
306+
307+
The supported parameters are:
308+
* `query`: limit the returned communities to those with metadata values matching the query terms.
309+
The query is also used to build a prefix query. It can be used to implement
310+
an autosuggest feature over the community name
311+
* `page`, `size` [see pagination](README.md#Pagination)
312+
313+
Return codes:
314+
* 200 OK - if the operation succeeds
315+
* 401 Unauthorized - if you are not authenticated
316+
317+
#### findAddAuthorized
318+
**/api/core/communities/search/findAddAuthorized**
319+
320+
Get the list of all communities the current user is authorized to add collections or communities to.
321+
322+
The supported parameters are:
323+
* `query`: limit the returned communities to those with metadata values matching the query terms.
324+
The query is also used to build a prefix query. It can be used to implement
325+
an autosuggest feature over the community name
326+
* `page`, `size` [see pagination](README.md#Pagination)
327+
328+
Return codes:
329+
* 200 OK - if the operation succeeds
330+
* 401 Unauthorized - if you are not authenticated
331+
302332
## Creating communities
303333

304334
### Creating top level community

items.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -606,6 +606,22 @@ Return codes:
606606
* 403 Forbidden - if you are not logged in with sufficient permissions
607607
* 404 Not found - if the item doesn't exist (or was already deleted)
608608

609+
## Search methods
610+
#### findEditAuthorized
611+
**GET /api/core/items/search/findEditAuthorized**
612+
613+
It returns the list of Items that the current user is authorized to edit
614+
615+
The supported parameters are:
616+
* `query`: limit the returned Items to those with metadata values matching the query terms.
617+
The query is also used to build a prefix query. It can be used to implement
618+
an autosuggest feature over the collection name
619+
* `page`, `size` [see pagination](README.md#Pagination)
620+
621+
Return codes:
622+
* 200 OK - if the operation succeeds
623+
* 401 Unauthorized - if you are not authenticated
624+
609625
### findByCustomURL
610626

611627
**GET /api/core/items/search/findByCustomURL?q=<:custom-url>**

0 commit comments

Comments
 (0)