@octokit/openapi 16.2.0 → 16.3.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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "16.2.0",
4
+ "version": "16.3.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": {
@@ -117655,6 +117655,171 @@
117655
117655
  "updated_at"
117656
117656
  ]
117657
117657
  },
117658
+ "webhooks_rule": {
117659
+ "title": "branch protection rule",
117660
+ "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
117661
+ "type": "object",
117662
+ "properties": {
117663
+ "admin_enforced": {
117664
+ "type": "boolean"
117665
+ },
117666
+ "allow_deletions_enforcement_level": {
117667
+ "type": "string",
117668
+ "enum": [
117669
+ "off",
117670
+ "non_admins",
117671
+ "everyone"
117672
+ ]
117673
+ },
117674
+ "allow_force_pushes_enforcement_level": {
117675
+ "type": "string",
117676
+ "enum": [
117677
+ "off",
117678
+ "non_admins",
117679
+ "everyone"
117680
+ ]
117681
+ },
117682
+ "authorized_actor_names": {
117683
+ "type": "array",
117684
+ "items": {
117685
+ "type": "string"
117686
+ }
117687
+ },
117688
+ "authorized_actors_only": {
117689
+ "type": "boolean"
117690
+ },
117691
+ "authorized_dismissal_actors_only": {
117692
+ "type": "boolean"
117693
+ },
117694
+ "create_protected": {
117695
+ "type": "boolean"
117696
+ },
117697
+ "created_at": {
117698
+ "type": "string",
117699
+ "format": "date-time"
117700
+ },
117701
+ "dismiss_stale_reviews_on_push": {
117702
+ "type": "boolean"
117703
+ },
117704
+ "id": {
117705
+ "type": "integer"
117706
+ },
117707
+ "ignore_approvals_from_contributors": {
117708
+ "type": "boolean"
117709
+ },
117710
+ "linear_history_requirement_enforcement_level": {
117711
+ "type": "string",
117712
+ "enum": [
117713
+ "off",
117714
+ "non_admins",
117715
+ "everyone"
117716
+ ]
117717
+ },
117718
+ "merge_queue_enforcement_level": {
117719
+ "type": "string",
117720
+ "enum": [
117721
+ "off",
117722
+ "non_admins",
117723
+ "everyone"
117724
+ ]
117725
+ },
117726
+ "name": {
117727
+ "type": "string"
117728
+ },
117729
+ "pull_request_reviews_enforcement_level": {
117730
+ "type": "string",
117731
+ "enum": [
117732
+ "off",
117733
+ "non_admins",
117734
+ "everyone"
117735
+ ]
117736
+ },
117737
+ "repository_id": {
117738
+ "type": "integer"
117739
+ },
117740
+ "require_code_owner_review": {
117741
+ "type": "boolean"
117742
+ },
117743
+ "require_last_push_approval": {
117744
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
117745
+ "type": "boolean"
117746
+ },
117747
+ "required_approving_review_count": {
117748
+ "type": "integer"
117749
+ },
117750
+ "required_conversation_resolution_level": {
117751
+ "type": "string",
117752
+ "enum": [
117753
+ "off",
117754
+ "non_admins",
117755
+ "everyone"
117756
+ ]
117757
+ },
117758
+ "required_deployments_enforcement_level": {
117759
+ "type": "string",
117760
+ "enum": [
117761
+ "off",
117762
+ "non_admins",
117763
+ "everyone"
117764
+ ]
117765
+ },
117766
+ "required_status_checks": {
117767
+ "type": "array",
117768
+ "items": {
117769
+ "type": "string"
117770
+ }
117771
+ },
117772
+ "required_status_checks_enforcement_level": {
117773
+ "type": "string",
117774
+ "enum": [
117775
+ "off",
117776
+ "non_admins",
117777
+ "everyone"
117778
+ ]
117779
+ },
117780
+ "signature_requirement_enforcement_level": {
117781
+ "type": "string",
117782
+ "enum": [
117783
+ "off",
117784
+ "non_admins",
117785
+ "everyone"
117786
+ ]
117787
+ },
117788
+ "strict_required_status_checks_policy": {
117789
+ "type": "boolean"
117790
+ },
117791
+ "updated_at": {
117792
+ "type": "string",
117793
+ "format": "date-time"
117794
+ }
117795
+ },
117796
+ "required": [
117797
+ "id",
117798
+ "repository_id",
117799
+ "name",
117800
+ "created_at",
117801
+ "updated_at",
117802
+ "pull_request_reviews_enforcement_level",
117803
+ "required_approving_review_count",
117804
+ "dismiss_stale_reviews_on_push",
117805
+ "require_code_owner_review",
117806
+ "authorized_dismissal_actors_only",
117807
+ "ignore_approvals_from_contributors",
117808
+ "required_status_checks",
117809
+ "required_status_checks_enforcement_level",
117810
+ "strict_required_status_checks_policy",
117811
+ "signature_requirement_enforcement_level",
117812
+ "linear_history_requirement_enforcement_level",
117813
+ "admin_enforced",
117814
+ "allow_force_pushes_enforcement_level",
117815
+ "allow_deletions_enforcement_level",
117816
+ "merge_queue_enforcement_level",
117817
+ "required_deployments_enforcement_level",
117818
+ "required_conversation_resolution_level",
117819
+ "authorized_actors_only",
117820
+ "authorized_actor_names"
117821
+ ]
117822
+ },
117658
117823
  "simple-user-webhooks": {
117659
117824
  "title": "Simple User",
117660
117825
  "description": "The GitHub user that triggered the event. This property is included in every webhook payload.",
@@ -119805,169 +119970,7 @@
119805
119970
  "$ref": "#/components/schemas/repository-webhooks"
119806
119971
  },
