upstream/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2026-05-28 11:14:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Use folded block scalar (> not |) for repoGetActionJobLogs/repoGetActionRunLogs swagger descriptions so Go-comment line breaks fold to spaces instead of rendering as hard breaks in the HTML docs, regen swagger spec

Browse source
This commit is contained in:
Zach Handley 2026-05-27 08:13:57 -07:00
parent 900d63a42a
commit 5cc8009f15
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
routers/api/v1/repo/action.go
View file

@ -1479,7 +1479,7 @@ func GetActionJobLogs(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs repository repoGetActionJobLogs
// ---
// summary: Download the plaintext logs of an action job
// description: |
// description: >
// Returns the plaintext log for the job. By default the log for the
// most recent attempt is returned (ActionRunJob.TaskID tracks the latest
// task). Pass `?attempt=N` to fetch the log for a specific historical
@ -1591,7 +1591,7 @@ func GetActionRunLogs(ctx *context.APIContext) {
// required: true
// - name: run_id
// in: path
// description: |
// description: >
// ID of the workflow run. The ZIP contains logs for the latest attempt
// of each job in the run, with each entry named `{job-name}-{job-id}.log`
// (the job ID prevents collisions when two jobs share a name).

4
templates/swagger/v1_json.tmpl generated
View file

@ -5812,7 +5812,7 @@
},
"/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": {
"get": {
"description": "Returns the plaintext log for the job. By default the log for the\nmost recent attempt is returned (ActionRunJob.TaskID tracks the latest\ntask). Pass `?attempt=N` to fetch the log for a specific historical\nattempt; the value matches the `attempt` field returned by the job\nlisting endpoints.\n",
"description": "Returns the plaintext log for the job. By default the log for the most recent attempt is returned (ActionRunJob.TaskID tracks the latest task). Pass `?attempt=N` to fetch the log for a specific historical attempt; the value matches the `attempt` field returned by the job listing endpoints.\n",
"produces": [
"text/plain"
],
@ -6506,7 +6506,7 @@
{
"type": "integer",
"format": "int64",
"description": "ID of the workflow run. The ZIP contains logs for the latest attempt\nof each job in the run, with each entry named `{job-name}-{job-id}.log`\n(the job ID prevents collisions when two jobs share a name).\n",
"description": "ID of the workflow run. The ZIP contains logs for the latest attempt of each job in the run, with each entry named `{job-name}-{job-id}.log` (the job ID prevents collisions when two jobs share a name).\n",
"name": "run_id",
"in": "path",
"required": true