Skip to content
GitLab
Next
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • GitLab GitLab
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 44,761
    • Issues 44,761
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 1,332
    • Merge requests 1,332
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.orgGitLab.org
  • GitLabGitLab
  • Issues
  • #347211
Closed
Open
Issue created Dec 06, 2021 by Pedro Pombeiro@pedropombeiro4️⃣Developer10 of 10 checklist items completed10/10 checklist items

Rename runner model's active flag to paused

The boolean active flag from the CiRunner model is not as clearly named as it could be. We should invert its meaning to paused so that its intent is clearer. This involves the following changes:

  • Changing the database model (we may want to skip this due to the migration that it involves)
  • GraphQL:
    • Deprecating the active field in the CiRunner GraphQL model (!79017 (merged));
    • Deprecating the active field in the RunnerUpdateInput GraphQL structure (!79131 (merged));
    • Deprecating the active filter in the Query.runners GraphQL query (!79018 (merged));
    • Adding a paused field to the CiRunner GraphQL model (!79017 (merged));
    • Adding a paused field in the RunnerUpdateInput GraphQL structure (!79131 (merged));
    • Adding a paused filter to the Query.runners GraphQL query (!79018 (merged));
  • REST:
    • Add a paused field to the API::Ci::Runner :runners GET resource and :runner POST resource;
    • Deprecate the active field in endpoits returning Runner entities, such as:
      • GET /runners (!79244 (merged)/!79349 (merged))
      • POST /runners (!79244 (merged))
      • GET /runners/all (!79244 (merged)/!79349 (merged))
      • GET /runners/:id (!79244 (merged)) / PUT /runners/:id (!79244 (merged))
      • PUT --form "active=false" /runners/:runner_id (!79244 (merged))
      • GET /projects/:id/runners (!79244 (merged)/!79349 (merged)) / POST /projects/:id/runners (!79244 (merged))
      • GET /groups/:id/runners (!79244 (merged)/!79349 (merged))
    • gitlab-runner!3414 (merged) - Adapt Runner to use paused argument instead of active for registration with the PUT /runners/:id endpoint (gitlab-runner#28844 (closed) - only in %15.0 to avoid backward compatibility issues).

Deprecation issue: API: Runner "active" nomenclature changed to "p... (#351109)

Edited Apr 26, 2022 by Pedro Pombeiro
Assignee
Assign to
Time tracking