arcanis/ffxivbis
1
0
Fork 0
mirror of https://github.com/arcan1s/ffxivbis.git synced 2025-08-21 16:19:57 +00:00
Code Issues Projects Releases Wiki Activity

0.9.4

Browse Source 
* types api
* dist instead of assembly (assembly does not allow to use swagger easily)
* small swagger improvements
This commit is contained in:
Evgenii Alekseev
2019-11-15 01:27:15 +03:00
parent 4700768aed
commit ad144534a9
14 changed files with 187 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/main/resources/swagger-info/description.md Normal file
View File

@ -0,0 +1,24 @@
REST json API description to interact with FFXIVBiS service.
# Basic workflow
* Create party using `PUT /api/v1/party` endpoint. It consumes username and password of administrator (which can't be restored). As the result it returns unique id of created party.
* Create new users which have access to this party. Note that user is belong to specific party id and in scope of the specified party it must be unique.
* Add players with their best in slot sets (probably by using ariyala links).
* Add loot items if any.
* By using `PUT /api/v1/party/{partyId}/loot` API find players which are better for the specified loot.
* Add new loot item to the selected player.
# Limitations
# Authentication
For the most party utils service requires user to be authenticated. User permission can be one of `get`, `post` or `admin`.
* `admin` permission means that the user is allowed to do anything, especially this permission is required to be able to add or modify users.
* `post` permission is required to deal with the most POST API endpoints, but to be precise only endpoints which modifies party content require this permission.
* `get` permission is required to have access to party.
`admin` permission includes any other permissions, `post` allows to perform get requests.
<security-definitions />