OpenBankProject / OpenBankProject/OBP-API
Provide JSON schemas for OBP ResourceDoc endpoint
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 482
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 15
Description
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"
}
}
}
}
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the OBP ResourceDoc endpoint and inspect how its methods and responses are currently defined. Determine the full set of methods that need schemas, then verify that each schema declares the supported strings, arrays, booleans, nulls, and objects described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, scala
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100