@octokit/openapi 7.0.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/generated/api.github.com.deref.json +831 -48
  2. package/generated/api.github.com.json +456 -36
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +1 -8
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -8
  7. package/generated/ghes-3.2.deref.json +618 -37
  8. package/generated/ghes-3.2.json +437 -31
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +618 -37
  12. package/generated/ghes-3.3.json +437 -31
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -8
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -8
  15. package/generated/ghes-3.4.deref.json +618 -37
  16. package/generated/ghes-3.4.json +437 -31
  17. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  18. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  19. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +1 -8
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.json +1 -8
  21. package/generated/ghes-3.5.deref.json +620 -39
  22. package/generated/ghes-3.5.json +439 -33
  23. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +0 -56
  24. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +1 -164
  25. package/generated/ghes-3.6-diff-to-api.github.com.json +1 -130
  26. package/generated/ghes-3.6.deref.json +622 -53
  27. package/generated/ghes-3.6.json +441 -47
  28. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -8
  29. package/generated/github.ae-diff-to-api.github.com.json +1 -8
  30. package/generated/github.ae.deref.json +613 -32
  31. package/generated/github.ae.json +437 -31
  32. package/index.js +2 -0
  33. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.0.0",
4
+ "version": "7.1.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -113326,13 +113326,6 @@
113326
113326
  "permission": {
113327
113327
  "type": "string",
113328
113328
  "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
113329
- "enum": [
113330
- "pull",
113331
- "push",
113332
- "admin",
113333
- "maintain",
113334
- "triage"
113335
- ],
113336
113329
  "default": "push"
113337
113330
  }
113338
113331
  }
@@ -130748,7 +130741,7 @@
130748
130741
  "/repos/{owner}/{repo}/actions/permissions/access": {
130749
130742
  "get": {
130750
130743
  "summary": "Get the level of access for workflows outside of the repository",
130751
- "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
130744
+ "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
130752
130745
  "tags": [
130753
130746
  "actions"
130754
130747
  ],
@@ -130817,17 +130810,11 @@
130817
130810
  "category": "actions",
130818
130811
  "subcategory": "permissions"
130819
130812
  },
130820
- "x-octokit": {
130821
- "diff": {
130822
- "api.github.com": {
130823
- "type": "changed"
130824
- }
130825
- }
130826
- }
130813
+ "x-octokit": {}
130827
130814
  },
130828
130815
  "put": {
130829
130816
  "summary": "Set the level of access for workflows outside of the repository",
130830
- "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
130817
+ "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
130831
130818
  "tags": [
130832
130819
  "actions"
130833
130820
  ],
@@ -130899,13 +130886,7 @@
130899
130886
  "category": "actions",
130900
130887
  "subcategory": "permissions"
130901
130888
  },
130902
- "x-octokit": {
130903
- "diff": {
130904
- "api.github.com": {
130905
- "type": "changed"
130906
- }
130907
- }
130908
- }
130889
+ "x-octokit": {}
130909
130890
  }
130910
130891
  },
130911
130892
  "/repos/{owner}/{repo}/actions/permissions/selected-actions": {
@@ -195648,13 +195629,6 @@
195648
195629
  "permission": {
195649
195630
  "type": "string",
195650
195631
  "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**",
195651
- "enum": [
195652
- "pull",
195653
- "push",
195654
- "admin",
195655
- "maintain",
195656
- "triage"
195657
- ],
195658
195632
  "default": "push"
195659
195633
  }
195660
195634
  }
@@ -215725,7 +215699,13 @@
215725
215699
  "type": "object",
