spring-projects / spring-projects/spring-data-commons
Add annotation that specify allowed sort properties [DATACMNS-966]
Open
@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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.