@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": {
@@ -112337,13 +112337,6 @@
112337
112337
  "permission": {
112338
112338
  "type": "string",
112339
112339
  "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.",
112340
- "enum": [
112341
- "pull",
112342
- "push",
112343
- "admin",
112344
- "maintain",
112345
- "triage"
112346
- ],
112347
112340
  "default": "push"
112348
112341
  }
112349
112342
  }
@@ -129675,7 +129668,7 @@
129675
129668
  "/repos/{owner}/{repo}/actions/permissions/access": {
129676
129669
  "get": {
129677
129670
  "summary": "Get the level of access for workflows outside of the repository",
129678
- "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.5/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.",
129671
+ "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.5/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.",
129679
129672
  "tags": [
129680
129673
  "actions"
129681
129674
  ],
@@ -129748,7 +129741,7 @@
129748
129741
  },
129749
129742
  "put": {
129750
129743
  "summary": "Set the level of access for workflows outside of the repository",
129751
- "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.5/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.",
129744
+ "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.5/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.",
129752
129745
  "tags": [
129753
129746
  "actions"
129754
129747
  ],
@@ -194132,13 +194125,6 @@
194132
194125
  "permission": {
194133
194126
  "type": "string",
194134
194127
  "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**",
194135
- "enum": [
194136
- "pull",
194137
- "push",
194138
- "admin",
194139
- "maintain",
194140
- "triage"
194141
- ],
194142
194128
  "default": "push"
194143
194129
  }
194144
194130
  }
@@ -214187,7 +214173,13 @@
214187
214173
  "type": "object",
214188
214174
  "properties": {
214189
214175
  "type": {
214190
- "type": "string"
214176
+ "type": "string",
214177
+ "enum": [
214178
+ "dir",
214179
+ "file",
214180
+ "submodule",
214181
+ "symlink"
214182
+ ]
214191
214183
  },
214192
214184
  "size": {
214193
214185
  "type": "integer"
@@ -214268,7 +214260,10 @@
214268
214260
  "type": "object",
214269
214261
  "properties": {
214270
214262
  "type": {
214271
- "type": "string"
214263
+ "type": "string",
214264
+ "enum": [
214265
+ "file"
214266
+ ]
214272
214267
  },
214273
214268
  "encoding": {
214274
214269
  "type": "string"
@@ -214361,7 +214356,10 @@
214361
214356
  "type": "object",
214362
214357
  "properties": {
214363
214358
  "type": {
214364
- "type": "string"
214359
+ "type": "string",
214360
+ "enum": [
214361
+ "symlink"
214362
+ ]
214365
214363
  },
214366
214364
  "target": {
214367
214365
  "type": "string"
@@ -214437,12 +214435,15 @@
214437
214435
  ]
214438
214436
  },
214439
214437
  {
214440
- "title": "Symlink Content",
214441
- "description": "An object describing a symlink",
214438
+ "title": "Submodule Content",
214439
+ "description": "An object describing a submodule",
214442
214440
  "type": "object",
214443
214441
  "properties": {
214444
214442
  "type": {
214445
- "type": "string"
214443
+ "type": "string",
214444
+ "enum": [
214445
+ "submodule"
214446
+ ]
214446
214447
  },
214447
214448
  "submodule_git_url": {
214448
214449
  "type": "string",
@@ -220749,15 +220750,15 @@
220749
220750
  },
220750
220751
  "/repos/{owner}/{repo}/environments": {
220751
220752
  "get": {
220752
- "summary": "Get all environments",
220753
- "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.",
220753
+ "summary": "List environments",
220754
+ "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.",
220754
220755
  "tags": [
220755
220756
  "repos"
220756
220757
  ],
220757
220758
  "operationId": "repos/get-all-environments",
220758
220759
  "externalDocs": {
220759
220760
  "description": "API method documentation",
220760
- "url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-all-environments"
220761
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/environments#list-environments"
220761
220762
  },
220762
220763
  "parameters": [
220763
220764
  {
@@ -221356,7 +221357,7 @@
221356
221357
  "x-github": {
221357
221358
  "githubCloudOnly": false,
221358
221359
  "enabledForGitHubApps": true,
221359
- "category": "repos",
221360
+ "category": "deployments",
221360
221361
  "subcategory": "environments"
221361
221362
  },
221362
221363
  "x-octokit": {}
@@ -221365,7 +221366,7 @@
221365
221366
  "/repos/{owner}/{repo}/environments/{environment_name}": {
221366
221367
  "get": {
221367
221368
  "summary": "Get an environment",
221368
- "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.",
221369
+ "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.",
221369
221370
  "tags": [
221370
221371
  "repos"
221371
221372
  ],
@@ -221397,7 +221398,7 @@
221397
221398
  "name": "environment_name",
221398
221399
  "in": "path",
221399
221400
  "required": true,
221400
- "description": "The name of the environment",
221401
+ "description": "The name of the environment.",
221401
221402
  "schema": {
221402
221403
  "type": "string"
221403
221404
  }
@@ -221951,7 +221952,7 @@
221951
221952
  },
221952
221953
  "put": {
221953
221954
  "summary": "Create or update an environment",
221954
- "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.",
221955
+ "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.",
221955
221956
  "tags": [
221956
221957
  "repos"
221957
221958
  ],
@@ -221983,7 +221984,7 @@
221983
221984
  "name": "environment_name",
221984
221985
  "in": "path",
221985
221986
  "required": true,
221986
- "description": "The name of the environment",
221987
+ "description": "The name of the environment.",
221987
221988
  "schema": {
221988
221989
  "type": "string"
221989
221990
  }
@@ -222047,6 +222048,27 @@
222047
222048
  }
222048
222049
  },
222049
222050
  "additionalProperties": false
222051
+ },
222052
+ "examples": {
222053
+ "default": {
222054
+ "value": {
222055
+ "wait_timer": 30,
222056
+ "reviewers": [
222057
+ {
222058
+ "type": "User",
222059
+ "id": 1
222060
+ },
222061
+ {
222062
+ "type": "Team",
222063
+ "id": 1
222064
+ }
222065
+ ],
222066
+ "deployment_branch_policy": {
222067
+ "protected_branches": false,
222068
+ "custom_branch_policies": true
222069
+ }
222070
+ }
222071
+ }
222050
222072
  }
222051
222073
  }
222052
222074
  }
@@ -222657,7 +222679,7 @@
222657
222679
  "name": "environment_name",
222658
222680
  "in": "path",
222659
222681
  "required": true,
222660
- "description": "The name of the environment",
222682
+ "description": "The name of the environment.",
222661
222683
  "schema": {
222662
222684
  "type": "string"
222663
222685
  }
@@ -222677,6 +222699,559 @@
222677
222699
  "x-octokit": {}
222678
222700
  }
222679
222701
  },
222702
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
222703
+ "get": {
222704
+ "summary": "List deployment branch policies",
222705
+ "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.",
222706
+ "tags": [
222707
+ "repos"
222708
+ ],
222709
+ "operationId": "repos/list-deployment-branch-policies",
222710
+ "externalDocs": {
222711
+ "description": "API method documentation",
222712
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#list-deployment-branch-policies"
222713
+ },
222714
+ "parameters": [
222715
+ {
222716
+ "name": "owner",
222717
+ "description": "The account owner of the repository. The name is not case sensitive.",
222718
+ "in": "path",
222719
+ "required": true,
222720
+ "schema": {
222721
+ "type": "string"
222722
+ }
222723
+ },
222724
+ {
222725
+ "name": "repo",
222726
+ "description": "The name of the repository. The name is not case sensitive.",
222727
+ "in": "path",
222728
+ "required": true,
222729
+ "schema": {
222730
+ "type": "string"
222731
+ }
222732
+ },
222733
+ {
222734
+ "name": "environment_name",
222735
+ "in": "path",
222736
+ "required": true,
222737
+ "description": "The name of the environment.",
222738
+ "schema": {
222739
+ "type": "string"
222740
+ }
222741
+ },
222742
+ {
222743
+ "name": "per_page",
222744
+ "description": "The number of results per page (max 100).",
222745
+ "in": "query",
222746
+ "schema": {
222747
+ "type": "integer",
222748
+ "default": 30
222749
+ }
222750
+ },
222751
+ {
222752
+ "name": "page",
222753
+ "description": "Page number of the results to fetch.",
222754
+ "in": "query",
222755
+ "schema": {
222756
+ "type": "integer",
222757
+ "default": 1
222758
+ }
222759
+ }
222760
+ ],
222761
+ "responses": {
222762
+ "200": {
222763
+ "description": "Response",
222764
+ "content": {
222765
+ "application/json": {
222766
+ "schema": {
222767
+ "type": "object",
222768
+ "properties": {
222769
+ "total_count": {
222770
+ "description": "The number of deployment branch policies for the environment.",
222771
+ "type": "integer",
222772
+ "example": 2
222773
+ },
222774
+ "branch_policies": {
222775
+ "type": "array",
222776
+ "items": {
222777
+ "title": "Deployment branch policy",
222778
+ "description": "Details of a deployment branch policy.",
222779
+ "type": "object",
222780
+ "properties": {
222781
+ "id": {
222782
+ "description": "The unique identifier of the branch policy.",
222783
+ "type": "integer",
222784
+ "example": 361471
222785
+ },
222786
+ "node_id": {
222787
+ "type": "string",
222788
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
222789
+ },
222790
+ "name": {
222791
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
222792
+ "type": "string",
222793
+ "example": "release/*"
222794
+ }
222795
+ }
222796
+ }
222797
+ }
222798
+ },
222799
+ "required": [
222800
+ "total_count",
222801
+ "branch_policies"
222802
+ ]
222803
+ },
222804
+ "examples": {
222805
+ "default": {
222806
+ "value": {
222807
+ "total_count": 2,
222808
+ "branch_policies": [
222809
+ {
222810
+ "id": 361471,
222811
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
222812
+ "name": "release/*"
222813
+ },
222814
+ {
222815
+ "id": 361472,
222816
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
222817
+ "name": "main"
222818
+ }
222819
+ ]
222820
+ }
222821
+ }
222822
+ }
222823
+ }
222824
+ }
222825
+ }
222826
+ },
222827
+ "x-github": {
222828
+ "githubCloudOnly": false,
222829
+ "enabledForGitHubApps": true,
222830
+ "category": "deployments",
222831
+ "subcategory": "branch-policies"
222832
+ },
222833
+ "x-octokit": {}
222834
+ },
222835
+ "post": {
222836
+ "summary": "Create a deployment branch policy",
222837
+ "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.",
222838
+ "tags": [
222839
+ "repos"
222840
+ ],
222841
+ "operationId": "repos/create-deployment-branch-policy",
222842
+ "externalDocs": {
222843
+ "description": "API method documentation",
222844
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#create-deployment-branch-policy"
222845
+ },
222846
+ "parameters": [
222847
+ {
222848
+ "name": "owner",
222849
+ "description": "The account owner of the repository. The name is not case sensitive.",
222850
+ "in": "path",
222851
+ "required": true,
222852
+ "schema": {
222853
+ "type": "string"
222854
+ }
222855
+ },
222856
+ {
222857
+ "name": "repo",
222858
+ "description": "The name of the repository. The name is not case sensitive.",
222859
+ "in": "path",
222860
+ "required": true,
222861
+ "schema": {
222862
+ "type": "string"
222863
+ }
222864
+ },
222865
+ {
222866
+ "name": "environment_name",
222867
+ "in": "path",
222868
+ "required": true,
222869
+ "description": "The name of the environment.",
222870
+ "schema": {
222871
+ "type": "string"
222872
+ }
222873
+ }
222874
+ ],
222875
+ "requestBody": {
222876
+ "required": true,
222877
+ "content": {
222878
+ "application/json": {
222879
+ "schema": {
222880
+ "title": "Deployment branch policy name pattern",
222881
+ "type": "object",
222882
+ "properties": {
222883
+ "name": {
222884
+ "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).",
222885
+ "type": "string",
222886
+ "example": "release/*"
222887
+ }
222888
+ },
222889
+ "required": [
222890
+ "name"
222891
+ ]
222892
+ },
222893
+ "examples": {
222894
+ "example-wildcard": {
222895
+ "summary": "Example of a wildcard name pattern",
222896
+ "value": {
222897
+ "name": "release/*"
222898
+ }
222899
+ },
222900
+ "example-single-branch": {
222901
+ "summary": "Example of a single branch name pattern",
222902
+ "value": {
222903
+ "name": "main"
222904
+ }
222905
+ }
222906
+ }
222907
+ }
222908
+ }
222909
+ },
222910
+ "responses": {
222911
+ "200": {
222912
+ "description": "Response",
222913
+ "content": {
222914
+ "application/json": {
222915
+ "schema": {
222916
+ "title": "Deployment branch policy",
222917
+ "description": "Details of a deployment branch policy.",
222918
+ "type": "object",
222919
+ "properties": {
222920
+ "id": {
222921
+ "description": "The unique identifier of the branch policy.",
222922
+ "type": "integer",
222923
+ "example": 361471
222924
+ },
222925
+ "node_id": {
222926
+ "type": "string",
222927
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
222928
+ },
222929
+ "name": {
222930
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
222931
+ "type": "string",
222932
+ "example": "release/*"
222933
+ }
222934
+ }
222935
+ },
222936
+ "examples": {
222937
+ "example-wildcard": {
222938
+ "value": {
222939
+ "id": 364662,
222940
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
222941
+ "name": "release/*"
222942
+ }
222943
+ },
222944
+ "example-single-branch": {
222945
+ "value": {
222946
+ "id": 364663,
222947
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
222948
+ "name": "main"
222949
+ }
222950
+ }
222951
+ }
222952
+ }
222953
+ }
222954
+ },
222955
+ "303": {
222956
+ "description": "Response if the same branch name pattern already exists"
222957
+ },
222958
+ "404": {
222959
+ "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
222960
+ }
222961
+ },
222962
+ "x-github": {
222963
+ "githubCloudOnly": false,
222964
+ "enabledForGitHubApps": true,
222965
+ "category": "deployments",
222966
+ "subcategory": "branch-policies"
222967
+ },
222968
+ "x-octokit": {}
222969
+ }
222970
+ },
222971
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
222972
+ "get": {
222973
+ "summary": "Get a deployment branch policy",
222974
+ "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.",
222975
+ "tags": [
222976
+ "repos"
222977
+ ],
222978
+ "operationId": "repos/get-deployment-branch-policy",
222979
+ "externalDocs": {
222980
+ "description": "API method documentation",
222981
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#get-deployment-branch-policy"
222982
+ },
222983
+ "parameters": [
222984
+ {
222985
+ "name": "owner",
222986
+ "description": "The account owner of the repository. The name is not case sensitive.",
222987
+ "in": "path",
222988
+ "required": true,
222989
+ "schema": {
222990
+ "type": "string"
222991
+ }
222992
+ },
222993
+ {
222994
+ "name": "repo",
222995
+ "description": "The name of the repository. The name is not case sensitive.",
222996
+ "in": "path",
222997
+ "required": true,
222998
+ "schema": {
222999
+ "type": "string"
223000
+ }
223001
+ },
223002
+ {
223003
+ "name": "environment_name",
223004
+ "in": "path",
223005
+ "required": true,
223006
+ "description": "The name of the environment.",
223007
+ "schema": {
223008
+ "type": "string"
223009
+ }
223010
+ },
223011
+ {
223012
+ "name": "branch_policy_id",
223013
+ "in": "path",
223014
+ "required": true,
223015
+ "description": "The unique identifier of the branch policy.",
223016
+ "schema": {
223017
+ "type": "integer"
223018
+ }
223019
+ }
223020
+ ],
223021
+ "responses": {
223022
+ "200": {
223023
+ "description": "Response",
223024
+ "content": {
223025
+ "application/json": {
223026
+ "schema": {
223027
+ "title": "Deployment branch policy",
223028
+ "description": "Details of a deployment branch policy.",
223029
+ "type": "object",
223030
+ "properties": {
223031
+ "id": {
223032
+ "description": "The unique identifier of the branch policy.",
223033
+ "type": "integer",
223034
+ "example": 361471
223035
+ },
223036
+ "node_id": {
223037
+ "type": "string",
223038
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
223039
+ },
223040
+ "name": {
223041
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
223042
+ "type": "string",
223043
+ "example": "release/*"
223044
+ }
223045
+ }
223046
+ },
223047
+ "examples": {
223048
+ "default": {
223049
+ "value": {
223050
+ "id": 364662,
223051
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
223052
+ "name": "release/*"
223053
+ }
223054
+ }
223055
+ }
223056
+ }
223057
+ }
223058
+ }
223059
+ },
223060
+ "x-github": {
223061
+ "githubCloudOnly": false,
223062
+ "enabledForGitHubApps": true,
223063
+ "category": "deployments",
223064
+ "subcategory": "branch-policies"
223065
+ },
223066
+ "x-octokit": {}
223067
+ },
223068
+ "put": {
223069
+ "summary": "Update a deployment branch policy",
223070
+ "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.",
223071
+ "tags": [
223072
+ "repos"
223073
+ ],
223074
+ "operationId": "repos/update-deployment-branch-policy",
223075
+ "externalDocs": {
223076
+ "description": "API method documentation",
223077
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#update-deployment-branch-policy"
223078
+ },
223079
+ "parameters": [
223080
+ {
223081
+ "name": "owner",
223082
+ "description": "The account owner of the repository. The name is not case sensitive.",
223083
+ "in": "path",
223084
+ "required": true,
223085
+ "schema": {
223086
+ "type": "string"
223087
+ }
223088
+ },
223089
+ {
223090
+ "name": "repo",
223091
+ "description": "The name of the repository. The name is not case sensitive.",
223092
+ "in": "path",
223093
+ "required": true,
223094
+ "schema": {
223095
+ "type": "string"
223096
+ }
223097
+ },
223098
+ {
223099
+ "name": "environment_name",
223100
+ "in": "path",
223101
+ "required": true,
223102
+ "description": "The name of the environment.",
223103
+ "schema": {
223104
+ "type": "string"
223105
+ }
223106
+ },
223107
+ {
223108
+ "name": "branch_policy_id",
223109
+ "in": "path",
223110
+ "required": true,
223111
+ "description": "The unique identifier of the branch policy.",
223112
+ "schema": {
223113
+ "type": "integer"
223114
+ }
223115
+ }
223116
+ ],
223117
+ "requestBody": {
223118
+ "required": true,
223119
+ "content": {
223120
+ "application/json": {
223121
+ "schema": {
223122
+ "title": "Deployment branch policy name pattern",
223123
+ "type": "object",
223124
+ "properties": {
223125
+ "name": {
223126
+ "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).",
223127
+ "type": "string",
223128
+ "example": "release/*"
223129
+ }
223130
+ },
223131
+ "required": [
223132
+ "name"
223133
+ ]
223134
+ },
223135
+ "examples": {
223136
+ "default": {
223137
+ "value": {
223138
+ "name": "release/*"
223139
+ }
223140
+ }
223141
+ }
223142
+ }
223143
+ }
223144
+ },
223145
+ "responses": {
223146
+ "200": {
223147
+ "description": "Response",
223148
+ "content": {
223149
+ "application/json": {
223150
+ "schema": {
223151
+ "title": "Deployment branch policy",
223152
+ "description": "Details of a deployment branch policy.",
223153
+ "type": "object",
223154
+ "properties": {
223155
+ "id": {
223156
+ "description": "The unique identifier of the branch policy.",
223157
+ "type": "integer",
223158
+ "example": 361471
223159
+ },
223160
+ "node_id": {
223161
+ "type": "string",
223162
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
223163
+ },
223164
+ "name": {
223165
+ "description": "The name pattern that branches must match in order to deploy to the environment.",
223166
+ "type": "string",
223167
+ "example": "release/*"
223168
+ }
223169
+ }
223170
+ },
223171
+ "examples": {
223172
+ "default": {
223173
+ "value": {
223174
+ "id": 364662,
223175
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
223176
+ "name": "release/*"
223177
+ }
223178
+ }
223179
+ }
223180
+ }
223181
+ }
223182
+ }
223183
+ },
223184
+ "x-github": {
223185
+ "githubCloudOnly": false,
223186
+ "enabledForGitHubApps": true,
223187
+ "category": "deployments",
223188
+ "subcategory": "branch-policies"
223189
+ },
223190
+ "x-octokit": {}
223191
+ },
223192
+ "delete": {
223193
+ "summary": "Delete a deployment branch policy",
223194
+ "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.",
223195
+ "tags": [
223196
+ "repos"
223197
+ ],
223198
+ "operationId": "repos/delete-deployment-branch-policy",
223199
+ "externalDocs": {
223200
+ "description": "API method documentation",
223201
+ "url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#delete-deployment-branch-policy"
223202
+ },
223203
+ "parameters": [
223204
+ {
223205
+ "name": "owner",
223206
+ "description": "The account owner of the repository. The name is not case sensitive.",
223207
+ "in": "path",
223208
+ "required": true,
223209
+ "schema": {
223210
+ "type": "string"
223211
+ }
223212
+ },
223213
+ {
223214
+ "name": "repo",
223215
+ "description": "The name of the repository. The name is not case sensitive.",
223216
+ "in": "path",
223217
+ "required": true,
223218
+ "schema": {
223219
+ "type": "string"
223220
+ }
223221
+ },
223222
+ {
223223
+ "name": "environment_name",
223224
+ "in": "path",
223225
+ "required": true,
223226
+ "description": "The name of the environment.",
223227
+ "schema": {
223228
+ "type": "string"
223229
+ }
223230
+ },
223231
+ {
223232
+ "name": "branch_policy_id",
223233
+ "in": "path",
223234
+ "required": true,
223235
+ "description": "The unique identifier of the branch policy.",
223236
+ "schema": {
223237
+ "type": "integer"
223238
+ }
223239
+ }
223240
+ ],
223241
+ "responses": {
223242
+ "204": {
223243
+ "description": "Response"
223244
+ }
223245
+ },
223246
+ "x-github": {
223247
+ "githubCloudOnly": false,
223248
+ "enabledForGitHubApps": true,
223249
+ "category": "deployments",
223250
+ "subcategory": "branch-policies"
223251
+ },
223252
+ "x-octokit": {}
223253
+ }
223254
+ },
222680
223255
  "/repos/{owner}/{repo}/events": {
222681
223256
  "get": {
222682
223257
  "summary": "List repository events",
@@ -338437,7 +339012,10 @@
338437
339012
  "type": "object",
338438
339013
  "properties": {
338439
339014
  "type": {
338440
- "type": "string"
339015
+ "type": "string",
339016
+ "enum": [
339017
+ "file"
339018
+ ]
338441
339019
  },
338442
339020
  "encoding": {
338443
339021
  "type": "string"
@@ -338716,7 +339294,10 @@
338716
339294
  "type": "object",
338717
339295
  "properties": {
338718
339296
  "type": {
338719
- "type": "string"
339297
+ "type": "string",
339298
+ "enum": [
339299
+ "file"
339300
+ ]
338720
339301
  },
338721
339302
  "encoding": {
338722
339303
  "type": "string"
@@ -355368,7 +355949,7 @@
355368
355949
  "name": "environment_name",
355369
355950
  "in": "path",
355370
355951
  "required": true,
355371
- "description": "The name of the environment",
355952
+ "description": "The name of the environment.",
355372
355953
  "schema": {
355373
355954
  "type": "string"
355374
355955
  }
@@ -355503,7 +356084,7 @@
355503
356084
  "name": "environment_name",
355504
356085
  "in": "path",
355505
356086
  "required": true,
355506
- "description": "The name of the environment",
356087
+ "description": "The name of the environment.",
355507
356088
  "schema": {
355508
356089
  "type": "string"
355509
356090
  }
@@ -355598,7 +356179,7 @@
355598
356179
  "name": "environment_name",
355599
356180
  "in": "path",
355600
356181
  "required": true,
355601
- "description": "The name of the environment",
356182
+ "description": "The name of the environment.",
355602
356183
  "schema": {
355603
356184
  "type": "string"
355604
356185
  }
@@ -355689,7 +356270,7 @@
355689
356270
  "name": "environment_name",
355690
356271
  "in": "path",
355691
356272
  "required": true,
355692
- "description": "The name of the environment",
356273
+ "description": "The name of the environment.",
355693
356274
  "schema": {
355694
356275
  "type": "string"
355695
356276
  }
@@ -355794,7 +356375,7 @@
355794
356375
  "name": "environment_name",
355795
356376
  "in": "path",
355796
356377
  "required": true,
355797
- "description": "The name of the environment",
356378
+ "description": "The name of the environment.",
355798
356379
  "schema": {
355799
356380
  "type": "string"
355800
356381
  }