references/gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-06-14 03:29:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(api): add sort and order query parameters to job list endpoints (#37672)

Browse Source 
Adds `sort` and `order` query parameters to all action job list API
endpoints (`/admin/actions/jobs`, `/repos/{owner}/{repo}/actions/jobs`,
`/repos/{owner}/{repo}/actions/runs/{run}/jobs`, `/user/actions/jobs`),
following the existing `OrderByMap` pattern used by repo/user search
endpoints.

- Default is `id` / `asc` (backwards compatible — matches previous DB
natural order)
- Only `id` sort field for now; the map is extensible for future fields
- Returns 422 for invalid sort/order values
- `ToOrders()` returns empty string when `OrderBy` is unset, so internal
callers (webhook dispatch, concurrency checks) are unaffected

Closes: #37666
Supersedes: #37667
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: silverwind <me@silverwind.io>
This commit is contained in:
Matt Schoen
2026-05-13 06:11:02 -07:00
committed by GitHub
parent 187daac598
commit a564f0587a
12 changed files with 306 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
templates/swagger/v1_json.tmpl
Generated
+60
View File
@@ -49,6 +49,18 @@
"description": "page size of results",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"name": "sort",
"in": "query"
},
{
"type": "string",
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"name": "order",
"in": "query"
}
],
"responses": {
@@ -60,6 +72,9 @@
},
"404": {
"$ref": "#/responses/notFound"
},
"422": {
"$ref": "#/responses/validationError"
}
}
}
@@ -4918,6 +4933,18 @@
"description": "page size of results",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"name": "sort",
"in": "query"
},
{
"type": "string",
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"name": "order",
"in": "query"
}
],
"responses": {
@@ -4929,6 +4956,9 @@
},
"404": {
"$ref": "#/responses/notFound"
},
"422": {
"$ref": "#/responses/validationError"
}
}
}
@@ -5646,6 +5676,18 @@
"description": "page size of results",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"name": "sort",
"in": "query"
},
{
"type": "string",
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"name": "order",
"in": "query"
}
],
"responses": {
@@ -5657,6 +5699,9 @@
},
"404": {
"$ref": "#/responses/notFound"
},
"422": {
"$ref": "#/responses/validationError"
}
}
}
@@ -18911,6 +18956,18 @@
"description": "page size of results",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"name": "sort",
"in": "query"
},
{
"type": "string",
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"name": "order",
"in": "query"
}
],
"responses": {
@@ -18922,6 +18979,9 @@
},
"404": {
"$ref": "#/responses/notFound"
},
"422": {
"$ref": "#/responses/validationError"
}
}
}
templates/swagger/v1_openapi3_json.tmpl
+76
View File
@@ -10630,6 +10630,22 @@
"schema": {
"type": "integer"
}
},
{
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"in": "query",
"name": "sort",
"schema": {
"type": "string"
}
},
{
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"in": "query",
"name": "order",
"schema": {
"type": "string"
}
}
],
"responses": {
@@ -10641,6 +10657,9 @@
},
"404": {
"$ref": "#/components/responses/notFound"
},
"422": {
"$ref": "#/components/responses/validationError"
}
},
"summary": "Lists all jobs",
@@ -15728,6 +15747,22 @@
"schema": {
"type": "integer"
}
},
{
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"in": "query",
"name": "sort",
"schema": {
"type": "string"
}
},
{
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"in": "query",
"name": "order",
"schema": {
"type": "string"
}
}
],
"responses": {
@@ -15739,6 +15774,9 @@
},
"404": {
"$ref": "#/components/responses/notFound"
},
"422": {
"$ref": "#/components/responses/validationError"
}
},
"summary": "Lists all jobs for a repository",
@@ -16526,6 +16564,22 @@
"schema": {
"type": "integer"
}
},
{
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"in": "query",
"name": "sort",
"schema": {
"type": "string"
}
},
{
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"in": "query",
"name": "order",
"schema": {
"type": "string"
}
}
],
"responses": {
@@ -16537,6 +16591,9 @@
},
"404": {
"$ref": "#/components/responses/notFound"
},
"422": {
"$ref": "#/components/responses/validationError"
}
},
"summary": "Lists all jobs for a workflow run",
@@ -30884,6 +30941,22 @@
"schema": {
"type": "integer"
}
},
{
"description": "sort jobs by attribute. Supported values are \"id\". Default is \"id\"",
"in": "query",
"name": "sort",
"schema": {
"type": "string"
}
},
{
"description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\"",
"in": "query",
"name": "order",
"schema": {
"type": "string"
}
}
],
"responses": {
@@ -30895,6 +30968,9 @@
},
"404": {
"$ref": "#/components/responses/notFound"
},
"422": {
"$ref": "#/components/responses/validationError"
}
},
"summary": "Get workflow jobs",