Update api endpoint version

madkoo · madkoo · commit d57526e2b3cb · 2026-03-27T14:30:16.000+02:00
diff --git a/app.yml b/app.yml
@@ -115,7 +115,7 @@ default_permissions:
     organization_administration: write
 
     # Manage Actions variables.
-    # https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28
+    # https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10
     actions_variables: write
 
 
diff --git a/docs/github-settings/1. repository-settings.md b/docs/github-settings/1. repository-settings.md
@@ -50,8 +50,8 @@ repository:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Update an environment](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository)
->2. [Replace all repository topics](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#replace-all-repository-topics)
+>1. [Update an environment](https://docs.github.com/en/rest/repos/repos?apiVersion=2026-03-10#update-a-repository)
+>2. [Replace all repository topics](https://docs.github.com/en/rest/repos/repos?apiVersion=2026-03-10#replace-all-repository-topics)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/2. repository-variables.md b/docs/github-settings/2. repository-variables.md
@@ -18,7 +18,7 @@ variables:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Update a repository variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#update-a-repository-variable)
+>1. [Update a repository variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#update-a-repository-variable)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/3. collaborators.md b/docs/github-settings/3. collaborators.md
@@ -20,8 +20,8 @@ collaborators:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Add a repository collaborator](https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28#add-a-repository-collaborator)
->2. [Remove a repository collaborator](https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28#remove-a-repository-collaborator)
+>1. [Add a repository collaborator](https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2026-03-10#add-a-repository-collaborator)
+>2. [Remove a repository collaborator](https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2026-03-10#remove-a-repository-collaborator)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/4. teams.md b/docs/github-settings/4. teams.md
@@ -20,7 +20,7 @@ teams:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Add or update team repository permissions](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#add-or-update-team-repository-permissions)
+>1. [Add or update team repository permissions](https://docs.github.com/en/rest/teams/teams?apiVersion=2026-03-10#add-or-update-team-repository-permissions)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/5. branch-protection.md b/docs/github-settings/5. branch-protection.md
@@ -55,7 +55,7 @@ branches:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Update a repository variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#update-a-repository-variable)
+>1. [Update a repository variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#update-a-repository-variable)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/6. deployment-environments.md b/docs/github-settings/6. deployment-environments.md
@@ -46,9 +46,9 @@ environments:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Create or update an environment](https://docs.github.com/en/rest/deployments/environments?apiVersion=2022-11-28#create-or-update-an-environment)
->2. [Create a deployment branch policy](https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#create-a-deployment-branch-policy)
->3. [Create an environment variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#create-an-environment-variable)
+>1. [Create or update an environment](https://docs.github.com/en/rest/deployments/environments?apiVersion=2026-03-10#create-or-update-an-environment)
+>2. [Create a deployment branch policy](https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2026-03-10#create-a-deployment-branch-policy)
+>3. [Create an environment variable](https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#create-an-environment-variable)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/7. autolinks.md b/docs/github-settings/7. autolinks.md
@@ -20,7 +20,7 @@ variables:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Create an autolink reference for a repository](https://docs.github.com/en/rest/repos/autolinks?apiVersion=2022-11-28#create-an-autolink-reference-for-a-repository)
+>1. [Create an autolink reference for a repository](https://docs.github.com/en/rest/repos/autolinks?apiVersion=2026-03-10#create-an-autolink-reference-for-a-repository)
 
 <table>
 <tr><td>
diff --git a/docs/github-settings/8. labels.md b/docs/github-settings/8. labels.md
@@ -19,9 +19,9 @@ labels:
 
 >[!TIP]
 >GitHub's API documentation defines these inputs and types:
->1. [Create a label](https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#create-a-label)
->2. [Update a label](https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#update-a-label)
->3. [Delete a label](https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#delete-a-label)
+>1. [Create a label](https://docs.github.com/en/rest/issues/labels?apiVersion=2026-03-10#create-a-label)
+>2. [Update a label](https://docs.github.com/en/rest/issues/labels?apiVersion=2026-03-10#update-a-label)
+>3. [Delete a label](https://docs.github.com/en/rest/issues/labels?apiVersion=2026-03-10#delete-a-label)
 
 <table>
 <tr><td>
diff --git a/docs/sample-settings/settings.yml b/docs/sample-settings/settings.yml
@@ -1,7 +1,7 @@
 # This settings file can be used to create org-level settings
 
 # This is the settings that need to be applied to all repositories in the org
-# See https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#create-an-organization-repository for all available settings for a repository
+# See https://docs.github.com/en/rest/repos/repos?apiVersion=2026-03-10#create-an-organization-repository for all available settings for a repository
 repository:
   # A short description of the repository that will show up on GitHub
   description: description of the repo
@@ -123,7 +123,7 @@ milestones:
     state: open
 
 # Collaborators: give specific users access to any repository.
-# See https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28#add-a-repository-collaborator for available options
+# See https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2026-03-10#add-a-repository-collaborator for available options
 collaborators:
   - username: regpaco
     # The permission to grant the collaborator. Can be one of:
@@ -144,7 +144,7 @@ collaborators:
       - another-repo
 
 # Teams
-# See https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#create-a-team for available options
+# See https://docs.github.com/en/rest/teams/teams?apiVersion=2026-03-10#create-a-team for available options
 teams:
   - name: core
     # The permission to grant the team. Can be one of:
@@ -163,7 +163,7 @@ teams:
     visibility: closed
 
 # Branch protection rules
-# See https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#update-branch-protection for available options
+# See https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2026-03-10#update-branch-protection for available options
 branches:
   # If the name of the branch value is specified as `default`, then the app will create a branch protection rule to apply against the default branch in the repo
   - name: default
@@ -202,7 +202,7 @@ branches:
         teams: []
 
 # Custom properties
-# See https://docs.github.com/en/rest/repos/custom-properties?apiVersion=2022-11-28
+# See https://docs.github.com/en/rest/repos/custom-properties?apiVersion=2026-03-10
 custom_properties:
   - name: test
     value: test
@@ -221,7 +221,7 @@ validator:
   pattern: "[a-zA-Z0-9_-]+"
 
 # Rulesets
-# See https://docs.github.com/en/rest/orgs/rules?apiVersion=2022-11-28#create-an-organization-repository-rulesetfor available options
+# See https://docs.github.com/en/rest/orgs/rules?apiVersion=2026-03-10#create-an-organization-repository-rulesetfor available options
 rulesets:
   - name: Template
     # The target of the ruleset. Can be one of:
diff --git a/index.js b/index.js
@@ -407,7 +407,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
           repo: env.ADMIN_REPO,
           path: oldPath,
           headers: {
-            'X-GitHub-Api-Version': '2022-11-28'
+            'X-GitHub-Api-Version': '2026-03-10'
           }
         })
         let content = Buffer.from(repofile.data.content, 'base64').toString()
@@ -418,10 +418,10 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
           // Check if a config file already exists for the renamed repo name
           await context.octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {
             owner: payload.repository.owner.login,
-            repo: env.ADMIN_REPO,
+            repo: env.ADMIN_REPO, 
             path: newPath,
             headers: {
-              'X-GitHub-Api-Version': '2022-11-28'
+              'X-GitHub-Api-Version': '2026-03-10'
             }
           })
         } catch (error) {
@@ -436,7 +436,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
               message: `Repo Renamed and safe-settings renamed the file from ${payload.changes.repository.name.from} to ${payload.repository.name}`,
               sha: repofile.data.sha,
               headers: {
-                'X-GitHub-Api-Version': '2022-11-28'
+                'X-GitHub-Api-Version': '2026-03-10'
               }
             })
             robot.log.debug(`Created a new setting file ${newPath}`)
diff --git a/lib/plugins/autolinks.js b/lib/plugins/autolinks.js
@@ -19,7 +19,7 @@ module.exports = class Autolinks extends Diffable {
   changed (existing, attr) {
     // is_alphanumeric was added mid-2023. In order to continue to support settings yamls which dont specify this
     // attribute, consider an unset is_alphanumeric as `true` (since that is the default value in the API)
-    // https://docs.github.com/en/rest/repos/autolinks?apiVersion=2022-11-28#create-an-autolink-reference-for-a-repository
+    // https://docs.github.com/en/rest/repos/autolinks?apiVersion=2026-03-10#create-an-autolink-reference-for-a-repository
     const isAlphaNumericMatch = attr.is_alphanumeric === undefined
       ? existing.is_alphanumeric // === true, the default
       : attr.is_alphanumeric === existing.is_alphanumeric
diff --git a/lib/plugins/collaborators.js b/lib/plugins/collaborators.js
@@ -15,7 +15,7 @@ module.exports = class Collaborators extends Diffable {
   }
 
   find () {
-    // https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28
+    // https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2026-03-10
     // 'outside' means all outside collaborators of an organization-owned repository.
     // 'direct' means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. (includes outside collaborators)
     // 'all' means all collaborators the authenticated user can see.
diff --git a/lib/plugins/rulesets.js b/lib/plugins/rulesets.js
@@ -12,7 +12,7 @@ const overrides = {
 }
 
 const version = {
-  'X-GitHub-Api-Version': '2022-11-28'
+  'X-GitHub-Api-Version': '2026-03-10'
 }
 module.exports = class Rulesets extends Diffable {
   constructor (nop, github, repo, entries, log, errors, scope) {
diff --git a/lib/plugins/variables.js b/lib/plugins/variables.js
@@ -16,7 +16,7 @@ module.exports = class Variables extends Diffable {
   /**
      * Look-up existing variables for a given repository
      *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#list-repository-variables} list repository variables
+     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#list-repository-variables} list repository variables
      * @returns {Array.<object>} Returns a list of variables that exist in a repository
      */
   async find () {
@@ -81,7 +81,7 @@ module.exports = class Variables extends Diffable {
      * @param {Array.<object>} existing Existing variables defined in the repository
      * @param {Array.<object>} variables Variables that we have defined as code
      *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#update-a-repository-variable} update a repository variable
+     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#update-a-repository-variable} update a repository variable
      * @returns
      */
   async update (existing, variables = []) {
@@ -150,7 +150,7 @@ module.exports = class Variables extends Diffable {
      *
      * @param {object} variable The variable to add, with name and value
      *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#create-a-repository-variable} create a repository variable
+     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#create-a-repository-variable} create a repository variable
      * @returns
      */
   async add (variable) {
@@ -175,7 +175,7 @@ module.exports = class Variables extends Diffable {
      *
      * @param {String} existing Name of the existing variable to remove
      *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2022-11-28#delete-a-repository-variable} delete a repository variable
+     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#delete-a-repository-variable} delete a repository variable
      * @returns
      */
   async remove (existing) {
diff --git a/lib/settings.js b/lib/settings.js
@@ -607,7 +607,7 @@ ${this.results.reduce((x, y) => {
       this.log.debug(` In getRepoConfigMap ${JSON.stringify(this.repo)}`)
       // GitHub getContent api has a hard limit of returning 1000 entries without
       // any pagination. They suggest to use Tree api.
-      // https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content
+      // https://docs.github.com/en/rest/repos/contents?apiVersion=2026-03-10#get-repository-content
 
       // get <CONFIG_PATH>/repos directory sha to use in the getTree api
       const repo = { owner: this.repo.owner, repo: env.ADMIN_REPO }
diff --git a/schema/settings.json b/schema/settings.json
@@ -5,7 +5,7 @@
     "repositories": {
       "allOf": [
         {
-          "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2022-11-28.json#/paths/~1repos~1{owner}~1{repo}/patch/requestBody/content/application~1json/schema"
+          "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}/patch/requestBody/content/application~1json/schema"
         },
         {
           "type": "object",
@@ -105,7 +105,7 @@
       "items": {
         "allOf": [
           {
-            "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2022-11-28.json#/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}/put/requestBody/content/application~1json/schema"
+            "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}/put/requestBody/content/application~1json/schema"
           },
           {
             "type": "object",
@@ -136,7 +136,7 @@
       "description": "Teams",
       "type": "array",
       "items": {
-        "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2022-11-28.json#/paths/~1orgs~1{org}~1teams/post/requestBody/content/application~1json/schema"
+        "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json#/paths/~1orgs~1{org}~1teams/post/requestBody/content/application~1json/schema"
       }
     },
     "branches": {
@@ -149,7 +149,7 @@
             "type": "string"
           },
           "protection": {
-            "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2022-11-28.json#/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection/put/requestBody/content/application~1json/schema"
+            "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection/put/requestBody/content/application~1json/schema"
           }
         }
       }
@@ -173,7 +173,7 @@
       "description": "Autolinks",
       "type": "array",
       "items": {
-        "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2022-11-28.json#/paths/~1repos~1{owner}~1{repo}~1autolinks/post/requestBody/content/application~1json/schema"
+        "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json#/paths/~1repos~1{owner}~1{repo}~1autolinks/post/requestBody/content/application~1json/schema"
       }
     },
     "validator": {
@@ -189,7 +189,7 @@
       "description": "Rulesets",
       "type": "array",
       "items": {
-        "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2022-11-28.json#/paths/~1orgs~1{org}~1rulesets/post/requestBody/content/application~1json/schema"
+        "$ref": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.2026-03-10.json#/paths/~1orgs~1{org}~1rulesets/post/requestBody/content/application~1json/schema"
       }
     }
   }
diff --git a/test/unit/lib/plugins/rulesets.test.js b/test/unit/lib/plugins/rulesets.test.js
@@ -3,7 +3,7 @@
 const { when } = require('jest-when')
 const Rulesets = require('../../../../lib/plugins/rulesets')
 const version = {
-  'X-GitHub-Api-Version': '2022-11-28'
+  'X-GitHub-Api-Version': '2026-03-10'
 }
 const repo_conditions = {
   ref_name: {
