Add squad docs until creation to apib
parent
7d3bf9a426
commit
3c5dbcd71d
|
@ -0,0 +1,61 @@
|
||||||
|
### Get Squads [GET /squads{?q,fractFilter}]
|
||||||
|
|
||||||
|
Get single army member information
|
||||||
|
|
||||||
|
+ Parameters
|
||||||
|
+ q: `alpha` (string, optional) - filter string which filters for partial squadname
|
||||||
|
|
||||||
|
+ fractFilter: `BLUFOR` (enum[string], optional)
|
||||||
|
Field to filter by fraction
|
||||||
|
|
||||||
|
+ Members
|
||||||
|
+ `BLUFOR`
|
||||||
|
+ `OPFOR`
|
||||||
|
+ `GLOBAL`
|
||||||
|
|
||||||
|
+ Response 200
|
||||||
|
|
||||||
|
+ Attributes (array[Squad], fixed-type)
|
||||||
|
|
||||||
|
### Get Squad [GET /squads/{id}]
|
||||||
|
|
||||||
|
Get single squad information
|
||||||
|
|
||||||
|
+ Parameters
|
||||||
|
+ id: `5aba54eaeadcce6332c6a774` (string, required) - unique id of the squad
|
||||||
|
|
||||||
|
+ Response 200
|
||||||
|
|
||||||
|
+ Attributes (Squad, fixed-type)
|
||||||
|
|
||||||
|
### Create Squad [POST /squads]
|
||||||
|
|
||||||
|
Create a new squad
|
||||||
|
|
||||||
|
+ Request (multipart/form-data; boundary=---BOUNDARY)
|
||||||
|
|
||||||
|
-----BOUNDARY
|
||||||
|
Content-Disposition: form-data; name="name"
|
||||||
|
Content-Type: text/plain
|
||||||
|
|
||||||
|
test
|
||||||
|
-----BOUNDARY
|
||||||
|
Content-Disposition: form-data; name="fraction"
|
||||||
|
Content-Type: text/plain
|
||||||
|
|
||||||
|
BLUFOR
|
||||||
|
-----BOUNDARY
|
||||||
|
Content-Disposition: form-data; name="image"; filename="image.jpg"
|
||||||
|
Content-Type: image/jpeg
|
||||||
|
Content-Transfer-Encoding: base64
|
||||||
|
|
||||||
|
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
|
||||||
|
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
|
||||||
|
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
|
||||||
|
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
|
||||||
|
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
|
||||||
|
-----BOUNDARY--
|
||||||
|
|
||||||
|
+ Response 201
|
||||||
|
|
||||||
|
+ Attributes (User, fixed-type)
|
|
@ -52,6 +52,8 @@ FORMAT: 1A
|
||||||
|
|
||||||
# Group Squads
|
# Group Squads
|
||||||
|
|
||||||
|
:[Gists](army-management/squads.apib)
|
||||||
|
|
||||||
# Group Users
|
# Group Users
|
||||||
|
|
||||||
:[Gists](army-management/users.apib)
|
:[Gists](army-management/users.apib)
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
asddas
|
Loading…
Reference in New Issue