Skip to content

README: fix previous -> prev, mention search in _links - #386

Open
MMilosz wants to merge 1 commit into
DSpace:mainfrom
MMilosz:patch-1
Open

MMilosz wants to merge 1 commit into
DSpace:mainfrom
MMilosz:patch-1

Conversation

@MMilosz

@MMilosz MMilosz commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

It was always prev, not previous - fixed to match

Also, included the search link

Updated the example parameters so they make sense for totalElements=14, including showing that self is indeed a parameterized link

@tdonohue tdonohue left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MMilosz : Good catch that the docs are slightly wrong here. Your updates mostly look good, but there's some minor inconsistencies that I describe below. Once you cleanup those inconsistencies, then I think this is ready to merge.

Comment thread README.md
},
"self": {
"href": "http://localhost:8080/server/api/core/bitstreams"
"href": "http://localhost:8080/server/api/core/bitstreams?size=5"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make this more accurate, it likely should say page=1 here, assuming next is page=2.

Comment thread README.md
"href": "http://localhost:8080/server/api/core/bitstreams?page=0&size=5"
},
"prev": {
"href": "http://localhost:8080/server/api/core/bitstreams?page=1&size=5"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to the comment below, to make this more accurate, it likely should be page=0. Essentially, prev, self and next should always be incrementing numbers for the page param.

@tdonohue tdonohue added 1 APPROVAL pull request only requires a single approval to merge. documentation Ticket describes improvements or additions to documentation labels Oct 2, 2026
@tdonohue tdonohue added this to the 11.0 milestone Oct 2, 2026
@tdonohue tdonohue added port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release port to dspace-10_x This PR needs to be ported to `dspace-10_x` branch for next bug-fix release labels Oct 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge. documentation Ticket describes improvements or additions to documentation port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release port to dspace-10_x This PR needs to be ported to `dspace-10_x` branch for next bug-fix release

Projects

Status: 👀 Under Review

Development

Successfully merging this pull request may close these issues.

2 participants