spring-projects / spring-projects/spring-data-rest

the defaut value mentionned for RepositoryRestConfiguration$getLimitParamName is incorrect [DATAREST-1145]

Open
#1,508 0 comments 0 reactions 1 assignee View on GitHub

@odrotbohm is already working on this.

Since Dec 31, 2020.

in: api-documentation type: task
Dominant language
Java
Stars
958
Forks
568
PR merge metrics
No merged PRs in 30d

Description

Marc Tarin opened DATAREST-1145 and commented

The javadoc of org.springframework.data.rest.core.config.RepositoryRestConfiguration$getLimitParamName() states that ??Default is 'limit'?? which while consistent with limitParamName variable name, is false (limitParamName is initialized to 'page').

Beyond simply fixing the javadoc, I would also suggest, for the sake of consistency with pageParamName and sortParamName, that limitParamName should be renamed to sizeParamName (same goes for the getter and setter, obviously)


Affects: 2.5.11 (Hopper SR11), 2.6.7 (Ingalls SR7), 3.0 GA (Kay)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.