spring-projects / spring-projects/spring-data-commons

Add annotation that specify allowed sort properties [DATACMNS-966]

Open
#1,422 6 comments 0 reactions 1 assignee View on GitHub

@odrotbohm is already working on this.

Since Dec 30, 2020.

in: core status: feedback-provided type: enhancement
Dominant language
Java
Stars
838
Forks
730
PR merge metrics
No merged PRs in 30d

Description

Kazuki Shimizu opened DATACMNS-966 and commented

I'll suggest to add annotation that specify allowed sort properties to limit an injection as follow:

@Documented
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface AllowedSortProperties {
	String[] value();
}
@RequestMapping("/accounts")
@RestController
public class AccountsRestController {
    @GetMapping
    public Page<Account> findPage(@AllowedSortProperties({"id", "name"}) Pageable pageable) {
        // ...
    }
}

When an invalid property is detected, i think better it is ignore from sort property.
What do you think for this suggestion ?
I will submit pull request at later.

Thanks.


Affects: 1.12.6 (Hopper SR6)

Referenced from: pull request https://github.com/spring-projects/spring-data-commons/pull/190

1 votes, 3 watchers

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.