swagger.json

{
    "swagger": "2.0",
    "info": {
        "description": "This is the API documentation of the Interactive Office project.",
        "version": "0.0.4",
        "title": "Interactive Office API"
    },
    "host": "",
    "basePath": "/", 
    "schemes": [
        "http"
    ],
    "paths": {
        "/activities": {
            "get": {
                "tags": [
                    "activity"
                ],
                "summary": "Find all activities",
                "operationId": "getActivities",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "$ref": "#/definitions/Activity"
                        }
                    },
                    "400": {
                        "description": "Bad request"
                    }
                }
            }
        },
        "/breakqueue/signup": {
            "post": {
                "tags": [
                    "breakqueue"
                ],
                "summary": "Sign up for a break with the given parameters",
                "operationId": "signupForBreakQueue",
                "produces": [
                    "application/json"
                ],
                 "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "",
                        "required": true,
                        "schema": {
                           "type": "object",
                           "required": [
                                "Username",
                                "Password",
                                "ActivityIDs"
                           ],
                           "properties": {
                               "Username": {
                                   "type": "string"
                               }, 
                               "Password": {
                                   "type": "string"
                               },
                               "ActivityIDs": {
                                    "type": "array",
                                    "items": {
                                        "type": "integer"
                                    }
                               }
                           }
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful operation"
                    },
                    "400": {
                        "description": "Bad request"
                    },
                    "401": {
                        "description": "Invalid credentials"
                    },
                    "406": {
                        "description": "The array of ActivityIDs was not provided or contained 0 items"
                    }
                }
            }
        },
        "/breakqueue/ping": {
            "get": {
                "tags": [
                    "breakqueue"
                ],
                "summary": "Checks if a match was found for the previously signed up break",
                "operationId": "pingBreakQueue",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "",
                        "required": true,
                        "schema": {
                           "type": "object",
                           "required": [
                                "Username",
                                "Password"
                           ],
                           "properties": {
                               "Username": {
                                   "type": "string"
                               }, 
                               "Password": {
                                   "type": "string"
                               }
                           }
                        }
                    }
                ],
                "responses": {
                    "100": {
                        "description": "No match found, but user is in the queue"
                    },
                    "200": {
                        "description": "Successful operation, a match was found",
                        "schema": {
                            "$ref": "#/definitions/Break"
                        }
                    },
                    "400": {
                        "description": "Bad request"
                    },
                    "401": {
                        "description": "Invalid credentials"
                    },
                    "406": {
                        "description": "The user credentials are right but the user is not in the queue yet. Use /break/signup to register to the queue and attempt pinging again."
                    }
                }
            }
        },
        "/breakqueue/leave": {
            "delete": {
                "tags": [
                    "breakqueue"
                ],
                "summary": "Removes the user from the current queue",
                "operationId": "leaveBreakQueue",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "",
                        "required": true,
                        "schema": {
                           "type": "object",
                           "required": [
                                "Username",
                                "Password"
                           ],
                           "properties": {
                               "Username": {
                                   "type": "string"
                               }, 
                               "Password": {
                                   "type": "string"
                               }
                           }
                        }
                    }
                ],
                "responses": {
                    "100": {
                        "description": "The user cannot be removed from the queue because it was never added"
                    },
                    "200": {
                        "description": "Successful operation, the user was removed from the queue"
                    },
                    "400": {
                        "description": "Bad request"
                    },
                    "401": {
                        "description": "Invalid credentials"
                    }
                }
            }
        },
        "/feedbackform": {
            "get": {
                "tags": [
                    "feedback"
                ],
                "summary": "Retrieves the link to the feedback form: https://docs.google.com/forms/d/16LmorfEAbZp0Ugxh3tGwoobcUsxFAfOFgiezMD4K9wE/",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "FeedbackFormURL": {
                                    "type": "string",
                                    "format": "url",
                                    "description": "The link to the feedback form which can be opened and filled in a browser."
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Bad request"
                    }
                }
            }
        },
        "/feedback/post": {
            "post": {
                "tags": [
                    "feedback"
                ],
                "summary": "Posts the feedback after a break was taken",
                "operationId": "postFeedback",
                "produces": [
                    "application/json"
                ],
                 "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "TODO"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful operation"
                    },
                    "400": {
                        "description": "Bad request"
                    },
                    "401": {
                        "description": "Invalid credentials"
                    }
                },
                "deprecated":true
            }
        }
    },
    "securityDefinitions": {
        "petstore_auth": {
            "type": "oauth2",
            "authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
            "flow": "implicit",
            "scopes": {
                "write:pets": "modify pets in your account",
                "read:pets": "read your pets"
            }
        },
        "api_key": {
            "type": "apiKey",
            "name": "api_key",
            "in": "header"
        }
    },
    "definitions": {
        "User": {
            "type": "object",
            "required": [
                "UserID",
                "FirstName",
                "LastName"
            ],
            "properties": {
                "UserID": {
                    "type": "integer",
                    "format": "int64"
                },
                "Email": {
                    "type": "string"
                },
                "Password": {
                    "type": "string"
                },
                "FirstName": {
                    "type": "string"
                },
                "LastName": {
                    "type": "string"
                },
                "ProfilePictureURL": {
                    "type": "string"
                }
            },
            "xml": {
                "name": "User"
            }
        },
        "Activity": {
            "type": "object",
            "required": [
                "ActivityID",
                "Name"
            ],
            "properties": {
                "ActivityID": {
                    "type": "integer",
                    "format": "int64"
                },
                "Name": {
                    "type": "string"
                },
                "MaximumUsers": {
                    "type": "integer",
                    "format": "int64",
                    "default": 0,
                    "description": "The number of maximum users that are allowed for this activity. 0 means that unlimited users can be matched up at the same time for this activity."
                }
            },
            "xml": {
                "name": "Activity"
            }
        },
        "Room": {
            "type": "object",
            "required": [
                "RoomID",
                "Name"
            ],
            "properties": {
                "RoomID": {
                    "type": "integer",
                    "format": "int64"
                },
                "Name": {
                    "type": "string"
                },
                "MaximumUsers": {
                    "type": "integer",
                    "format": "int64",
                    "default": 0,
                    "description": "The number of maximum users that are allowed for this activity. 0 means that unlimited users can be matched up at the same time for this activity."
                }
            },
            "xml": {
                "name": "Room"
            }
        },
        "Break": {
            "type": "object",
            "properties": {
                "BreakID": {
                    "type": "integer",
                    "format": "int64"
                },
                "Partners": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/User"
                    },
                    "description": "The array of partners the user got matched up with"
                },
                "Activity": {
                    "$ref": "#/definitions/Activity"
                },
                "Room": {
                    "$ref": "#/definitions/Room"
                },
                "Timestamp": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The datetime value when the match for the users was found"
                },
                "Status": {
                    "type": "string",
                    "description": "The status of the break",
                    "enum": [
                        "waiting",
                        "inprogress",
                        "complete",
                        "cancelled"
                    ],
                    "default": "waiting"
                }
            }
        },
        "ParticipatesIn": {
            "type": "object",
            "properties": {
                "User": {
                    "$ref": "#/definitions/User"
                },
                "Break": {
                    "$ref": "#/definitions/Break"
                }
            }
        },
        "ApiResponse": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer",
                    "format": "int32"
                },
                "type": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                }
            }
        }
    },
    "externalDocs": {
        "description": "Find out more about Swagger",
        "url": "http://swagger.io"
    }
}