119807
119972
  "rule": {
119808
- "title": "branch protection rule",
119809
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
119810
- "type": "object",
119811
- "properties": {
119812
- "admin_enforced": {
119813
- "type": "boolean"
119814
- },
119815
- "allow_deletions_enforcement_level": {
119816
- "type": "string",
119817
- "enum": [
119818
- "off",
119819
- "non_admins",
119820
- "everyone"
119821
- ]
119822
- },
119823
- "allow_force_pushes_enforcement_level": {
119824
- "type": "string",
119825
- "enum": [
119826
- "off",
119827
- "non_admins",
119828
- "everyone"
119829
- ]
119830
- },
119831
- "authorized_actor_names": {
119832
- "type": "array",
119833
- "items": {
119834
- "type": "string"
119835
- }
119836
- },
119837
- "authorized_actors_only": {
119838
- "type": "boolean"
119839
- },
119840
- "authorized_dismissal_actors_only": {
119841
- "type": "boolean"
119842
- },
119843
- "create_protected": {
119844
- "type": "boolean"
119845
- },
119846
- "created_at": {
119847
- "type": "string",
119848
- "format": "date-time"
119849
- },
119850
- "dismiss_stale_reviews_on_push": {
119851
- "type": "boolean"
119852
- },
119853
- "id": {
119854
- "type": "integer"
119855
- },
119856
- "ignore_approvals_from_contributors": {
119857
- "type": "boolean"
119858
- },
119859
- "linear_history_requirement_enforcement_level": {
119860
- "type": "string",
119861
- "enum": [
119862
- "off",
119863
- "non_admins",
119864
- "everyone"
119865
- ]
119866
- },
119867
- "merge_queue_enforcement_level": {
119868
- "type": "string",
119869
- "enum": [
119870
- "off",
119871
- "non_admins",
119872
- "everyone"
119873
- ]
119874
- },
119875
- "name": {
119876
- "type": "string"
119877
- },
119878
- "pull_request_reviews_enforcement_level": {
119879
- "type": "string",
119880
- "enum": [
119881
- "off",
119882
- "non_admins",
119883
- "everyone"
119884
- ]
119885
- },
119886
- "repository_id": {
119887
- "type": "integer"
119888
- },
119889
- "require_code_owner_review": {
119890
- "type": "boolean"
119891
- },
119892
- "require_last_push_approval": {
119893
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
119894
- "type": "boolean"
119895
- },
119896
- "required_approving_review_count": {
119897
- "type": "integer"
119898
- },
119899
- "required_conversation_resolution_level": {
119900
- "type": "string",
119901
- "enum": [
119902
- "off",
119903
- "non_admins",
119904
- "everyone"
119905
- ]
119906
- },
119907
- "required_deployments_enforcement_level": {
119908
- "type": "string",
119909
- "enum": [
119910
- "off",
119911
- "non_admins",
119912
- "everyone"
119913
- ]
119914
- },
119915
- "required_status_checks": {
119916
- "type": "array",
119917
- "items": {
119918
- "type": "string"
119919
- }
119920
- },
119921
- "required_status_checks_enforcement_level": {
119922
- "type": "string",
119923
- "enum": [
119924
- "off",
119925
- "non_admins",
119926
- "everyone"
119927
- ]
119928
- },
119929
- "signature_requirement_enforcement_level": {
119930
- "type": "string",
119931
- "enum": [
119932
- "off",
119933
- "non_admins",
119934
- "everyone"
119935
- ]
119936
- },
119937
- "strict_required_status_checks_policy": {
119938
- "type": "boolean"
119939
- },
119940
- "updated_at": {
119941
- "type": "string",
119942
- "format": "date-time"
119943
- }
119944
- },
119945
- "required": [
119946
- "id",
119947
- "repository_id",
119948
- "name",
119949
- "created_at",
119950
- "updated_at",
119951
- "pull_request_reviews_enforcement_level",
119952
- "required_approving_review_count",
119953
- "dismiss_stale_reviews_on_push",
119954
- "require_code_owner_review",
119955
- "authorized_dismissal_actors_only",
119956
- "ignore_approvals_from_contributors",
119957
- "required_status_checks",
119958
- "required_status_checks_enforcement_level",
119959
- "strict_required_status_checks_policy",
119960
- "signature_requirement_enforcement_level",
119961
- "linear_history_requirement_enforcement_level",
119962
- "admin_enforced",
119963
- "allow_force_pushes_enforcement_level",
119964
- "allow_deletions_enforcement_level",
119965
- "merge_queue_enforcement_level",
119966
- "required_deployments_enforcement_level",
119967
- "required_conversation_resolution_level",
119968
- "authorized_actors_only",
119969
- "authorized_actor_names"
119970
- ]
119973
+ "$ref": "#/components/schemas/webhooks_rule"
119971
119974
  },
