bsdata
bsdata copied to clipboard
Backend API specification
REST API definition:
https://github.com/BSData/bsdata/blob/41af6dbb415918dd9d1d074f23c36d3fc05919f4/src/main/java/org/battlescribedata/rest/RepoResource.java
Endpoints:
Verb | URL | description | model |
---|---|---|---|
GET |
/{repo}/{filename} |
retrieves a file - be it an index, catalogue, game system or even a roster(?) | - (file content) |
GET |
/{repo} |
retrieves a JSON with repository details, including file list | RepositoryVm.java |
GET |
/feeds/{repo}.atom |
retrieves an Atom XML with the newsfeed content for the repo (latest update, currently); special case for all which is an aggregate of all other feeds. |
Atom XML |
GET |
/ |
retrieves a JSON with a list of available repositories | RepositorySourceVm.java |
POST |
/{repo}/{filename} |
Upload a file update, return confirmation JSON | ResponseVm.java |
POST |
/{repo}/{filename}/issue |
Report an issue, return confirmation JSON | ResponseVm.java |