Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Return codes:
The supported parameters are:
* page, size [see pagination](README.md#Pagination)
* uuid: mandatory, the uuid of the community
* entityType: mandatory, the label of the entity type field the collection must have
* entityType: mandatory, the label of the entity type field the collection must have

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

Expand Down Expand Up @@ -187,6 +187,21 @@ Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated

#### findEditAuthorized
**/api/core/collections/search/findEditAuthorized**

Get the list of all collections the current user is authorized to edit.

The supported parameters are:
* `query`: limit the returned collections to those with metadata values matching the query terms.
The query is also used to build a prefix query. It can be used to implement
an autosuggest feature over the collection name
* `page`, `size` [see pagination](README.md#Pagination)

Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated

## Patch operations

Collection metadata can be modified as described in [Modifying metadata via Patch](metadata-patch.md).
Expand Down
30 changes: 30 additions & 0 deletions communities.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,36 @@ Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated

#### findEditAuthorized
**/api/core/communities/search/findEditAuthorized**

Get the list of all communities the current user is authorized to edit.

The supported parameters are:
* `query`: limit the returned communities to those with metadata values matching the query terms.
The query is also used to build a prefix query. It can be used to implement
an autosuggest feature over the community name
* `page`, `size` [see pagination](README.md#Pagination)

Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated

#### findAddAuthorized
**/api/core/communities/search/findAddAuthorized**

Get the list of all communities the current user is authorized to add collections or communities to.

The supported parameters are:
* `query`: limit the returned communities to those with metadata values matching the query terms.
The query is also used to build a prefix query. It can be used to implement
an autosuggest feature over the community name
* `page`, `size` [see pagination](README.md#Pagination)

Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated

## Creating communities

### Creating top level community
Expand Down
16 changes: 16 additions & 0 deletions items.md
Original file line number Diff line number Diff line change
Expand Up @@ -605,3 +605,19 @@ Return codes:
* 401 Unauthorized - if you are not authenticated
* 403 Forbidden - if you are not logged in with sufficient permissions
* 404 Not found - if the item doesn't exist (or was already deleted)

## Search methods
#### findEditAuthorized
**GET /api/core/items/search/findEditAuthorized**

It returns the list of Items that the current user is authorized to edit

The supported parameters are:
* `query`: limit the returned Items to those with metadata values matching the query terms.
The query is also used to build a prefix query. It can be used to implement
an autosuggest feature over the collection name
* `page`, `size` [see pagination](README.md#Pagination)

Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated