Better signal where behaviour is in parameter descriptions
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Tranquilla
- Stack tecnologico
- markdown
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando le descrizioni dei parametri della specifica TAMS e la mappatura CRUD-to-HTTP dell'auth app note, incluse le relative indicazioni sulle eccezioni. Decidi un modo coerente per segnalare i comportamenti importanti, applicalo quindi nella specifica dove necessario e verifica che le descrizioni rendano chiaramente visibili tali comportamenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Context
We've had a few cases where implementers have missed behaviour of TAMS which is described in parameter descriptions. i.e. where a parameter is not just behaving as a place to store a fixed value. We should figure out a way to make these cases easier to spot. Perhaps using an emoji, like we've done to call out exceptions to a basic CRUD -> HTTP methods mapping in the auth app note. See also Github's approach to "Alert" boxes in markdown.
Actions
- Figure out a way to signal important behavioural implementation in descriptions in the TAMS spec
- Add this approach across the spec where required
Outcome
- Changes to TAMS spec descriptions as required
- Lingua principale
- Makefile
- Stelle
- 117
- Fork
- 13
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un 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 bbc/tams
-
Allow UUID versions 6-8 for idsForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertaenhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
App Note 14 clarification for full API pathForse già presa @johnbilt l’ha presa 1 giorno fa. Apertatsc-discuss
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
appnote
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
[BUG] Flow Profiles can't be deletedForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertatsc-discuss
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
Issue simili
-
Contributing instructionsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
dbt-labs/spark-utils#51 ·
-
changelog investigate
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 68/100
ramnes/notion-sdk-py#502 ·
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
hashicorp/terraform-provider-google#30703 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
I maintainer di solito rispondono entro 1 giorno
-
ready-for-agent
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
nemchik/biome-plugin-suitescript#137 ·
I maintainer di solito rispondono entro 1 giorno