Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed singular endpoints to their plural version #254

Merged
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
4 changes: 2 additions & 2 deletions authorizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Return codes:

The supported parameters are:
* page, size [see pagination](README.md#Pagination)
* uri: mandatory, the object to use for the authorization check. The full URI of the rest resource must be specified, i.e. https://{dspace.url}/api/core/community/{uuid}
* uri: mandatory, the object to use for the authorization check. The full URI of the rest resource must be specified, i.e. https://{dspace.url}/api/core/communities/{uuid}
* eperson: optional, the uuid of the eperson to evaluate for authorization. If not specified authorization of anonymous users will be returned
* feature: optional, limit the returned authorization to the specified feature (this provide an alternative to codify the authorization id rule on the client side)

Expand All @@ -60,7 +60,7 @@ Return codes:
The supported parameters are:
* page, size [see pagination](README.md#Pagination)
* uuid: mandatory, repeatable. Represents the list of objects to be used for the authorization check. For each of them, the UUID must be specified.2
* type: mandatory. Represents the type of resource(s) (i.e. "core.item", "workflow.workflowitem",...) on which authorizations are checked.
* type: mandatory. Represents the type of resource(s) (i.e. "core.items", "workflow.workflowitems",...) on which authorizations are checked.
* eperson: optional, the uuid of the eperson to evaluate for authorization. If not specified authorization of anonymous users will be returned
* feature: optional, repeatable. Represents the list of features. Limits the returned authorizations to the specified features (this provide an alternative to codify the authorization id rule on the client side)

Expand Down
4 changes: 2 additions & 2 deletions endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
* [/api/submission/vocabularies](vocabularies.md)
* [/api/submission/vocabularyEntryDetails](vocabularyEntryDetails.md)
* [/api/system/systemwidealerts](systemwidealerts.md)
* [/api/versioning/version](version.md)
* [/api/versioning/versionhistory](versionhistory.md)
* [/api/versioning/versions](versions.md)
* [/api/versioning/versionhistories](versionhistories.md)
* [/api/workflow/workflowitems](workflowitems.md)
* [/api/workflow/pooltasks](pooltasks.md)
* [/api/workflow/claimedtasks](claimedtasks.md)
Expand Down
2 changes: 1 addition & 1 deletion items.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ Status codes:
**GET /api/core/items/{:item-uuid}/version**

Provide version information based on a given Item UUID. An Item UUID will only match one version. READ permissions over the item in addition to the version permissions are checked.
The JSON response is the same as the [Version endpoint](version.md#get-single-version).
The JSON response is the same as the [Version endpoint](versions.md#get-single-version).

Return codes:
* 200 OK - if the operation succeeds
Expand Down
2 changes: 1 addition & 1 deletion search-rels.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ Search endpoints on a collection of resources should act as follows:
* [/api/config/submissiondefinitions](submissiondefinitions.md)
* [/api/submission/workspaceitems](workspaceitems.md)
* [/api/workflow/claimedtasks](claimedtasks.md)
* [/api/workflow/polltasks](polltasks.md)
* [/api/workflow/pooltasks](pooltasks.md)
* [/api/workflow/workflowitems](workflowitems.md)
2 changes: 1 addition & 1 deletion statistics-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Possible response status
This endpoint provides a paginated list of statistics for a DSpaceObject.

The DSpaceObject is given through the following parameters:
- `uri` The object to retrieve statistics for. The full URI of the rest resource must be specified, i.e. https://{dspace.url}/server/api/core/community/{uuid}
- `uri` The object to retrieve statistics for. The full URI of the rest resource must be specified, i.e. https://{dspace.url}/server/api/core/communities/{uuid}

The usual parameters for paginated lists are supported as well:
- `page` The page number
Expand Down
2 changes: 1 addition & 1 deletion submissionuploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ Exposed links:

### Linked entities
#### metadata
**/api/confg/submissionupload/:upload-name/metadata**
**/api/config/submissionuploads/:upload-name/metadata**
The [submission-form](submissionforms.md) used for the metadata of the files
6 changes: 3 additions & 3 deletions subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Return codes:
* 403 Forbidden - if you are not logged in with sufficient permissions. Only administrators can access the endpoint

## Single Subscription Object
**GET /api/core/subscription/<:id>**
**GET /api/core/subscriptions/<:id>**

Provide detailed information about a specific subscription.
The JSON response document is as follow
Expand Down Expand Up @@ -101,7 +101,7 @@ Status codes:

### Search methods
#### findByEPerson
**GET /api/core/subscription/search/findByEPerson?uuid=<:ePerson-uuid>**
**GET /api/core/subscriptions/search/findByEPerson?uuid=<:ePerson-uuid>**

The supported parameters are:
* page, size [see pagination](README.md#Pagination)
Expand Down Expand Up @@ -244,7 +244,7 @@ Return codes:
* 422 Unprocessable Entity - if the subscriptionType or subscriptionParameter name or value are invalid

## Updating subscription
** PUT /api/core/subscription/<:id>**
** PUT /api/core/subscriptions/<:id>**

It is possible to update a subscription with id
`curl -X PUT '{dspace7-url}/api/core/subscriptions/{id}
Expand Down
4 changes: 2 additions & 2 deletions versionhistory.md → versionhistories.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Provide information about for a version history id.
}
```
Attributes:
- draftVersion: true, if the most recent version is associated to an item still in progress (workspace or workflow), false otherwise. This attribute is only visible to users allowed to create a new version in the history, see [Create version endpoint](version.md#Create version)
- draftVersion: true, if the most recent version is associated to an item still in progress (workspace or workflow), false otherwise. This attribute is only visible to users allowed to create a new version in the history, see [Create version endpoint](versions.md#Create version)

Status codes:
* 200 OK - if the version history exists and is accessible by the current user
Expand All @@ -57,7 +57,7 @@ Status codes:
**GET /api/versioning/versionhistories/<:versionHistoryId>/versions**

Retrieve a pageable list of versions for the provided version history identifier.
The versions are ordered by version number descending and attributes are secured as described in the [get single version endpoint](version.md#get-single-version).
The versions are ordered by version number descending and attributes are secured as described in the [get single version endpoint](versions.md#get-single-version).
Only versions related to archived or withdrawn items are return, the most recent version will be excluded from this list if it is not yet archived.

```json
Expand Down
2 changes: 1 addition & 1 deletion version.md → versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Return codes:

### Version History

Retrieves the related version history, for details see [Version history](versionhistory.md)
Retrieves the related version history, for details see [Version history](versionhistories.md)

### Item

Expand Down