Skip to content

[Schema Inaccuracy] Set deprecation keys for actions/re-run-workflow operation #554

Closed
@gr2m

Description

@gr2m

Schema Inaccuracy

In the latest update, the POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun operation was deprecated using the description, but the deprecation flags were not set accordingly. We need the deprecation flag and ideally the deprecationDate/removalDate keys to give Octokit users proper deprecation messages and help them migrate to the new endpoint

    "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": {
      "post": {
        "summary": "Re-run a workflow",
        "description": "**Deprecation Notice:** This endpoint is deprecated.\nWe recommend migrating your existing code to use the new [retry workflow](https://docs.github.com/rest/reference/actions#retry-a-workflow) endpoint.\n\nRe-runs your workflow run using its `id`. You must authenticate using\nan access token with the `repo` scope to use this endpoint. GitHub Apps must have\nthe `actions:write` permission to use this endpoint.",
        "tags": ["actions"],
        "operationId": "actions/re-run-workflow",
        "externalDocs": {
          "description": "API method documentation",
          "url": "https://docs.github.com/rest/reference/actions#re-run-a-workflow"
        },
        "parameters": [
          { "$ref": "#/components/parameters/owner" },
          { "$ref": "#/components/parameters/repo" },
          { "$ref": "#/components/parameters/run-id" }
        ],
        "responses": {
          "201": {
            "description": "Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": false
                }
              }
            }
          }
        },
        "x-github": {
          "githubCloudOnly": false,
          "enabledForGitHubApps": false,
          "previews": [],
          "category": "actions",
          "subcategory": "workflow-runs"
        },
        "x-octokit": {}
      }
    },

Expected

        "x-github": {
          "removalDate": "2020-11-13",
          "deprecationDate": "2020-02-14",
        },
        "deprecated": true,

Reproduction Steps

n/a

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions