Make it easier to document a resource with fields and links that come and go as the resource's state changes
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- java
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Java
- Stelle
- 1.2k
- Fork
- 731
- Merge medio
- 26g 21h
- PR unite (30g)
- 3
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di spring-projects/spring-restdocs
-
Upgrade to Spring Framework 7.0.10Forse già presa @wilkinsona l’ha presa 3 giorni fa. Apertatype: dependency-upgrade
spring-projects/spring-restdocs#1063 · 1 assegnatario ·
-
Upgrade to Spring Framework 7.1.0-RC1Forse già presa @wilkinsona l’ha presa 3 giorni fa. Apertatype: dependency-upgrade
spring-projects/spring-restdocs#1062 · 1 assegnatario ·
-
status: waiting-for-triage
Difficoltà 5/5 Più di una settimana Idoneità per principianti 45/100
spring-projects/spring-restdocs#1026 · 2 commenti ·
-
status: blocked status: waiting-for-triage
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
spring-projects/spring-restdocs#953 · 7 commenti ·
-
type: enhancement
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
Tutte le issue di spring-projects/spring-restdocs
Issue simili
-
[destination-snowflake] Custom domains rejected unlike source connectionsForse già presa @kuza55 l’ha presa oggi. Apertaautoteam community connectors/destination/snowflake team/use
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
area-dashboard
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
component/operate kind/feature-request
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
Forge coverage prompts carry text the agent cannot act onForse già presa @graalvmbot l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
oracle/graalvm-reachability-metadata#10572 ·
I maintainer di solito rispondono entro 1 giorno
-
[CI] Core CI doesn't run for changes to amoro-format-lance (and amoro-web)Forse già presa @MarkAlex1234 l’ha presa oggi. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 2 giorni