OpenBankProject / OpenBankProject/OBP-API
Provide JSON schemas for OBP ResourceDoc endpoint
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Scala
- Sterne
- 1.7k
- Forks
- 482
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 15
Beschreibung
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"
}
}
}
}
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Lokalisieren Sie den OBP ResourceDoc-Endpunkt und prüfen Sie, wie seine Methoden und Responses derzeit definiert sind. Ermitteln Sie die vollständige Menge der Methoden, die Schemas benötigen, und überprüfen Sie anschließend, dass jedes Schema die in diesem Issue beschriebenen unterstützten strings, arrays, booleans, nulls und objects deklariert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- json, scala
- Bereich
- api, backend-api-design
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100