Ramldoc: opt out of inherited path parameters in resources
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
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- kotlin
- Ambito
- documentation, tooling
Direzione di ricerca
Inizia dal passaggio di generazione di ramldoc in rmf-codegen e analizza il modo in cui i parametri RAML radice delle definizioni API del Smoke test vengono appiattiti nella documentazione degli endpoint. Confronta un opt-out predefinito per i parametri di percorso ereditati con una blacklist configurabile; il risultato dovrebbe stabilire un comportamento documentato che eviti di ripetere i parametri condivisi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
We've arrived in the tuning phase of the documentation generator that is based on rmf-codegen. In our Smoke test API definitions we realized that we have three path parameters that are all identical in 100% of the API endpoints (region, cloud provider, project key).
Since rmf-codegen is so perfect in flattening the effective API definition of an endpoint, the API documentation lists these three parameters over and over and over again.
We'd like to avoid hacking it out again and think the "ramldoc" generation step is the right one to decide whether to fully flatten everything or whether to selectively define some things as documented centrally. A simple default could be to not flatten all base URI parameters that are defined in the root RAML api file. Simply passing a blacklist would do the job, too though.
Any ideas whether this is realistic and could be doable?
- Lingua principale
- Kotlin
- Stelle
- 16
- Fork
- 7
- Merge medio
- 1g 3h
- PR unite (30g)
- 3
Preparare l'ambiente
Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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 commercetools/rmf-codegen
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
commercetools/rmf-codegen#333 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
commercetools/rmf-codegen#323 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
commercetools/rmf-codegen#313 · 2 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
commercetools/rmf-codegen#306 · 5 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 40/100
commercetools/rmf-codegen#295 ·
Tutte le issue di commercetools/rmf-codegen
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
bug webview
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
home-assistant/android#7524 ·
I maintainer di solito rispondono entro 1 giorno
-
Issue: Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
OpenAPITools/openapi-generator#25021 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
software-mansion/enriched-markdown#897 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
detekt/detekt#9761 · 1 commento · 2 reazioni ·
I maintainer di solito rispondono entro 1 giorno