diff --git a/api/apib/base/file-resources.apib b/api/apib/base/file-resources.apib new file mode 100644 index 0000000..847f9e0 --- /dev/null +++ b/api/apib/base/file-resources.apib @@ -0,0 +1,36 @@ +The running express server instance saves entity related files like squad logos and statistic logs on the file system. +In the original mean application they are served in the `/resource` path of the application server. + +The following examples show where those files are located, to be accessed on the cloud instance. + +## Images +**Decoration Image** + +`https://cc.noarch.de/resource/decoration/{decorationId}.png` + +**Rank Image** + +`https://cc.noarch.de/resource/rank/{rankId}.png` + +**Signature Image** + +`https://cc.noarch.de/resource/signature/{userId}.png` + +**Squad Logo** + +`https://cc.noarch.de/resource/squad/{squadId}.png` + +## Log-Files + +**Sanitized Log File** + +`https://cc.noarch.de/resource/logs/{warId}/clean.log` + +**Original Uploaded Log File** + +`https://cc.noarch.de/resource/logs/{warId}/war.log` + + + + + diff --git a/api/apib/dev-doc.apib b/api/apib/dev-doc.apib index dcb048a..b755033 100644 --- a/api/apib/dev-doc.apib +++ b/api/apib/dev-doc.apib @@ -10,6 +10,10 @@ FORMAT: 1A :[Gists](base/datetime.apib) +# Group File Resources + +:[Gists](base/file-resources.apib) + # Group Access :[Gists](auth/signup.apib)