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

Documentation example uses deprecated API (RepositoryRestConfigurerAdapter) [DATAREST-1407]

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

@odrotbohm is already working on this.

Since Dec 31, 2020.

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

Description

benwarfield-usds opened DATAREST-1407 and commented

The documentation for customizing resource URLs was not updated when RepositoryRestConfigurerAdapter was deprecated and the underlying APIs were changed (not entirely sure which version that was), so the code example (below) no longer compiles.

config.withCustomEntityLookup().
  forRepository(UserRepository.class, User::getUsername, UserRepository::findByUsername);


Affects: 3.1.9 (Lovelace SR9)

Reference URL: https://docs.spring.io/spring-data/rest/docs/3.1.9.RELEASE/reference/html/#_customizing_item_resource_uris

Referenced from: pull request https://github.com/spring-projects/spring-data-rest/pull/359

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.