Documentation Powered by ReDoc

Baby foot (1.0)

Download OpenAPI specification:Download

Andrea Gueugnaut: gue@octo.com

List matches

Find matches, paginated by default, with optional filters.

query Parameters
limit
integer
Default: 20
page
integer
Default: 1
sort
string
Default: ""
Example: sort=-createdAt

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a match

Create a match.

header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "teams": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fully update a match

Update and replace a match. You must send the whole entity otherwise it will either fail or erase existing fields.

path Parameters
id
required
string
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "teams": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Remove a match

Remove a match.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "details": [
    ]
}