{ "swagger": "2.0", "info": { "title": "petitfilet", "description": "API", "version": "264" }, "host": "api.petitfilet.app", "basePath": "\/", "schemes": [ "https" ], "consumes": [ "application\/json", "multipart\/form-data", "application\/x-www-form-urlencoded" ], "produces": [ "application\/json" ], "tags": [ { "name": "CircleInvitation" }, { "name": "ComplexLocation" }, { "name": "Configuration" }, { "name": "Email" }, { "name": "Event" }, { "name": "EventList" }, { "name": "File" }, { "name": "Log" }, { "name": "Page" }, { "name": "Player" }, { "name": "User" }, { "name": "UserRequest" } ], "paths": { "\/CircleInvitation": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/CircleInvitation" } } } }, "tags": [ "CircleInvitation" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/CircleInvitation" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "CircleInvitation" ], "security": [ { "basicAuth": [] } ] } }, "\/CircleInvitation\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/CircleInvitation" } } }, "tags": [ "CircleInvitation" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/CircleInvitation" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "CircleInvitation" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "CircleInvitation" ], "security": [ { "basicAuth": [] } ] } }, "\/CircleInvitation\/{id}\/accept": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "summary": "Accept Invitation", "responses": { "200": { "description": "Generic response", "schema": { "$ref": "#\/definitions\/BooleanResponse" } } } } }, "\/CircleInvitation\/{id}\/refuse": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "summary": "Refuse Invitation", "responses": { "200": { "description": "Generic response", "schema": { "$ref": "#\/definitions\/BooleanResponse" } } } } }, "\/ComplexLocation": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/ComplexLocation" } } } }, "tags": [ "ComplexLocation" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/ComplexLocation" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "ComplexLocation" ] } }, "\/ComplexLocation\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/ComplexLocation" } } }, "tags": [ "ComplexLocation" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/ComplexLocation" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "ComplexLocation" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "ComplexLocation" ] } }, "\/Configuration": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/Configuration" } } } }, "tags": [ "Configuration" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/Configuration" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Configuration" ] } }, "\/Configuration\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/Configuration" } } }, "tags": [ "Configuration" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/Configuration" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Configuration" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Configuration" ] } }, "\/Email": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/Email" } } } }, "tags": [ "Email" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/Email" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Email" ] } }, "\/Email\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/Email" } } }, "tags": [ "Email" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/Email" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Email" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Email" ] } }, "\/Event": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/Event" } } } }, "tags": [ "Event" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/Event" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Event" ], "security": [ { "basicAuth": [] } ] } }, "\/Event\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/Event" } } }, "tags": [ "Event" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/Event" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Event" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Event" ] } }, "\/EventList": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/EventList" } } } }, "tags": [ "EventList" ] } }, "\/EventList\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/EventList" } } }, "tags": [ "EventList" ] } }, "\/File": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/File" } } } }, "tags": [ "File" ] }, "post": { "summary": "Create", "consumes": [ "multipart\\\/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "File to upload", "required": true, "type": "file" }, { "name": "type", "in": "formData", "description": "Type of file", "required": true, "type": "string" } ], "responses": { "200": { "description": "Full file infos.", "schema": { "$ref": "#\/definitions\/File" } } }, "tags": [ "File" ] } }, "\/File\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/File" } } }, "tags": [ "File" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "File" ] } }, "\/Log": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/Log" } } } }, "tags": [ "Log" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/Log" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Log" ] } }, "\/Log\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/Log" } } }, "tags": [ "Log" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/Log" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Log" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Log" ] } }, "\/Page": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/Page" } } } }, "tags": [ "Page" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/Page" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Page" ] } }, "\/Page\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/Page" } } }, "tags": [ "Page" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/Page" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Page" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Page" ] } }, "\/Player": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/Player" } } } }, "tags": [ "Player" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/Player" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Player" ] } }, "\/Player\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/Player" } } }, "tags": [ "Player" ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/Player" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Player" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "Player" ] } }, "\/User": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/User" } } } }, "tags": [ "User" ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/User" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "User" ] } }, "\/User\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/User" } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/User" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] } }, "\/me": { "get": { "summary": "Read current logged user infos", "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/User" } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update current logged user infos", "parameters": [ { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/User" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] }, "delete": { "summary": "Delete current logged user", "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "User" ], "security": [ { "basicAuth": [] } ] } }, "\/User\/{id}\/changePassword": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "password", "in": "formData", "required": true, "type": "string" }, { "name": "key", "in": "formData", "required": true, "type": "string" } ], "summary": "Update user's password", "responses": { "200": { "description": "Generic response", "schema": { "$ref": "#\/definitions\/BooleanResponse" } } } } }, "\/User\/{id}\/sendOtp": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "summary": "Update user's password", "responses": { "200": { "description": "Generic response", "schema": { "$ref": "#\/definitions\/BooleanResponse" } } } } }, "\/User\/{id}\/generateUUID": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "summary": "Generate UUID", "responses": { "200": { "schema": { "$ref": { "type": "array" } } } } } }, "\/User\/{id}\/getCircle": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "summary": "Get circle", "responses": { "200": { "description": "Generic response", "schema": { "$ref": "#\/definitions\/BooleanResponse" } } } } }, "\/User\/{id}\/getMyCircles": { "patch": { "consumes": [ "application\/x-www-form-urlencoded" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "summary": "Get all my circles", "responses": { "200": { "description": "Generic response", "schema": { "$ref": "#\/definitions\/BooleanResponse" } } } } }, "\/UserRequest": { "get": { "summary": "Read many elements", "parameters": [ { "name": "fields", "in": "query", "description": "The fields of the object you want to get", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The limit and offset to apply to query results. (ex: 2000, 1000 gives items from 2000 to 3000)", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "The order clause to apply to the query", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "Filters to be applied. AND condition", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" } } ], "responses": { "200": { "description": "Array of items", "schema": { "type": "array", "items": { "$ref": "#\/definitions\/UserRequest" } } } }, "tags": [ "UserRequest" ], "security": [ { "basicAuth": [] } ] }, "post": { "summary": "Create", "parameters": [ { "name": "item", "in": "body", "description": "Item to create.", "required": true, "schema": { "$ref": "#\/definitions\/UserRequest" } } ], "responses": { "200": { "description": "Identifier of created item.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "UserRequest" ], "security": [ { "basicAuth": [] } ] } }, "\/UserRequest\/{id}": { "get": { "summary": "Read one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Requested item.", "schema": { "$ref": "#\/definitions\/UserRequest" } } }, "tags": [ "UserRequest" ], "security": [ { "basicAuth": [] } ] }, "put": { "summary": "Update one item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" }, { "name": "item", "in": "body", "description": "Properties of item to update.", "required": true, "schema": { "$ref": "#\/definitions\/UserRequest" } } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "UserRequest" ] }, "delete": { "summary": "Delete one element", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for item.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Number of affected rows.", "schema": { "$ref": "#\/definitions\/IntegerResponse" } } }, "tags": [ "UserRequest" ] } } }, "definitions": { "BooleanResponse": { "type": "object", "properties": { "value": { "type": "boolean" } } }, "StringResponse": { "type": "object", "properties": { "value": { "type": "string" } } }, "IntegerResponse": { "type": "object", "properties": { "value": { "type": "integer" } } }, "NumberResponse": { "type": "object", "properties": { "value": { "type": "number" } } }, "CircleInvitation": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "creator_unique_id": { "type": "string" }, "receiver_unique_id": { "type": "string" }, "is_answered": { "type": "integer" }, "creation_date": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "creator_unique_id", "receiver_unique_id", "is_answered", "creation_date", "change_dt", "deleted" ] }, "ComplexLocation": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "name": { "type": "string" }, "address": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "phone": { "type": "string" }, "logo_filename": { "type": "string" }, "logo_url": { "type": "string" }, "creation_date": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "name", "address", "zipcode", "city", "creation_date", "change_dt", "deleted" ] }, "Configuration": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "change_dt", "deleted" ] }, "Email": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "subject": { "type": "string" }, "content": { "type": "string" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "subject", "content", "change_dt", "deleted" ] }, "Event": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "unique_id": { "type": "string" }, "owner_unique_id": { "type": "string" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "max_players": { "type": "integer" }, "complex_id": { "type": "integer" }, "level": { "type": "integer" }, "is_private": { "type": "integer" }, "creation_date": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "unique_id", "owner_unique_id", "start_date", "end_date", "max_players", "complex_id", "level", "is_private", "creation_date", "change_dt", "deleted" ] }, "EventList": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "unique_id": { "type": "string" }, "owner_unique_id": { "type": "string" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "max_players": { "type": "integer" }, "complex_id": { "type": "integer" }, "level": { "type": "integer" }, "is_private": { "type": "integer" }, "creation_date": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "friends": { "type": "string" } }, "required": [ "id", "unique_id", "owner_unique_id", "start_date", "end_date", "max_players", "complex_id", "level", "is_private", "creation_date", "change_dt", "deleted", "first_name", "last_name" ] }, "File": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "uuid": { "type": "string" }, "type": { "type": "string" }, "property_unique_id": { "type": "string" }, "file_name": { "type": "string" }, "url": { "type": "string" }, "md5": { "type": "string" }, "sha1": { "type": "string" }, "mime": { "type": "string" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "type", "file_name", "url", "mime", "change_dt", "deleted" ] }, "Log": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "user_id": { "type": "integer" }, "action": { "type": "string" }, "type": { "type": "string" }, "item_id": { "type": "string" }, "link": { "type": "string" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "user_id", "action", "change_dt", "deleted" ] }, "Page": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "title": { "type": "string" }, "slug": { "type": "string" }, "content": { "type": "string" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "title", "slug", "content", "change_dt", "deleted" ] }, "Player": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "user_unique_id": { "type": "string" }, "event_unique_id": { "type": "string" }, "team_id": { "type": "integer" }, "creation_date": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "user_unique_id", "event_unique_id", "creation_date", "change_dt", "deleted" ] }, "User": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "unique_id": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "contact_phone": { "type": "string" }, "birthdate": { "type": "string", "format": "date-time" }, "otp": { "type": "integer" }, "next_otp_notification": { "type": "string", "format": "date-time" }, "is_activated": { "type": "integer" }, "logo_filename": { "type": "string" }, "logo_url": { "type": "string" }, "friends": { "type": "string" }, "access_level": { "type": "integer" }, "creation_date": { "type": "string", "format": "date-time" }, "change_dt": { "type": "string", "format": "date-time" }, "deleted": { "type": "integer" } }, "required": [ "id", "email", "password", "first_name", "last_name", "birthdate", "otp", "is_activated" ] }, "UserRequest": { "type": "object", "properties": { "id": { "type": "integer", "x-primary-key": true }, "email": { "type": "string" }, "type": { "type": "string" }, "ip": { "type": "string" }, "creation_date": { "type": "string", "format": "date-time" } }, "required": [ "id", "email", "type", "creation_date" ] } }, "securityDefinitions": { "basicAuth": { "description": "Global Security", "type": "basic" } } }