From 88731502062f3159ae687578bdf9244e9884a87f Mon Sep 17 00:00:00 2001 From: David Pavlovschii <154081173+davidpavlovschi@users.noreply.github.com> Date: Fri, 7 Aug 2026 16:00:35 +0300 Subject: [PATCH] fix(api): document X-Total-Count instead of non-existent X-Total header (#38717) The `CommitList` and `ChangedFileList` swagger responses documented an `X-Total` response header that their endpoints never send, they send `X-Total-Count` via `SetTotalCountHeader`. This renames the documented header and regenerates the spec. `repoGetAllCommits` also uses `CommitList` and sends both headers, so the new name is accurate for all three endpoints. Also corrects `ChangedFileList` describing its headers as commit counts. Documentation only, no handler behaviour changes. Fixes https://github.com/go-gitea/gitea/issues/22048 --------- Signed-off-by: davidpavlovschi Co-authored-by: silverwind --- routers/api/v1/swagger/repo.go | 8 ++++---- templates/swagger/v1-openapi3.generated.json | 8 ++++---- templates/swagger/v1-swagger.generated.json | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/routers/api/v1/swagger/repo.go b/routers/api/v1/swagger/repo.go index f95d363d7cf..50dbb91d3b1 100644 --- a/routers/api/v1/swagger/repo.go +++ b/routers/api/v1/swagger/repo.go @@ -248,7 +248,7 @@ type swaggerCommitList struct { PerPage int `json:"X-PerPage"` // Total commit count - Total int `json:"X-Total"` + Total int `json:"X-Total-Count"` // Total number of pages PageCount int `json:"X-PageCount"` @@ -266,11 +266,11 @@ type swaggerChangedFileList struct { // The current page Page int `json:"X-Page"` - // Commits per page + // Files per page PerPage int `json:"X-PerPage"` - // Total commit count - Total int `json:"X-Total"` + // Total file count + Total int `json:"X-Total-Count"` // Total number of pages PageCount int `json:"X-PageCount"` diff --git a/templates/swagger/v1-openapi3.generated.json b/templates/swagger/v1-openapi3.generated.json index 27f366e91a5..3e80ab6942a 100644 --- a/templates/swagger/v1-openapi3.generated.json +++ b/templates/swagger/v1-openapi3.generated.json @@ -213,14 +213,14 @@ } }, "X-PerPage": { - "description": "Commits per page", + "description": "Files per page", "schema": { "format": "int64", "type": "integer" } }, - "X-Total": { - "description": "Total commit count", + "X-Total-Count": { + "description": "Total file count", "schema": { "format": "int64", "type": "integer" @@ -311,7 +311,7 @@ "type": "integer" } }, - "X-Total": { + "X-Total-Count": { "description": "Total commit count", "schema": { "format": "int64", diff --git a/templates/swagger/v1-swagger.generated.json b/templates/swagger/v1-swagger.generated.json index 38dfac5d6ff..88d66299ba5 100644 --- a/templates/swagger/v1-swagger.generated.json +++ b/templates/swagger/v1-swagger.generated.json @@ -31247,12 +31247,12 @@ "X-PerPage": { "type": "integer", "format": "int64", - "description": "Commits per page" + "description": "Files per page" }, - "X-Total": { + "X-Total-Count": { "type": "integer", "format": "int64", - "description": "Total commit count" + "description": "Total file count" } } }, @@ -31311,7 +31311,7 @@ "format": "int64", "description": "Commits per page" }, - "X-Total": { + "X-Total-Count": { "type": "integer", "format": "int64", "description": "Total commit count"