From 3c5dbcd71d30ee519afdb81bf6ace73f9c8314c4 Mon Sep 17 00:00:00 2001 From: HardiReady Date: Fri, 30 Mar 2018 00:05:13 +0200 Subject: [PATCH] Add squad docs until creation to apib --- api/apib/army-management/squads.apib | 61 ++++++++++++++++++++++++++++ api/apib/dev-doc.apib | 2 + api/apib/filename.jpg | 1 + 3 files changed, 64 insertions(+) create mode 100644 api/apib/army-management/squads.apib create mode 100644 api/apib/filename.jpg diff --git a/api/apib/army-management/squads.apib b/api/apib/army-management/squads.apib new file mode 100644 index 0000000..9656d4d --- /dev/null +++ b/api/apib/army-management/squads.apib @@ -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) diff --git a/api/apib/dev-doc.apib b/api/apib/dev-doc.apib index ea40120..5de26f6 100644 --- a/api/apib/dev-doc.apib +++ b/api/apib/dev-doc.apib @@ -52,6 +52,8 @@ FORMAT: 1A # Group Squads +:[Gists](army-management/squads.apib) + # Group Users :[Gists](army-management/users.apib) diff --git a/api/apib/filename.jpg b/api/apib/filename.jpg new file mode 100644 index 0000000..2badecb --- /dev/null +++ b/api/apib/filename.jpg @@ -0,0 +1 @@ +asddas