Coorpacademy Mobile API

Minimal-version gate for the Coorpacademy iOS and Android apps — read and update the minimum installable app version per key, plus a send-email operation. 2 paths / 3 operations. Key-gated via an `Api-Secret` header.

OpenAPI Specification

coorpacademy-mobile-openapi.json Raw ↑
{"swagger":"2.0","info":{"description":"API to handle mobile minimal versions to be installed","version":"2.0.0","title":"Coorpacademy Mobile API"},"basePath":"/mobile","securityDefinitions":{"Authorization":{"type":"apiKey","name":"Api-Secret","in":"header"}},"paths":{"/api/v1/minimal-version/{key}":{"parameters":[{"name":"key","in":"path","description":"Build type","required":true,"type":"string","enum":["ios","android"]}],"get":{"tags":["minimalVersion"],"summary":"Return current version for key","produces":["text/plain"],"security":[{"Authorization":[]}],"responses":{"200":{"$ref":"#/responses/Success"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalError"}}},"put":{"tags":["minimalVersion"],"summary":"Return current version for key","security":[{"Authorization":[]}],"consumes":["text/plain"],"produces":["text/plain"],"parameters":[{"name":"value","in":"body","description":"build version such as 1.0.0","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/responses/Success"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalError"}}}},"/api/v1/send-email":{"post":{"tags":["sendEmail"],"summary":"Send an email","parameters":[{"name":"email","in":"body","description":"an address mail","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/responses/Success"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalError"}}}}},"responses":{"Success":{"description":"Version successfully set or retrieved","schema":{"type":"string"}},"InternalError":{"description":"InternalError","schema":{"type":"string"}},"Forbidden":{"description":"Forbidden","schema":{"type":"string"}}}}