Skip to content

Commit

Permalink
Update openapi.json.
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheTedder
TheTedder committed Jun 24, 2024
1 parent 23b2d88 commit fa3affb
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions LeaderboardBackend/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
}
},
"409": {
"description": "A `User` with the specified username or email already exists.<br /><br />\r\nValidation error codes by property:\r\n- **Username**:\r\n - **UsernameTaken**: the username is already in use\r\n- **Email**:\r\n - **EmailAlreadyUsed**: the email is already in use",
"description": "A `User` with the specified username or email already exists.\n\n\r\nValidation error codes by property:\r\n- **Username**:\r\n - **UsernameTaken**: the username is already in use\r\n- **Email**:\r\n - **EmailAlreadyUsed**: the email is already in use",
"content": {
"application/json": {
"schema": {
Expand All @@ -43,13 +43,13 @@
}
},
"500": {
"description": "Server Error"
"description": "Internal Server Error"
},
"400": {
"description": "The request was malformed."
},
"422": {
"description": "The request contains errors.<br /><br />\r\nValidation error codes by property:\r\n- **Username**:\r\n - **UsernameFormat**: Invalid username format\r\n- **Password**:\r\n - **PasswordFormat**: Invalid password format\r\n- **Email**:\r\n - **EmailValidator**: Invalid email format"
"description": "The request contains errors.\n\n\r\nValidation error codes by property:\r\n- **Username**:\r\n - **UsernameFormat**: Invalid username format\r\n- **Password**:\r\n - **PasswordFormat**: Invalid password format\r\n- **Email**:\r\n - **EmailValidator**: Invalid email format"
}
}
}
Expand Down Expand Up @@ -115,7 +115,7 @@
"description": "The request was malformed."
},
"422": {
"description": "The request contains errors.<br /><br />\r\nValidation error codes by property:\r\n- **Password**:\r\n - **NotEmptyValidator**: No password was passed\r\n - **PasswordFormat**: Invalid password format\r\n- **Email**:\r\n - **NotNullValidator**: No email was passed\r\n - **EmailValidator**: Invalid email format"
"description": "The request contains errors.\n\n\r\nValidation error codes by property:\r\n- **Password**:\r\n - **NotEmptyValidator**: No password was passed\r\n - **PasswordFormat**: Invalid password format\r\n- **Email**:\r\n - **NotNullValidator**: No email was passed\r\n - **EmailValidator**: Invalid email format"
}
}
}
Expand Down Expand Up @@ -380,7 +380,7 @@
}
},
"422": {
"description": "The request body contains errors.<br />\r\nA **PasswordFormat** Validation error on the Password field indicates that the password format is invalid.",
"description": "The request body contains errors.\n\r\nA **PasswordFormat** Validation error on the Password field indicates that the password format is invalid.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -532,7 +532,7 @@
}
},
"422": {
"description": "Client Error",
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -750,7 +750,7 @@
}
},
"422": {
"description": "Client Error",
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
Expand All @@ -772,7 +772,7 @@
{
"name": "id",
"in": "path",
"description": "The ID of the `Run` which should be retrieved.<br />\r\nIt must be possible to parse this to `long` for this request to complete.",
"description": "The ID of the `Run` which should be retrieved.\n\r\nIt must be possible to parse this to `long` for this request to complete.",
"required": true,
"schema": {
"pattern": "^[a-zA-Z0-9-_]{22}$",
Expand Down Expand Up @@ -895,7 +895,7 @@
}
},
"422": {
"description": "Client Error",
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -925,7 +925,7 @@
],
"responses": {
"200": {
"description": "Success",
"description": "OK",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -1035,7 +1035,7 @@
"Users"
],
"summary": "Gets the currently logged-in User.",
"description": "Call this method with the 'Authorization' header. A valid JWT bearer token must be\r\npassed.<br />\r\nExample: `{ 'Authorization': 'Bearer JWT' }`.",
"description": "Call this method with the 'Authorization' header. A valid JWT bearer token must be\r\npassed.\n\r\nExample: `{ 'Authorization': 'Bearer JWT' }`.",
"responses": {
"200": {
"description": "The `User` was found and returned successfully..",
Expand Down Expand Up @@ -1105,13 +1105,14 @@
"required": [
"id",
"name",
"rules",
"slug"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the `Category`.<br />",
"description": "The unique identifier of the `Category`.\n",
"format": "int64"
},
"name": {
Expand All @@ -1121,7 +1122,7 @@
},
"slug": {
"type": "string",
"description": "The URL-scoped unique identifier of the `Category`.<br />",
"description": "The URL-scoped unique identifier of the `Category`.\n",
"example": "foo-bar-baz"
},
"rules": {
Expand Down Expand Up @@ -1163,7 +1164,7 @@
"slug": {
"minLength": 1,
"type": "string",
"description": "The URL-scoped unique identifier of the `Category`.<br />\r\nMust be [2, 25] in length and consist only of alphanumeric characters and hyphens.",
"description": "The URL-scoped unique identifier of the `Category`.\n\r\nMust be [2, 25] in length and consist only of alphanumeric characters and hyphens.",
"example": "foo-bar-baz"
},
"rules": {
Expand Down Expand Up @@ -1195,7 +1196,7 @@
},
"slug": {
"type": "string",
"description": "The URL-scoped unique identifier of the `Leaderboard`.<br />\r\nMust be [2, 80] in length and consist only of alphanumeric characters and hyphens.",
"description": "The URL-scoped unique identifier of the `Leaderboard`.\n\r\nMust be [2, 80] in length and consist only of alphanumeric characters and hyphens.",
"example": "foo-bar"
}
},
Expand Down Expand Up @@ -1260,13 +1261,14 @@
"categories",
"id",
"name",
"rules",
"slug"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the `Leaderboard`.<br />\r\nGenerated on creation.",
"description": "The unique identifier of the `Leaderboard`.\n\r\nGenerated on creation.",
"format": "int64"
},
"name": {
Expand All @@ -1276,7 +1278,7 @@
},
"slug": {
"type": "string",
"description": "The URL-scoped unique identifier of the `Leaderboard`.<br />\r\nMust be [2, 80] in length and consist only of alphanumeric characters and hyphens.",
"description": "The URL-scoped unique identifier of the `Leaderboard`.\n\r\nMust be [2, 80] in length and consist only of alphanumeric characters and hyphens.",
"example": "foo-bar"
},
"rules": {
Expand Down Expand Up @@ -1468,7 +1470,7 @@
"id": {
"pattern": "^[a-zA-Z0-9-_]{22}$",
"type": "string",
"description": "The unique identifier of the `Run`.<br />\r\nGenerated on creation."
"description": "The unique identifier of the `Run`.\n\r\nGenerated on creation."
},
"submittedAt": {
"$ref": "#/components/schemas/Instant"
Expand Down Expand Up @@ -1501,7 +1503,7 @@
"id": {
"pattern": "^[a-zA-Z0-9-_]{22}$",
"type": "string",
"description": "The unique identifier of the `User`.<br />\r\nGenerated on creation."
"description": "The unique identifier of the `User`.\n\r\nGenerated on creation."
},
"username": {
"type": "string",
Expand Down

0 comments on commit fa3affb

Please sign in to comment.