Skip to content

Added date validation for list results API and improve documentation of params #2319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexjustesen merged 12 commits into from
Sep 7, 2025
Merged

Added date validation for list results API and improve documentation of params #2319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d956820
Add validation rules for date filters in results listing
alexjustesen Aug 27, 2025
8e4b5e7
Add query parameters for filtering and sorting results in API
alexjustesen Aug 27, 2025
143fc6a
Add tests for filtering results by date range and validation rules
alexjustesen Aug 27, 2025
4f7840b
lint
alexjustesen Aug 27, 2025
be2567e
Update OpenAPI JSON
actions-user Aug 27, 2025
1ca8413
Fix date filter query parameters and improve validation error respons…
alexjustesen Aug 27, 2025
d9478dc
lint
alexjustesen Aug 27, 2025
ff47b55
fixed typo
alexjustesen Aug 27, 2025
9414e93
Remove commented-out date filter validation rules in ResultsController
alexjustesen Aug 27, 2025
be375e0
Restore date filter validation rules in ResultsController
alexjustesen Aug 27, 2025
17883fa
Remove date filter validation rules from ResultsController and delete…
alexjustesen Sep 7, 2025
862fe30
Merge branch 'main' into 2318-feature-api-add-the-ability-to-request-…
alexjustesen Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions app/OpenApi/Annotations/V1/ResultsAnnotations.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,78 @@ class ResultsAnnotations
summary: 'List all results',
operationId: 'listResults',
tags: ['Results'],
parameters: [
new OA\Parameter(
name: 'per_page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer', minimum: 1, maximum: 500, default: 25),
description: 'Number of results per page'
),
new OA\Parameter(
name: 'filter[ping]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'number'),
description: 'Filter by ping value (supports operators like >=, <=, etc.)'
),
new OA\Parameter(
name: 'filter[download]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'Filter by download speed (supports operators like >=, <=, etc.)'
),
new OA\Parameter(
name: 'filter[upload]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'Filter by upload speed (supports operators like >=, <=, etc.)'
),
new OA\Parameter(
name: 'filter[healthy]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'boolean'),
description: 'Filter by healthy status'
),
new OA\Parameter(
name: 'filter[status]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Filter by status'
),
new OA\Parameter(
name: 'filter[scheduled]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'boolean'),
description: 'Filter by scheduled status'
),
new OA\Parameter(
name: 'filter[start_at]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string', format: 'date'),
description: 'Filter results created on or after this date (alias for created_at>=)'
),
new OA\Parameter(
name: 'filter[end_at]',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string', format: 'date'),
description: 'Filter results created on or before this date (alias for created_at<=)'
),
new OA\Parameter(
name: 'sort',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string', enum: ['ping', '-ping', 'download', '-download', 'upload', '-upload', 'created_at', '-created_at', 'updated_at', '-updated_at']),
description: 'Sort results by field (prefix with - for descending)'
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
Expand Down
109 changes: 109 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,115 @@
],
"summary": "List all results",
"operationId": "listResults",
"parameters": [
{
"name": "per_page",
"in": "query",
"description": "Number of results per page",
"required": false,
"schema": {
"type": "integer",
"default": 25,
"maximum": 500,
"minimum": 1
}
},
{
"name": "filter[ping]",
"in": "query",
"description": "Filter by ping value (supports operators like >=, <=, etc.)",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "filter[download]",
"in": "query",
"description": "Filter by download speed (supports operators like >=, <=, etc.)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[upload]",
"in": "query",
"description": "Filter by upload speed (supports operators like >=, <=, etc.)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[healthy]",
"in": "query",
"description": "Filter by healthy status",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[status]",
"in": "query",
"description": "Filter by status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[scheduled]",
"in": "query",
"description": "Filter by scheduled status",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[start_at]",
"in": "query",
"description": "Filter results created on or after this date (alias for created_at>=)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "filter[end_at]",
"in": "query",
"description": "Filter results created on or before this date (alias for created_at<=)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "sort",
"in": "query",
"description": "Sort results by field (prefix with - for descending)",
"required": false,
"schema": {
"type": "string",
"enum": [
"ping",
"-ping",
"download",
"-download",
"upload",
"-upload",
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
}
}
],
"responses": {
"200": {
"description": "OK",
Expand Down