1655 lines
40 KiB
JSON
1655 lines
40 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"description": "Api Documentation",
|
|
"version": "1.0",
|
|
"title": "Api Documentation",
|
|
"termsOfService": "urn:tos",
|
|
"contact": {},
|
|
"license": {
|
|
"name": "Apache 2.0",
|
|
"url": "http://www.apache.org/licenses/LICENSE-2.0"
|
|
}
|
|
},
|
|
"host": "localhost:8080",
|
|
"basePath": "/",
|
|
"tags": [
|
|
{
|
|
"name": "basic-error-controller",
|
|
"description": "Basic Error Controller"
|
|
},
|
|
{
|
|
"name": "controller",
|
|
"description": "Controller"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/api/allCaches": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Retrieves all Caches, including their Stations, from the Database",
|
|
"operationId": "getAllCachesUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/checkAdmin": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Checks if the given User has an admin role",
|
|
"operationId": "checkAdminUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/checkStation": {
|
|
"put": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Checks if the given Station is the correct next Station in the Cache",
|
|
"operationId": "checkStationUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "cacheID",
|
|
"in": "query",
|
|
"description": "cacheID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "durchgefuehrterCacheID",
|
|
"in": "query",
|
|
"description": "durchgefuehrterCacheID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "stationID",
|
|
"in": "query",
|
|
"description": "stationID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Given Station is NOT the correct following station"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/createCache": {
|
|
"post": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Creates a new Cache",
|
|
"operationId": "createCacheUsingPOST",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "cache",
|
|
"description": "cache",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Cache"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something wrong with the given Parameters"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/createTeam": {
|
|
"post": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Creates a new Team",
|
|
"operationId": "createTeamUsingPOST",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/deleteCache": {
|
|
"delete": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Deletes a Cache",
|
|
"operationId": "deleteCacheUsingDELETE",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "cacheID",
|
|
"in": "query",
|
|
"description": "cacheID",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/deleteCacheForUser": {
|
|
"delete": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Deletes the bearbeitet entry from a User from a Cache",
|
|
"operationId": "deleteCacheForUserUsingDELETE",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "cacheID",
|
|
"in": "query",
|
|
"description": "cacheID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/deleteTeamInvite": {
|
|
"delete": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Removes a team invite from a user (called if a user declined a team invite)",
|
|
"operationId": "deleteTeamInviteUsingDELETE",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "teamInviteID",
|
|
"in": "query",
|
|
"description": "teamInviteID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/editCache": {
|
|
"put": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Edits a Cache",
|
|
"operationId": "editCacheUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "newCache",
|
|
"description": "newCache",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Cache"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something wrong with the given Parameters"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getAllStations": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns all Stations",
|
|
"operationId": "getAllStationsUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getCurrentStation": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns the station the user is currently at (for a specific cache)",
|
|
"operationId": "getStationFromUserAndCacheUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "cacheID",
|
|
"in": "query",
|
|
"description": "cacheID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getCurrentStationMap": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns the Team of a user",
|
|
"operationId": "getCurrentStationMapUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "cacheID",
|
|
"in": "query",
|
|
"description": "cacheID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getMyCaches": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns all Caches finished/started by a given User",
|
|
"operationId": "getMyCachesUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getMyStationPOIS": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns startstations and all other stations the user already visited as POIS",
|
|
"operationId": "getMyStationPOISUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getMyTeamInvites": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns all User invites for a specific User",
|
|
"operationId": "getMyTeamInvitesUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getRankingList": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns the rankinglist",
|
|
"operationId": "getRankingListUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "null"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getRankingPlace": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns the ranking place on the leaderboard for a specific user",
|
|
"operationId": "getRankingPlaceUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "email",
|
|
"in": "query",
|
|
"description": "email",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getTeam": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns a team by a name",
|
|
"operationId": "getTeamUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "name",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getTeamMembers": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns all teammembers by the team name",
|
|
"operationId": "getTeamMembersUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "name",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getTeamOfUser": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns the Team of a user",
|
|
"operationId": "getTeamOfUserUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getTeamRankingList": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns the Team Rankinglist",
|
|
"operationId": "getTeamRankingListUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/getUser": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Returns a user from a given token",
|
|
"operationId": "getUserUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/hello": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Test method (Changes its purpose often)",
|
|
"operationId": "helloUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "name",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/joinTeam": {
|
|
"put": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Lets the user join a Team",
|
|
"operationId": "joinTeamUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "teamID",
|
|
"in": "query",
|
|
"description": "teamID",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/leaveTeam": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Removes the user from the Team",
|
|
"operationId": "leaveTeamUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Removes the user from the Team",
|
|
"operationId": "leaveTeamUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/resetRankingList": {
|
|
"get": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Resets the rankinglist",
|
|
"operationId": "resetRankingListUsingGET",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/resetSingleUser": {
|
|
"put": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Resets the points of a single User ",
|
|
"operationId": "resetSingleUserUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"in": "query",
|
|
"description": "username",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/sendTeamInvite": {
|
|
"post": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Sends a Team Invite to the invitedUserEmail from the User (token)",
|
|
"operationId": "sendTeamInviteUsingPOST",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "invitedUserEmail",
|
|
"in": "query",
|
|
"description": "invitedUserEmail",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/api/setTeamStatus": {
|
|
"put": {
|
|
"tags": [
|
|
"controller"
|
|
],
|
|
"summary": "Sets the team status",
|
|
"operationId": "setTeamStatusUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "teamStatus",
|
|
"in": "query",
|
|
"description": "teamStatus",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "token",
|
|
"in": "query",
|
|
"description": "token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ResponseEntity"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Something went wrong at verification"
|
|
},
|
|
"401": {
|
|
"description": "JWT Token expired"
|
|
},
|
|
"404": {
|
|
"description": "Database error"
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"/error": {
|
|
"get": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingGET",
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"head": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingHEAD",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingPOST",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingPUT",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingDELETE",
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"options": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingOPTIONS",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"basic-error-controller"
|
|
],
|
|
"summary": "errorHtml",
|
|
"operationId": "errorHtmlUsingPATCH",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/ModelAndView"
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"Cache": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"description": "The Description of the Cache"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"description": "The autogenerated CacheID (Primary Key)"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of the Cache"
|
|
},
|
|
"rankingPoints": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"description": "The number of ranking points the user gets fro completing the cache"
|
|
},
|
|
"reward": {
|
|
"description": "The Reward for the Cache",
|
|
"$ref": "#/definitions/Reward"
|
|
},
|
|
"stationen": {
|
|
"type": "array",
|
|
"description": "All stations included in the Cache",
|
|
"items": {
|
|
"$ref": "#/definitions/Station"
|
|
}
|
|
}
|
|
},
|
|
"title": "Cache"
|
|
},
|
|
"ModelAndView": {
|
|
"type": "object",
|
|
"properties": {
|
|
"empty": {
|
|
"type": "boolean"
|
|
},
|
|
"model": {
|
|
"type": "object"
|
|
},
|
|
"modelMap": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"reference": {
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"100 CONTINUE",
|
|
"101 SWITCHING_PROTOCOLS",
|
|
"102 PROCESSING",
|
|
"103 CHECKPOINT",
|
|
"200 OK",
|
|
"201 CREATED",
|
|
"202 ACCEPTED",
|
|
"203 NON_AUTHORITATIVE_INFORMATION",
|
|
"204 NO_CONTENT",
|
|
"205 RESET_CONTENT",
|
|
"206 PARTIAL_CONTENT",
|
|
"207 MULTI_STATUS",
|
|
"208 ALREADY_REPORTED",
|
|
"226 IM_USED",
|
|
"300 MULTIPLE_CHOICES",
|
|
"301 MOVED_PERMANENTLY",
|
|
"302 FOUND",
|
|
"302 MOVED_TEMPORARILY",
|
|
"303 SEE_OTHER",
|
|
"304 NOT_MODIFIED",
|
|
"305 USE_PROXY",
|
|
"307 TEMPORARY_REDIRECT",
|
|
"308 PERMANENT_REDIRECT",
|
|
"400 BAD_REQUEST",
|
|
"401 UNAUTHORIZED",
|
|
"402 PAYMENT_REQUIRED",
|
|
"403 FORBIDDEN",
|
|
"404 NOT_FOUND",
|
|
"405 METHOD_NOT_ALLOWED",
|
|
"406 NOT_ACCEPTABLE",
|
|
"407 PROXY_AUTHENTICATION_REQUIRED",
|
|
"408 REQUEST_TIMEOUT",
|
|
"409 CONFLICT",
|
|
"410 GONE",
|
|
"411 LENGTH_REQUIRED",
|
|
"412 PRECONDITION_FAILED",
|
|
"413 PAYLOAD_TOO_LARGE",
|
|
"413 REQUEST_ENTITY_TOO_LARGE",
|
|
"414 URI_TOO_LONG",
|
|
"414 REQUEST_URI_TOO_LONG",
|
|
"415 UNSUPPORTED_MEDIA_TYPE",
|
|
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
|
|
"417 EXPECTATION_FAILED",
|
|
"418 I_AM_A_TEAPOT",
|
|
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
|
|
"420 METHOD_FAILURE",
|
|
"421 DESTINATION_LOCKED",
|
|
"422 UNPROCESSABLE_ENTITY",
|
|
"423 LOCKED",
|
|
"424 FAILED_DEPENDENCY",
|
|
"426 UPGRADE_REQUIRED",
|
|
"428 PRECONDITION_REQUIRED",
|
|
"429 TOO_MANY_REQUESTS",
|
|
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
|
|
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
|
|
"500 INTERNAL_SERVER_ERROR",
|
|
"501 NOT_IMPLEMENTED",
|
|
"502 BAD_GATEWAY",
|
|
"503 SERVICE_UNAVAILABLE",
|
|
"504 GATEWAY_TIMEOUT",
|
|
"505 HTTP_VERSION_NOT_SUPPORTED",
|
|
"506 VARIANT_ALSO_NEGOTIATES",
|
|
"507 INSUFFICIENT_STORAGE",
|
|
"508 LOOP_DETECTED",
|
|
"509 BANDWIDTH_LIMIT_EXCEEDED",
|
|
"510 NOT_EXTENDED",
|
|
"511 NETWORK_AUTHENTICATION_REQUIRED"
|
|
]
|
|
},
|
|
"view": {
|
|
"$ref": "#/definitions/View"
|
|
},
|
|
"viewName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "ModelAndView"
|
|
},
|
|
"ResponseEntity": {
|
|
"type": "object",
|
|
"properties": {
|
|
"body": {
|
|
"type": "object"
|
|
},
|
|
"statusCode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"100 CONTINUE",
|
|
"101 SWITCHING_PROTOCOLS",
|
|
"102 PROCESSING",
|
|
"103 CHECKPOINT",
|
|
"200 OK",
|
|
"201 CREATED",
|
|
"202 ACCEPTED",
|
|
"203 NON_AUTHORITATIVE_INFORMATION",
|
|
"204 NO_CONTENT",
|
|
"205 RESET_CONTENT",
|
|
"206 PARTIAL_CONTENT",
|
|
"207 MULTI_STATUS",
|
|
"208 ALREADY_REPORTED",
|
|
"226 IM_USED",
|
|
"300 MULTIPLE_CHOICES",
|
|
"301 MOVED_PERMANENTLY",
|
|
"302 FOUND",
|
|
"302 MOVED_TEMPORARILY",
|
|
"303 SEE_OTHER",
|
|
"304 NOT_MODIFIED",
|
|
"305 USE_PROXY",
|
|
"307 TEMPORARY_REDIRECT",
|
|
"308 PERMANENT_REDIRECT",
|
|
"400 BAD_REQUEST",
|
|
"401 UNAUTHORIZED",
|
|
"402 PAYMENT_REQUIRED",
|
|
"403 FORBIDDEN",
|
|
"404 NOT_FOUND",
|
|
"405 METHOD_NOT_ALLOWED",
|
|
"406 NOT_ACCEPTABLE",
|
|
"407 PROXY_AUTHENTICATION_REQUIRED",
|
|
"408 REQUEST_TIMEOUT",
|
|
"409 CONFLICT",
|
|
"410 GONE",
|
|
"411 LENGTH_REQUIRED",
|
|
"412 PRECONDITION_FAILED",
|
|
"413 PAYLOAD_TOO_LARGE",
|
|
"413 REQUEST_ENTITY_TOO_LARGE",
|
|
"414 URI_TOO_LONG",
|
|
"414 REQUEST_URI_TOO_LONG",
|
|
"415 UNSUPPORTED_MEDIA_TYPE",
|
|
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
|
|
"417 EXPECTATION_FAILED",
|
|
"418 I_AM_A_TEAPOT",
|
|
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
|
|
"420 METHOD_FAILURE",
|
|
"421 DESTINATION_LOCKED",
|
|
"422 UNPROCESSABLE_ENTITY",
|
|
"423 LOCKED",
|
|
"424 FAILED_DEPENDENCY",
|
|
"426 UPGRADE_REQUIRED",
|
|
"428 PRECONDITION_REQUIRED",
|
|
"429 TOO_MANY_REQUESTS",
|
|
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
|
|
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
|
|
"500 INTERNAL_SERVER_ERROR",
|
|
"501 NOT_IMPLEMENTED",
|
|
"502 BAD_GATEWAY",
|
|
"503 SERVICE_UNAVAILABLE",
|
|
"504 GATEWAY_TIMEOUT",
|
|
"505 HTTP_VERSION_NOT_SUPPORTED",
|
|
"506 VARIANT_ALSO_NEGOTIATES",
|
|
"507 INSUFFICIENT_STORAGE",
|
|
"508 LOOP_DETECTED",
|
|
"509 BANDWIDTH_LIMIT_EXCEEDED",
|
|
"510 NOT_EXTENDED",
|
|
"511 NETWORK_AUTHENTICATION_REQUIRED"
|
|
]
|
|
},
|
|
"statusCodeValue": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"title": "ResponseEntity"
|
|
},
|
|
"Reward": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"rewardDescription": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Reward"
|
|
},
|
|
"Station": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"lattitude": {
|
|
"type": "number",
|
|
"format": "double"
|
|
},
|
|
"longitude": {
|
|
"type": "number",
|
|
"format": "double"
|
|
},
|
|
"solution": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Station"
|
|
},
|
|
"View": {
|
|
"type": "object",
|
|
"properties": {
|
|
"contentType": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "View"
|
|
}
|
|
}
|
|
} |