forgejo/routers/api/v1/swagger
Myers Carpenter 00b457e291 feat: Add header annotations for accurate API documentation (#9380)
This will help api packages like https://codeberg.org/Cyborus/forgejo-api to generate clients that expose the header information as well. Currently `forgejo-api` has to edit the swagger json to generate a client crate that knows about headers.

- Create separate response types for different endpoint behaviors
- CommitList: Base type with only X-Total-Count header
- CommitListWithPagination: For GetPullRequestCommits (pagination headers + X-Total-Count)
- CommitListWithLegacyPagination: For GetAllCommits (pagination headers + X-Total-Count + deprecated X-Total)
- ChangedFileList: Base type with only X-Total-Count header
- ChangedFileListWithPagination: For GetPullRequestFiles (pagination headers + X-Total-Count)

This ensures swagger documentation accurately reflects which headers each endpoint returns.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9380
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: Cyborus <cyborus@disroot.org>
Co-authored-by: Myers Carpenter <myers@maski.org>
Co-committed-by: Myers Carpenter <myers@maski.org>
2026-01-06 10:29:15 +01:00
..
action.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
activity.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
activitypub.go fix: add stub outboxes to actors (#10120) 2025-12-01 16:51:35 +01:00
app.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
cron.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
issue.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
key.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
misc.go chore: branding import path (#7337) 2025-03-27 19:40:14 +00:00
nodeinfo.go chore: branding import path (#7337) 2025-03-27 19:40:14 +00:00
notify.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
options.go feat: add HTTP API endpoint for runner registration (#10677) 2026-01-05 04:59:04 +01:00
org.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
package.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
quota.go chore: branding import path (#7337) 2025-03-27 19:40:14 +00:00
repo.go feat: Add header annotations for accurate API documentation (#9380) 2026-01-06 10:29:15 +01:00
settings.go chore: branding import path (#7337) 2025-03-27 19:40:14 +00:00
user.go chore: branding import path (#7337) 2025-03-27 19:40:14 +00:00