215726
215700
  "properties": {
215727
215701
  "type": {
215728
- "type": "string"
215702
+ "type": "string",
215703
+ "enum": [
215704
+ "dir",
215705
+ "file",
215706
+ "submodule",
215707
+ "symlink"
215708
+ ]
215729
215709
  },
215730
215710
  "size": {
215731
215711
  "type": "integer"
@@ -215806,7 +215786,10 @@
215806
215786
  "type": "object",
215807
215787
  "properties": {
215808
215788
  "type": {
215809
- "type": "string"
215789
+ "type": "string",
215790
+ "enum": [
215791
+ "file"
215792
+ ]
215810
215793
  },
215811
215794
  "encoding": {
215812
215795
  "type": "string"
@@ -215899,7 +215882,10 @@
215899
215882
  "type": "object",
215900
215883
  "properties": {
215901
215884
  "type": {
215902
- "type": "string"
215885
+ "type": "string",
215886
+ "enum": [
215887
+ "symlink"
215888
+ ]
215903
215889
  },
215904
215890
  "target": {
215905
215891
  "type": "string"
@@ -215975,12 +215961,15 @@
215975
215961
  ]
215976
215962
  },
215977
215963
  {
215978
- "title": "Symlink Content",
215979
- "description": "An object describing a symlink",
215964
+ "title": "Submodule Content",
215965
+ "description": "An object describing a submodule",
215980
215966
  "type": "object",
215981
215967
  "properties": {
215982
215968
  "type": {
215983
- "type": "string"
215969
+ "type": "string",
215970
+ "enum": [
215971
+ "submodule"
215972
+ ]
215984
215973
  },
215985
215974
  "submodule_git_url": {
215986
215975
  "type": "string",
@@ -222549,15 +222538,15 @@
222549
222538
  },
222550
222539
  "/repos/{owner}/{repo}/environments": {
222551
222540
  "get": {
222552
- "summary": "Get all environments",
222553
- "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
222541
+ "summary": "List environments",
222542
+ "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
222554
222543
  "tags": [
222555
222544
  "repos"
222556
222545
  ],
222557
222546
  "operationId": "repos/get-all-environments",
222558
222547
  "externalDocs": {
222559
222548
  "description": "API method documentation",
222560
- "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-all-environments"
222549
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/environments#list-environments"
222561
222550
  },
222562
222551
  "parameters": [
222563
222552
  {
@@ -223156,7 +223145,7 @@
223156
223145
  "x-github": {
223157
223146
  "githubCloudOnly": false,
223158
223147
  "enabledForGitHubApps": true,
223159
- "category": "repos",
223148
+ "category": "deployments",
223160
223149
  "subcategory": "environments"
223161
223150
  },
223162
223151
  "x-octokit": {}
@@ -223165,7 +223154,7 @@
223165
223154
  "/repos/{owner}/{repo}/environments/{environment_name}": {
223166
223155
  "get": {
223167
223156
  "summary": "Get an environment",
223168
- "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
223157
+ "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the `repo` scope. GitHub\nApps must have the `actions:read` permission to use this endpoint.",
223169
223158
  "tags": [
223170
223159
  "repos"
223171
223160
  ],
@@ -223197,7 +223186,7 @@
223197
223186
  "name": "environment_name",
223198
223187
  "in": "path",
223199
223188
  "required": true,
223200
- "description": "The name of the environment",
223189
+ "description": "The name of the environment.",
223201
223190
  "schema": {
223202
223191
  "type": "string"
223203
223192
  }
@@ -223751,7 +223740,7 @@
223751
223740
  },
223752
223741
  "put": {
223753
223742
  "summary": "Create or update an environment",
223754
- "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.",
223743
+ "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
223755
223744
  "tags": [
223756
223745
  "repos"
223757
223746
  ],
@@ -223783,7 +223772,7 @@
223783
223772
  "name": "environment_name",
223784
223773
  "in": "path",
223785
223774
  "required": true,
223786
- "description": "The name of the environment",
223775
+ "description": "The name of the environment.",
223787
223776
  "schema": {
223788
223777
  "type": "string"
223789
223778
  }
@@ -223847,6 +223836,27 @@
223847
223836
  }
223848
223837
  },
223849
223838
  "additionalProperties": false
223839
+ },
223840
+ "examples": {
223841
+ "default": {
223842
+ "value": {
223843
+ "wait_timer": 30,
223844
+ "reviewers": [
223845
+ {
223846
+ "type": "User",
223847
+ "id": 1
223848
+ },
223849
+ {
223850
+ "type": "Team",
223851
+ "id": 1
223852
+ }
223853
+ ],
223854
+ "deployment_branch_policy": {
223855
+ "protected_branches": false,
223856
+ "custom_branch_policies": true
223857
+ }
223858
+ }
223859
+ }
223850
223860
  }
223851
223861
  }
223852
223862
  }
@@ -224457,7 +224467,7 @@
224457
224467
  "name": "environment_name",
224458
224468
  "in": "path",
224459
224469
  "required": true,
224460
- "description": "The name of the environment",
224470
+ "description": "The name of the environment.",
224461
224471
  "schema": {
224462
224472
  "type": "string"
224463
224473
  }
@@ -224477,6 +224487,559 @@
224477
224487
  "x-octokit": {}
224478
224488
  }
224479
224489
  },
224490
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
224491
+ "get": {
224492
+ "summary": "List deployment branch policies",
224493
+ "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
224494
+ "tags": [
224495
+ "repos"
224496
+ ],
224497
+ "operationId": "repos/list-deployment-branch-policies",
224498
+ "externalDocs": {
224499
+ "description": "API method documentation",
224500
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#list-deployment-branch-policies"
224501
+ },
224502
+ "parameters": [
224503
+ {
224504
+ "name": "owner",
224505
+ "description": "The account owner of the repository. The name is not case sensitive.",
224506
+ "in": "path",
224507
+ "required": true,
224508
+ "schema": {
224509
+ "type": "string"
224510
+ }
224511
+ },
224512
+ {
224513
+ "name": "repo",
224514
+ "description": "The name of the repository. The name is not case sensitive.",
224515
+ "in": "path",
224516
+ "required": true,
224517
+ "schema": {
224518
+ "type": "string"
224519
+ }
224520
+ },
224521
+ {
224522
+ "name": "environment_name",
224523
+ "in": "path",
224524
+ "required": true,
224525
+ "description": "The name of the environment.",
224526
+ "schema": {
224527
+ "type": "string"
224528
+ }
224529
+ },
224530
+ {
224531
+ "name": "per_page",
224532
+ "description": "The number of results per page (max 100).",
224533
+ "in": "query",
224534
+ "schema": {
224535
+ "type": "integer",
224536
+ "default": 30
224537
+ }
224538
+ },
224539
+ {
224540
+ "name": "page",
224541
+ "description": "Page number of the results to fetch.",
224542
+ "in": "query",
224543
+ "schema": {
224544
+ "type": "integer",
224545
+ "default": 1
224546
+ }
224547
+ }
224548
+ ],
224549
+ "responses": {
224550
+ "200": {
224551
+ "description": "Response",
224552
+ "content": {
224553
+ "application/json": {
224554
+ "schema": {
224555
+ "type": "object",
224556
+ "properties": {
224557
+ "total_count": {
224558
+ "description": "The number of deployment branch policies for the environment.",
224559
+ "type": "integer",
224560
+ "example": 2
224561
+ },
224562
+ "branch_policies": {
224563
+ "type": "array",
224564
+ "items": {
224565
+ "title": "Deployment branch policy",
224566
+ "description": "Details of a deployment branch policy.",
224567
+ "type": "object",
224568
+ "properties": {
224569
+ "id": {
224570
+ "description": "The unique identifier of the branch policy.",
224571
+ "type": "integer",
224572
+ "example": 361471
224573
+ },
224574
+ "node_id": {
224575
+ "type": "string",
224576
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
224577
+ },
224578
+ "name": {
224579
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
224580
+ "type": "string",
224581
+ "example": "release/*"
224582
+ }
224583
+ }
224584
+ }
224585
+ }
224586
+ },
224587
+ "required": [
224588
+ "total_count",
224589
+ "branch_policies"
224590
+ ]
224591
+ },
224592
+ "examples": {
224593
+ "default": {
224594
+ "value": {
224595
+ "total_count": 2,
224596
+ "branch_policies": [
224597
+ {
224598
+ "id": 361471,
224599
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
224600
+ "name": "release/*"
224601
+ },
224602
+ {
224603
+ "id": 361472,
224604
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
224605
+ "name": "main"
224606
+ }
224607
+ ]
224608
+ }
224609
+ }
224610
+ }
224611
+ }
224612
+ }
224613
+ }
224614
+ },
224615
+ "x-github": {
224616
+ "githubCloudOnly": false,
224617
+ "enabledForGitHubApps": true,
224618
+ "category": "deployments",
224619
+ "subcategory": "branch-policies"
224620
+ },
224621
+ "x-octokit": {}
224622
+ },
224623
+ "post": {
224624
+ "summary": "Create a deployment branch policy",
224625
+ "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
224626
+ "tags": [
224627
+ "repos"
224628
+ ],
224629
+ "operationId": "repos/create-deployment-branch-policy",
224630
+ "externalDocs": {
224631
+ "description": "API method documentation",
224632
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#create-deployment-branch-policy"
224633
+ },
224634
+ "parameters": [
224635
+ {
224636
+ "name": "owner",
224637
+ "description": "The account owner of the repository. The name is not case sensitive.",
224638
+ "in": "path",
224639
+ "required": true,
224640
+ "schema": {
224641
+ "type": "string"
224642
+ }
224643
+ },
224644
+ {
224645
+ "name": "repo",
224646
+ "description": "The name of the repository. The name is not case sensitive.",
224647
+ "in": "path",
224648
+ "required": true,
224649
+ "schema": {
224650
+ "type": "string"
224651
+ }
224652
+ },
224653
+ {
224654
+ "name": "environment_name",
224655
+ "in": "path",
224656
+ "required": true,
224657
+ "description": "The name of the environment.",
224658
+ "schema": {
224659
+ "type": "string"
224660
+ }
224661
+ }
224662
+ ],
224663
+ "requestBody": {
224664
+ "required": true,
224665
+ "content": {
224666
+ "application/json": {
224667
+ "schema": {
224668
+ "title": "Deployment branch policy name pattern",
224669
+ "type": "object",
224670
+ "properties": {
224671
+ "name": {
224672
+ "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
224673
+ "type": "string",
224674
+ "example": "release/*"
224675
+ }
224676
+ },
224677
+ "required": [
224678
+ "name"
224679
+ ]
224680
+ },
224681
+ "examples": {
224682
+ "example-wildcard": {
224683
+ "summary": "Example of a wildcard name pattern",
224684
+ "value": {
224685
+ "name": "release/*"
224686
+ }
224687
+ },
224688
+ "example-single-branch": {
224689
+ "summary": "Example of a single branch name pattern",
224690
+ "value": {
224691
+ "name": "main"
224692
+ }
224693
+ }
224694
+ }
224695
+ }
224696
+ }
224697
+ },
224698
+ "responses": {
224699
+ "200": {
224700
+ "description": "Response",
224701
+ "content": {
224702
+ "application/json": {
224703
+ "schema": {
224704
+ "title": "Deployment branch policy",
224705
+ "description": "Details of a deployment branch policy.",
224706
+ "type": "object",
224707
+ "properties": {
224708
+ "id": {
224709
+ "description": "The unique identifier of the branch policy.",
224710
+ "type": "integer",
224711
+ "example": 361471
224712
+ },
224713
+ "node_id": {
224714
+ "type": "string",
224715
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
224716
+ },
224717
+ "name": {
224718
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
224719
+ "type": "string",
224720
+ "example": "release/*"
224721
+ }
224722
+ }
224723
+ },
224724
+ "examples": {
224725
+ "example-wildcard": {
224726
+ "value": {
224727
+ "id": 364662,
224728
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
224729
+ "name": "release/*"
224730
+ }
224731
+ },
224732
+ "example-single-branch": {
224733
+ "value": {
224734
+ "id": 364663,
224735
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
224736
+ "name": "main"
224737
+ }
224738
+ }
224739
+ }
224740
+ }
224741
+ }
224742
+ },
224743
+ "303": {
224744
+ "description": "Response if the same branch name pattern already exists"
224745
+ },
224746
+ "404": {
224747
+ "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
224748
+ }
224749
+ },
224750
+ "x-github": {
224751
+ "githubCloudOnly": false,
224752
+ "enabledForGitHubApps": true,
224753
+ "category": "deployments",
224754
+ "subcategory": "branch-policies"
224755
+ },
224756
+ "x-octokit": {}
224757
+ }
224758
+ },
224759
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
224760
+ "get": {
224761
+ "summary": "Get a deployment branch policy",
224762
+ "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
224763
+ "tags": [
224764
+ "repos"
224765
+ ],
224766
+ "operationId": "repos/get-deployment-branch-policy",
224767
+ "externalDocs": {
224768
+ "description": "API method documentation",
224769
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#get-deployment-branch-policy"
224770
+ },
224771
+ "parameters": [
224772
+ {
224773
+ "name": "owner",
224774
+ "description": "The account owner of the repository. The name is not case sensitive.",
224775
+ "in": "path",
224776
+ "required": true,
224777
+ "schema": {
224778
+ "type": "string"
224779
+ }
224780
+ },
224781
+ {
224782
+ "name": "repo",
224783
+ "description": "The name of the repository. The name is not case sensitive.",
224784
+ "in": "path",
224785
+ "required": true,
224786
+ "schema": {
224787
+ "type": "string"
224788
+ }
224789
+ },
224790
+ {
224791
+ "name": "environment_name",
224792
+ "in": "path",
224793
+ "required": true,
224794
+ "description": "The name of the environment.",
224795
+ "schema": {
224796
+ "type": "string"
224797
+ }
224798
+ },
224799
+ {
224800
+ "name": "branch_policy_id",
224801
+ "in": "path",
224802
+ "required": true,
224803
+ "description": "The unique identifier of the branch policy.",
224804
+ "schema": {
224805
+ "type": "integer"
224806
+ }
224807
+ }
224808
+ ],
224809
+ "responses": {
224810
+ "200": {
224811
+ "description": "Response",
224812
+ "content": {
224813
+ "application/json": {
224814
+ "schema": {
224815
+ "title": "Deployment branch policy",
224816
+ "description": "Details of a deployment branch policy.",
224817
+ "type": "object",
224818
+ "properties": {
224819
+ "id": {
224820
+ "description": "The unique identifier of the branch policy.",
224821
+ "type": "integer",
224822
+ "example": 361471
224823
+ },
224824
+ "node_id": {
224825
+ "type": "string",
224826
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
224827
+ },
224828
+ "name": {
224829
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
224830
+ "type": "string",
224831
+ "example": "release/*"
224832
+ }
224833
+ }
224834
+ },
224835
+ "examples": {
224836
+ "default": {
224837
+ "value": {
224838
+ "id": 364662,
224839
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
224840
+ "name": "release/*"
224841
+ }
224842
+ }
224843
+ }
224844
+ }
224845
+ }
224846
+ }
224847
+ },
224848
+ "x-github": {
224849
+ "githubCloudOnly": false,
224850
+ "enabledForGitHubApps": true,
224851
+ "category": "deployments",
224852
+ "subcategory": "branch-policies"
224853
+ },
224854
+ "x-octokit": {}
224855
+ },
224856
+ "put": {
224857
+ "summary": "Update a deployment branch policy",
224858
+ "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
224859
+ "tags": [
224860
+ "repos"
224861
+ ],
224862
+ "operationId": "repos/update-deployment-branch-policy",
224863
+ "externalDocs": {
224864
+ "description": "API method documentation",
224865
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#update-deployment-branch-policy"
224866
+ },
224867
+ "parameters": [
224868
+ {
224869
+ "name": "owner",
224870
+ "description": "The account owner of the repository. The name is not case sensitive.",
224871
+ "in": "path",
224872
+ "required": true,
224873
+ "schema": {
224874
+ "type": "string"
224875
+ }
224876
+ },
224877
+ {
224878
+ "name": "repo",
224879
+ "description": "The name of the repository. The name is not case sensitive.",
224880
+ "in": "path",
224881
+ "required": true,
224882
+ "schema": {
224883
+ "type": "string"
224884
+ }
224885
+ },
224886
+ {
224887
+ "name": "environment_name",
224888
+ "in": "path",
224889
+ "required": true,
224890
+ "description": "The name of the environment.",
224891
+ "schema": {
224892
+ "type": "string"
224893
+ }
224894
+ },
224895
+ {
224896
+ "name": "branch_policy_id",
224897
+ "in": "path",
224898
+ "required": true,
224899
+ "description": "The unique identifier of the branch policy.",
224900
+ "schema": {
224901
+ "type": "integer"
224902
+ }
224903
+ }
224904
+ ],
224905
+ "requestBody": {
224906
+ "required": true,
224907
+ "content": {
224908
+ "application/json": {
224909
+ "schema": {
224910
+ "title": "Deployment branch policy name pattern",
224911
+ "type": "object",
224912
+ "properties": {
224913
+ "name": {
224914
+ "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
224915
+ "type": "string",
224916
+ "example": "release/*"
224917
+ }
224918
+ },
224919
+ "required": [
224920
+ "name"
224921
+ ]
224922
+ },
224923
+ "examples": {
224924
+ "default": {
224925
+ "value": {
224926
+ "name": "release/*"
224927
+ }
224928
+ }
224929
+ }
224930
+ }
224931
+ }
224932
+ },
224933
+ "responses": {
224934
+ "200": {
224935
+ "description": "Response",
224936
+ "content": {
224937
+ "application/json": {
224938
+ "schema": {
224939
+ "title": "Deployment branch policy",
224940
+ "description": "Details of a deployment branch policy.",
224941
+ "type": "object",
224942
+ "properties": {
224943
+ "id": {
224944
+ "description": "The unique identifier of the branch policy.",
224945
+ "type": "integer",
224946
+ "example": 361471
224947
+ },
224948
+ "node_id": {
224949
+ "type": "string",
224950
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
224951
+ },
224952
+ "name": {
224953
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
224954
+ "type": "string",
224955
+ "example": "release/*"
224956
+ }
224957
+ }
224958
+ },
224959
+ "examples": {
224960
+ "default": {
224961
+ "value": {
224962
+ "id": 364662,
224963
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
224964
+ "name": "release/*"
224965
+ }
224966
+ }
224967
+ }
224968
+ }
224969
+ }
224970
+ }
224971
+ },
224972
+ "x-github": {
224973
+ "githubCloudOnly": false,
224974
+ "enabledForGitHubApps": true,
224975
+ "category": "deployments",
224976
+ "subcategory": "branch-policies"
224977
+ },
224978
+ "x-octokit": {}
224979
+ },
224980
+ "delete": {
224981
+ "summary": "Delete a deployment branch policy",
224982
+ "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
224983
+ "tags": [
224984
+ "repos"
224985
+ ],
224986
+ "operationId": "repos/delete-deployment-branch-policy",
224987
+ "externalDocs": {
224988
+ "description": "API method documentation",
224989
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#delete-deployment-branch-policy"
224990
+ },
224991
+ "parameters": [
224992
+ {
224993
+ "name": "owner",
224994
+ "description": "The account owner of the repository. The name is not case sensitive.",
224995
+ "in": "path",
224996
+ "required": true,
224997
+ "schema": {
224998
+ "type": "string"
224999
+ }
225000
+ },
225001
+ {
225002
+ "name": "repo",
225003
+ "description": "The name of the repository. The name is not case sensitive.",
225004
+ "in": "path",
225005
+ "required": true,
225006
+ "schema": {
225007
+ "type": "string"
225008
+ }
225009
+ },
225010
+ {
225011
+ "name": "environment_name",
225012
+ "in": "path",
225013
+ "required": true,
225014
+ "description": "The name of the environment.",
225015
+ "schema": {
225016
+ "type": "string"
225017
+ }
225018
+ },
225019
+ {
225020
+ "name": "branch_policy_id",
225021
+ "in": "path",
225022
+ "required": true,
225023
+ "description": "The unique identifier of the branch policy.",
225024
+ "schema": {
225025
+ "type": "integer"
225026
+ }
225027
+ }
225028
+ ],
225029
+ "responses": {
225030
+ "204": {
225031
+ "description": "Response"
225032
+ }
225033
+ },
225034
+ "x-github": {
225035
+ "githubCloudOnly": false,
225036
+ "enabledForGitHubApps": true,
225037
+ "category": "deployments",
225038
+ "subcategory": "branch-policies"
225039
+ },
225040
+ "x-octokit": {}
225041
+ }
225042
+ },
224480
225043
  "/repos/{owner}/{repo}/events": {
224481
225044
  "get": {
224482
225045
  "summary": "List repository events",
@@ -340375,7 +340938,10 @@
340375
340938
  "type": "object",
340376
340939
  "properties": {
340377
340940
  "type": {
340378
- "type": "string"
340941
+ "type": "string",
340942
+ "enum": [
340943
+ "file"
340944
+ ]
340379
340945
  },
340380
340946
  "encoding": {
340381
340947
  "type": "string"
@@ -340654,7 +341220,10 @@
340654
341220
  "type": "object",
340655
341221
  "properties": {
340656
341222
  "type": {
340657
- "type": "string"
341223
+ "type": "string",
341224
+ "enum": [
341225
+ "file"
341226
+ ]
340658
341227
  },
340659
341228
  "encoding": {
340660
341229
  "type": "string"
@@ -357803,7 +358372,7 @@
357803
358372
  "name": "environment_name",
357804
358373
  "in": "path",
357805
358374
  "required": true,
357806
- "description": "The name of the environment",
358375
+ "description": "The name of the environment.",
357807
358376
  "schema": {
357808
358377
  "type": "string"
357809
358378
  }
@@ -357938,7 +358507,7 @@
357938
358507
  "name": "environment_name",
357939
358508
  "in": "path",
357940
358509
  "required": true,
357941
- "description": "The name of the environment",
358510
+ "description": "The name of the environment.",
357942
358511
  "schema": {
357943
358512
  "type": "string"
357944
358513
  }
@@ -358033,7 +358602,7 @@
358033
358602
  "name": "environment_name",
358034
358603
  "in": "path",
358035
358604
  "required": true,
358036
- "description": "The name of the environment",
358605
+ "description": "The name of the environment.",
358037
358606
  "schema": {
358038
358607
  "type": "string"
358039
358608
  }
@@ -358124,7 +358693,7 @@
358124
358693
  "name": "environment_name",
358125
358694
  "in": "path",
358126
358695
  "required": true,
358127
- "description": "The name of the environment",
358696
+ "description": "The name of the environment.",
358128
358697
  "schema": {
358129
358698
  "type": "string"
358130
358699
  }
@@ -358229,7 +358798,7 @@
358229
358798
  "name": "environment_name",
358230
358799
  "in": "path",
358231
358800
  "required": true,
358232
- "description": "The name of the environment",
358801
+ "description": "The name of the environment.",
358233
358802
  "schema": {
358234
358803
  "type": "string"
358235
358804
  }