119972
119975
  "sender": {
119973
119976
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -120003,169 +120006,7 @@
120003
120006
  "$ref": "#/components/schemas/repository-webhooks"
120004
120007
  },
120005
120008
  "rule": {
120006
- "title": "branch protection rule",
120007
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
120008
- "type": "object",
120009
- "properties": {
120010
- "admin_enforced": {
120011
- "type": "boolean"
120012
- },
120013
- "allow_deletions_enforcement_level": {
120014
- "type": "string",
120015
- "enum": [
120016
- "off",
120017
- "non_admins",
120018
- "everyone"
120019
- ]
120020
- },
120021
- "allow_force_pushes_enforcement_level": {
120022
- "type": "string",
120023
- "enum": [
120024
- "off",
120025
- "non_admins",
120026
- "everyone"
120027
- ]
120028
- },
120029
- "authorized_actor_names": {
120030
- "type": "array",
120031
- "items": {
120032
- "type": "string"
120033
- }
120034
- },
120035
- "authorized_actors_only": {
120036
- "type": "boolean"
120037
- },
120038
- "authorized_dismissal_actors_only": {
120039
- "type": "boolean"
120040
- },
120041
- "create_protected": {
120042
- "type": "boolean"
120043
- },
120044
- "created_at": {
120045
- "type": "string",
120046
- "format": "date-time"
120047
- },
120048
- "dismiss_stale_reviews_on_push": {
120049
- "type": "boolean"
120050
- },
120051
- "id": {
120052
- "type": "integer"
120053
- },
120054
- "ignore_approvals_from_contributors": {
120055
- "type": "boolean"
120056
- },
120057
- "linear_history_requirement_enforcement_level": {
120058
- "type": "string",
120059
- "enum": [
120060
- "off",
120061
- "non_admins",
120062
- "everyone"
120063
- ]
120064
- },
120065
- "merge_queue_enforcement_level": {
120066
- "type": "string",
120067
- "enum": [
120068
- "off",
120069
- "non_admins",
120070
- "everyone"
120071
- ]
120072
- },
120073
- "name": {
120074
- "type": "string"
120075
- },
120076
- "pull_request_reviews_enforcement_level": {
120077
- "type": "string",
120078
- "enum": [
120079
- "off",
120080
- "non_admins",
120081
- "everyone"
120082
- ]
120083
- },
120084
- "repository_id": {
120085
- "type": "integer"
120086
- },
120087
- "require_code_owner_review": {
120088
- "type": "boolean"
120089
- },
120090
- "require_last_push_approval": {
120091
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
120092
- "type": "boolean"
120093
- },
120094
- "required_approving_review_count": {
120095
- "type": "integer"
120096
- },
120097
- "required_conversation_resolution_level": {
120098
- "type": "string",
120099
- "enum": [
120100
- "off",
120101
- "non_admins",
120102
- "everyone"
120103
- ]
120104
- },
120105
- "required_deployments_enforcement_level": {
120106
- "type": "string",
120107
- "enum": [
120108
- "off",
120109
- "non_admins",
120110
- "everyone"
120111
- ]
120112
- },
120113
- "required_status_checks": {
120114
- "type": "array",
120115
- "items": {
120116
- "type": "string"
120117
- }
120118
- },
120119
- "required_status_checks_enforcement_level": {
120120
- "type": "string",
120121
- "enum": [
120122
- "off",
120123
- "non_admins",
120124
- "everyone"
120125
- ]
120126
- },
120127
- "signature_requirement_enforcement_level": {
120128
- "type": "string",
120129
- "enum": [
120130
- "off",
120131
- "non_admins",
120132
- "everyone"
120133
- ]
120134
- },
120135
- "strict_required_status_checks_policy": {
120136
- "type": "boolean"
120137
- },
120138
- "updated_at": {
120139
- "type": "string",
120140
- "format": "date-time"
120141
- }
120142
- },
120143
- "required": [
120144
- "id",
120145
- "repository_id",
120146
- "name",
120147
- "created_at",
120148
- "updated_at",
120149
- "pull_request_reviews_enforcement_level",
120150
- "required_approving_review_count",
120151
- "dismiss_stale_reviews_on_push",
120152
- "require_code_owner_review",
120153
- "authorized_dismissal_actors_only",
120154
- "ignore_approvals_from_contributors",
120155
- "required_status_checks",
120156
- "required_status_checks_enforcement_level",
120157
- "strict_required_status_checks_policy",
120158
- "signature_requirement_enforcement_level",
120159
- "linear_history_requirement_enforcement_level",
120160
- "admin_enforced",
120161
- "allow_force_pushes_enforcement_level",
120162
- "allow_deletions_enforcement_level",
120163
- "merge_queue_enforcement_level",
120164
- "required_deployments_enforcement_level",
120165
- "required_conversation_resolution_level",
120166
- "authorized_actors_only",
120167
- "authorized_actor_names"
120168
- ]
120009
+ "$ref": "#/components/schemas/webhooks_rule"
120169
120010
  },
