jojo/routers/api/v1/swagger
ShellWen a85c527709 feat(api): add REST API endpoints for Actions artifacts (#12140)
## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).

### Tests for Go changes

- I added test coverage for Go changes...
  - [ ] in their respective `*_test.go` for unit tests.
  - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I ran...
  - [x] `make pr-go` before pushing

### Tests for JavaScript changes

(not applicable — Go-only change)

### Documentation

- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [ ] I did not document these changes and I do not expect someone else to do it.

### Release notes

- [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change.
- [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change.

## Summary

Add public REST API endpoints under `/api/v1/` for listing, inspecting, downloading, and deleting Actions artifacts. Previously, artifacts could only be accessed through the web UI or the internal runner API.

### New endpoints

| Method | Path | Description |
|--------|------|-------------|
| `GET` | `/repos/{owner}/{repo}/actions/artifacts` | List all artifacts for a repository |
| `GET` | `/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts` | List artifacts for a workflow run |
| `GET` | `/repos/{owner}/{repo}/actions/artifacts/{artifact_id}` | Get artifact metadata |
| `GET` | `/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/zip` | Download artifact as zip |
| `DELETE` | `/repos/{owner}/{repo}/actions/artifacts/{artifact_id}` | Delete an artifact |

- List endpoints support `page`, `limit`, and `name` query parameters
- Both v1-v3 (multi-file, zip on-the-fly) and v4 (single zip) artifact backends are supported
- Expired artifacts are listed with `expired: true` but cannot be downloaded
- Delete requires write permission; all other endpoints require read permission

Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12140
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
Co-authored-by: ShellWen <me@shellwen.com>
Co-committed-by: ShellWen <me@shellwen.com>
2026-04-20 05:10:54 +02: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: Follow remote users; feed tab (#10380) 2026-04-12 03:31:03 +02: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(api): add REST API endpoints for Actions artifacts (#12140) 2026-04-20 05:10:54 +02: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