OpenBankProject / OpenBankProject/OBP-API
Path Parameters
Nessuno ha ancora preso questa issue.
- Lingua principale
- Scala
- Stelle
- 1.7k
- Fork
- 482
- Merge medio
- 1g 12h
- PR unite (30g)
- 15
Descrizione
Path parameters are variable parts of a URL path. They are typically used to point to a specific resource within a collection, such as a user identified by ID.
For instance: /users/{userId}
OBP-API uses next notation: /users/USER_ID
We need to consider using curly braces i.e {userId} instead of USER_ID in documentation.
Guida per i contributori
Apri 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.
Direzione di ricerca
Cerca nella documentazione dell'API i parametri di percorso scritti come USER_ID e confrontali con l'esempio /users/{userId} dell'issue. Aggiorna la documentazione pertinente per usare in modo coerente i nomi dei parametri tra parentesi graffe, quindi verifica che gli esempi interessati siano corretti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100