Provide support for more sophisticated path-based constraint description resolution

Open
#106 2 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, spring
Domain
api, documentation

Research direction

Start by reviewing issue #42 and the existing constraint-description resolution work for properties on classes. Trace how a documented field path is currently resolved, then define the nested-path cases that should work. Done means constraint descriptions resolve for nested paths and the documentation path can be reused.

Written by the indexing model from the issue text.

Description

type: enhancement

#42 added support for resolving constraint descriptions for a property on a class. This works well for simple payloads. For more complex payloads it would be useful to be able to resolve constraint descriptions for a nested path. Ideally, the path used to document a field could be reused.

Dominant language
Java
Stars
1.2k
Forks
731
No merged PRs in 30d

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.

More from spring-projects/spring-restdocs

All issues in spring-projects/spring-restdocs

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.