120170
120011
  "sender": {
120171
120012
  "$ref": "#/components/schemas/simple-user-webhooks"
@@ -120303,169 +120144,7 @@
120303
120144
  "$ref": "#/components/schemas/repository-webhooks"
120304
120145
  },
120305
120146
  "rule": {
120306
- "title": "branch protection rule",
120307
- "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
120308
- "type": "object",
120309
- "properties": {
120310
- "admin_enforced": {
120311
- "type": "boolean"
120312
- },
120313
- "allow_deletions_enforcement_level": {
120314
- "type": "string",
120315
- "enum": [
120316
- "off",
120317
- "non_admins",
120318
- "everyone"
120319
- ]
120320
- },
120321
- "allow_force_pushes_enforcement_level": {
120322
- "type": "string",
120323
- "enum": [
120324
- "off",
120325
- "non_admins",
120326
- "everyone"
120327
- ]
120328
- },
120329
- "authorized_actor_names": {
120330
- "type": "array",
120331
- "items": {
120332
- "type": "string"
120333
- }
120334
- },
120335
- "authorized_actors_only": {
120336
- "type": "boolean"
120337
- },
120338
- "authorized_dismissal_actors_only": {
120339
- "type": "boolean"
120340
- },
120341
- "create_protected": {
120342
- "type": "boolean"
120343
- },
120344
- "created_at": {
120345
- "type": "string",
120346
- "format": "date-time"
120347
- },
120348
- "dismiss_stale_reviews_on_push": {
120349
- "type": "boolean"
120350
- },
120351
- "id": {
120352
- "type": "integer"
120353
- },
120354
- "ignore_approvals_from_contributors": {
120355
- "type": "boolean"
120356
- },
120357
- "linear_history_requirement_enforcement_level": {
120358
- "type": "string",
120359
- "enum": [
120360
- "off",
120361
- "non_admins",
120362
- "everyone"
120363
- ]
120364
- },
120365
- "merge_queue_enforcement_level": {
120366
- "type": "string",
120367
- "enum": [
120368
- "off",
120369
- "non_admins",
120370
- "everyone"
120371
- ]
120372
- },
120373
- "name": {
120374
- "type": "string"
120375
- },
120376
- "pull_request_reviews_enforcement_level": {
120377
- "type": "string",
120378
- "enum": [
120379
- "off",
120380
- "non_admins",
120381
- "everyone"
120382
- ]
120383
- },
120384
- "repository_id": {
120385
- "type": "integer"
120386
- },
120387
- "require_code_owner_review": {
120388
- "type": "boolean"
120389
- },
120390
- "require_last_push_approval": {
120391
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
120392
- "type": "boolean"
120393
- },
120394
- "required_approving_review_count": {
120395
- "type": "integer"
120396
- },
120397
- "required_conversation_resolution_level": {
120398
- "type": "string",
120399
- "enum": [
120400
- "off",
120401
- "non_admins",
120402
- "everyone"
120403
- ]
120404
- },
120405
- "required_deployments_enforcement_level": {
120406
- "type": "string",
120407
- "enum": [
120408
- "off",
120409
- "non_admins",
120410
- "everyone"
120411
- ]
120412
- },
120413
- "required_status_checks": {
120414
- "type": "array",
120415
- "items": {
120416
- "type": "string"
120417
- }
120418
- },
120419
- "required_status_checks_enforcement_level": {
120420
- "type": "string",
120421
- "enum": [
120422
- "off",
120423
- "non_admins",
120424
- "everyone"
120425
- ]
120426
- },
120427
- "signature_requirement_enforcement_level": {
120428
- "type": "string",
120429
- "enum": [
120430
- "off",
120431
- "non_admins",
120432
- "everyone"
120433
- ]
120434
- },
120435
- "strict_required_status_checks_policy": {
120436
- "type": "boolean"
120437
- },
120438
- "updated_at": {
120439
- "type": "string",
120440
- "format": "date-time"
120441
- }
120442
- },
120443
- "required": [
120444
- "id",
120445
- "repository_id",
120446
- "name",
120447
- "created_at",
120448
- "updated_at",
120449
- "pull_request_reviews_enforcement_level",
120450
- "required_approving_review_count",
120451
- "dismiss_stale_reviews_on_push",
120452
- "require_code_owner_review",
120453
- "authorized_dismissal_actors_only",
120454
- "ignore_approvals_from_contributors",
120455
- "required_status_checks",
120456
- "required_status_checks_enforcement_level",
120457
- "strict_required_status_checks_policy",
120458
- "signature_requirement_enforcement_level",
120459
- "linear_history_requirement_enforcement_level",
120460
- "admin_enforced",
120461
- "allow_force_pushes_enforcement_level",
120462
- "allow_deletions_enforcement_level",
120463
- "merge_queue_enforcement_level",
120464
- "required_deployments_enforcement_level",
120465
- "required_conversation_resolution_level",
120466
- "authorized_actors_only",
120467
- "authorized_actor_names"
120468
- ]
120147
+ "$ref": "#/components/schemas/webhooks_rule"
120469
120148
  },
120470
120149
  "sender": {
120471
120150
  "$ref": "#/components/schemas/simple-user-webhooks"