OpenBankProject / OpenBankProject/OBP-API

Provide JSON schemas for OBP ResourceDoc endpoint

Aperta
#877 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Scala
Stelle
1.7k
Fork
482
Merge medio
1g 12h
PR unite (30g)
15

Descrizione

Provide JSON schemas for your methods

In schema you need to declare:

  • String types acceptable per method : string, ing, etc.
  • Arrays (if applicable)
  • Booleans
  • Nulls
  • Objects

Example of load:
{
"first_name": "George",
"last_name": "Washington",
"birthday": "1732-02-22",
"address": {
"street_address": "3200 Mount Vernon Memorial Highway",
"city": "Mount Vernon",
"state": "Virginia",
"country": "United States"
}
}

Corresponding schema:
{
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"birthday": {
"type": "string",
"format": "date-time"
},
"address": {
"type": "object",
"properties": {
"street_address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
}
}
}
}
}

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Individua l’endpoint OBP ResourceDoc e verifica come sono attualmente definiti i relativi methods e responses. Determina l’insieme completo dei methods che richiedono schemas, quindi verifica che ogni schema dichiari gli strings, arrays, booleans, nulls e objects supportati descritti nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
json, scala
Ambito
api, backend-api-design
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.