Merge pull request #319 from snyk/docs/automatic-api-docs-update

Generate API docs from spec

docs/.gitbook/assets/rest-spec.json

@@ -5622,12 +5622,6 @@
         "additionalProperties": false,
         "minProperties": 1,
         "properties": {
-          "branch_name": {
-            "description": "The name of the branch that will be created when the pull request is created",
-            "example": "chore/bump-{{package_name}}-{{package_from}}-{{package_to}}",
-            "minLength": 1,
-            "type": "string"
-          },
           "commit_message": {
             "description": "The commit message that will be used when the pull request is created",
             "example": "chore(deps): bump {{package_name}} from {{package_from}} to {{package_to}}",
@@ -54925,7 +54919,7 @@
       "name": "Projects"
     },
     {
-      "description": "Snyk pull request templates allow you to control title, description, commit message and branch name.",
+      "description": "Snyk pull request templates allow you to control title, description, commit message.",
       "name": "Pull Request Templates"
     },
     {
@@ -54955,5 +54949,5 @@
   ],
   "x-optic-url": "https://app.useoptic.com/organizations/390ef489-882c-48ba-acb3-4e0b73e48767/apis/5Tz5UMTNEIuz5-FZ6J2ki",
   "x-snyk-api-lifecycle": "released",
-  "x-snyk-api-version": "2024-06-06"
+  "x-snyk-api-version": "2024-06-18"
 }

docs/snyk-api/rest-api/changelog.md

@@ -1,3 +1,16 @@
+## 2024-06-18
+
+### POST - `/groups/{group_id}/settings/pull_request_template` - Updated
+- removed the request property `data/attributes/branch_name`
+![Badge](https://img.shields.io/badge/Breaking-yellow)
+- removed the optional property `data/attributes/branch_name` from the response with the `201` status
+![Badge](https://img.shields.io/badge/Breaking-yellow)
+
+
+### GET - `/groups/{group_id}/settings/pull_request_template` - Updated
+- removed the optional property `data/attributes/branch_name` from the response with the `200` status
+![Badge](https://img.shields.io/badge/Breaking-yellow)
+
 ## 2024-06-06
 
 ### GET - `/orgs/{org_id}/projects` - Updated

tools/api-docs-generator/sync-state.yml

@@ -1 +1 @@
-lastSyncedVersion: "2024-06-06"
+lastSyncedVersion: "2024-06-18"