Make it easier to document a resource with fields and links that come and go as the resource's state changes
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
No files, tests, or entry points are named. Start by tracing how documentation is accumulated and snippets are produced across service calls. Done means documented links and fields can be collected over multiple calls and verified against the resource's observed states without relying on optional markers.
Written by the indexing model from the issue text.
Description
At the moment you can document a link or field that isn't there by marking it as optional. It works, but it can lead to inaccuracies in the documentation. An alternative would be to allow the links, fields etc that need to be documented to be accumulated over multiple calls to the service. Once all of the calls are complete, and the resource has transitioned through its various states, the snippet can be produced and it can verify that all of the documented links, fields, etc were actually present.
- Dominant language
- Java
- Stars
- 1.2k
- Forks
- 731
- Avg merge
- 26d 21h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from spring-projects/spring-restdocs
-
Upgrade to Spring Framework 7.0.10Possibly taken @wilkinsona claimed this 1 day ago. Opentype: dependency-upgrade
spring-projects/spring-restdocs#1063 · 1 assignee ·
-
Upgrade to Spring Framework 7.1.0-RC1Possibly taken @wilkinsona claimed this 1 day ago. Opentype: dependency-upgrade
spring-projects/spring-restdocs#1062 · 1 assignee ·
-
status: waiting-for-triage
Difficulty 5/5 Over a week Newbie friendliness 45/100
spring-projects/spring-restdocs#1026 · 2 comments ·
-
status: blocked status: waiting-for-triage
Difficulty 4/5 3-5 days Newbie friendliness 35/100
spring-projects/spring-restdocs#953 · 7 comments ·
-
type: enhancement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
All issues in spring-projects/spring-restdocs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
type: possible bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
grimmory-tools/grimmory#2850 · 1 comment ·
Maintainers usually reply within 1 day
-
pdf
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
portfolio-performance/portfolio#6103 ·
Maintainers usually reply within 7 days