diff --git a/routers/api/v1/repo/action.go b/routers/api/v1/repo/action.go index f3ac72591e..b858c17890 100644 --- a/routers/api/v1/repo/action.go +++ b/routers/api/v1/repo/action.go @@ -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). diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 5e31bf1cd5..ccd3087473 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -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