@octokit/openapi 5.6.1 → 5.6.5

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 (27) hide show
  1. package/generated/api.github.com.deref.json +3451 -2749
  2. package/generated/api.github.com.json +440 -1599
  3. package/generated/ghes-2.22-diff-to-ghes-3.0.deref.json +1 -1
  4. package/generated/ghes-2.22-diff-to-ghes-3.0.json +1 -1
  5. package/generated/ghes-2.22.deref.json +1 -1
  6. package/generated/ghes-2.22.json +1 -1
  7. package/generated/ghes-3.0-anicca-diff-to-ghes-3.1.deref.json +0 -145
  8. package/generated/ghes-3.0-diff-to-ghes-3.1.deref.json +8739 -19455
  9. package/generated/ghes-3.0-diff-to-ghes-3.1.json +245 -1527
  10. package/generated/ghes-3.0.deref.json +3494 -1920
  11. package/generated/ghes-3.0.json +420 -721
  12. package/generated/ghes-3.1-anicca-diff-to-ghes-3.2.deref.json +286 -1466
  13. package/generated/ghes-3.1-diff-to-ghes-3.2.deref.json +58842 -105018
  14. package/generated/ghes-3.1-diff-to-ghes-3.2.json +11129 -16701
  15. package/generated/ghes-3.1.deref.json +3545 -1951
  16. package/generated/ghes-3.1.json +467 -752
  17. package/generated/ghes-3.2-anicca-diff-to-api.github.com.deref.json +7 -136
  18. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +333 -2109
  19. package/generated/ghes-3.2-diff-to-api.github.com.json +45 -742
  20. package/generated/ghes-3.2.deref.json +3597 -1953
  21. package/generated/ghes-3.2.json +474 -752
  22. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +3 -59
  23. package/generated/github.ae-diff-to-api.github.com.deref.json +4 -4963
  24. package/generated/github.ae-diff-to-api.github.com.json +109 -2784
  25. package/generated/github.ae.deref.json +2270 -2214
  26. package/generated/github.ae.json +337 -1464
  27. package/package.json +2 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.6.1",
4
+ "version": "5.6.5",
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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -624,6 +624,7 @@
624
624
  }
625
625
  },
626
626
  "requestBody": {
627
+ "required": true,
627
628
  "content": {
628
629
  "application/json": {
629
630
  "schema": {
@@ -633,7 +634,8 @@
633
634
  "type": "string",
634
635
  "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."
635
636
  }
636
- }
637
+ },
638
+ "required": ["ldap_dn"]
637
639
  },
638
640
  "example": {
639
641
  "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
@@ -719,6 +721,7 @@
719
721
  }
720
722
  },
721
723
  "requestBody": {
724
+ "required": true,
722
725
  "content": {
723
726
  "application/json": {
724
727
  "schema": {
@@ -728,7 +731,8 @@
728
731
  "type": "string",
729
732
  "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."
730
733
  }
731
- }
734
+ },
735
+ "required": ["ldap_dn"]
732
736
  },
733
737
  "example": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" }
734
738
  }
@@ -807,6 +811,7 @@
807
811
  }
808
812
  },
809
813
  "requestBody": {
814
+ "required": true,
810
815
  "content": {
811
816
  "application/json": {
812
817
  "schema": {
@@ -1911,6 +1916,7 @@
1911
1916
  }
1912
1917
  },
1913
1918
  "requestBody": {
1919
+ "required": true,
1914
1920
  "content": {
1915
1921
  "application/json": {
1916
1922
  "schema": {
@@ -2129,6 +2135,7 @@
2129
2135
  "tags": ["enterprise-admin"],
2130
2136
  "operationId": "enterprise-admin/set-announcement",
2131
2137
  "requestBody": {
2138
+ "required": true,
2132
2139
  "content": {
2133
2140
  "application/json": {
2134
2141
  "schema": { "$ref": "#/components/schemas/announcement" }
@@ -2597,40 +2604,6 @@
2597
2604
  "x-octokit": {
2598
2605
  "diff": { "api.github.com.json": { "type": "changed" } }
2599
2606
  }
2600
- },
2601
- "put": {
2602
- "summary": "Set allowed actions for an enterprise",
2603
- "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
2604
- "operationId": "enterprise-admin/set-allowed-actions-enterprise",
2605
- "tags": ["enterprise-admin"],
2606
- "externalDocs": {
2607
- "description": "API method documentation",
2608
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise"
2609
- },
2610
- "parameters": [{ "$ref": "#/components/parameters/enterprise" }],
2611
- "responses": { "204": { "description": "Response" } },
2612
- "requestBody": {
2613
- "content": {
2614
- "application/json": {
2615
- "schema": { "$ref": "#/components/schemas/selected-actions" },
2616
- "examples": {
2617
- "selected_actions": {
2618
- "$ref": "#/components/examples/selected-actions"
2619
- }
2620
- }
2621
- }
2622
- }
2623
- },
2624
- "x-github": {
2625
- "enabledForGitHubApps": false,
2626
- "githubCloudOnly": false,
2627
- "previews": [],
2628
- "category": "enterprise-admin",
2629
- "subcategory": "actions"
2630
- },
2631
- "x-octokit": {
2632
- "diff": { "api.github.com.json": { "type": "changed" } }
2633
- }
2634
2607
  }
2635
2608
  },
2636
2609
  "/meta": {
@@ -2670,161 +2643,6 @@
2670
2643
  }
2671
2644
  }
2672
2645
  },
2673
- "/orgs/{org}": {
2674
- "patch": {
2675
- "summary": "Update an organization",
2676
- "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
2677
- "tags": ["orgs"],
2678
- "operationId": "orgs/update",
2679
- "externalDocs": {
2680
- "description": "API method documentation",
2681
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs/#update-an-organization"
2682
- },
2683
- "parameters": [{ "$ref": "#/components/parameters/org" }],
2684
- "requestBody": {
2685
- "content": {
2686
- "application/json": {
2687
- "schema": {
2688
- "type": "object",
2689
- "properties": {
2690
- "billing_email": {
2691
- "type": "string",
2692
- "description": "Billing email address. This address is not publicized."
2693
- },
2694
- "company": {
2695
- "type": "string",
2696
- "description": "The company name."
2697
- },
2698
- "email": {
2699
- "type": "string",
2700
- "description": "The publicly visible email address."
2701
- },
2702
- "twitter_username": {
2703
- "type": "string",
2704
- "description": "The Twitter username of the company."
2705
- },
2706
- "location": {
2707
- "type": "string",
2708
- "description": "The location."
2709
- },
2710
- "name": {
2711
- "type": "string",
2712
- "description": "The shorthand name of the company."
2713
- },
2714
- "description": {
2715
- "type": "string",
2716
- "description": "The description of the company."
2717
- },
2718
- "has_organization_projects": {
2719
- "type": "boolean",
2720
- "description": "Toggles whether an organization can use organization projects."
2721
- },
2722
- "has_repository_projects": {
2723
- "type": "boolean",
2724
- "description": "Toggles whether repositories that belong to the organization can use repository projects."
2725
- },
2726
- "default_repository_permission": {
2727
- "type": "string",
2728
- "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.",
2729
- "enum": ["read", "write", "admin", "none"],
2730
- "default": "read"
2731
- },
2732
- "members_can_create_repositories": {
2733
- "type": "boolean",
2734
- "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.",
2735
- "default": true
2736
- },
2737
- "members_can_create_internal_repositories": {
2738
- "type": "boolean",
2739
- "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
2740
- },
2741
- "members_can_create_private_repositories": {
2742
- "type": "boolean",
2743
- "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
2744
- },
2745
- "members_can_create_public_repositories": {
2746
- "type": "boolean",
2747
- "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
2748
- },
2749
- "members_allowed_repository_creation_type": {
2750
- "type": "string",
2751
- "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
2752
- "enum": ["all", "private", "none"]
2753
- },
2754
- "members_can_create_pages": {
2755
- "type": "boolean",
2756
- "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.",
2757
- "default": true
2758
- },
2759
- "blog": {
2760
- "type": "string",
2761
- "example": "\"http://github.blog\""
2762
- }
2763
- }
2764
- },
2765
- "example": {
2766
- "billing_email": "mona@github.com",
2767
- "company": "GitHub",
2768
- "email": "mona@github.com",
2769
- "twitter_username": "github",
2770
- "location": "San Francisco",
2771
- "name": "github",
2772
- "description": "GitHub, the company.",
2773
- "default_repository_permission": "read",
2774
- "members_can_create_repositories": true,
2775
- "members_allowed_repository_creation_type": "all"
2776
- }
2777
- }
2778
- }
2779
- },
2780
- "responses": {
2781
- "200": {
2782
- "description": "Response",
2783
- "content": {
2784
- "application/json": {
2785
- "schema": { "$ref": "#/components/schemas/organization-full" },
2786
- "examples": {
2787
- "default": {
2788
- "$ref": "#/components/examples/organization-full"
2789
- }
2790
- }
2791
- }
2792
- }
2793
- },
2794
- "409": { "$ref": "#/components/responses/conflict" },
2795
- "415": { "$ref": "#/components/responses/preview_header_missing" },
2796
- "422": {
2797
- "description": "Validation failed",
2798
- "content": {
2799
- "application/json": {
2800
- "schema": {
2801
- "oneOf": [
2802
- { "$ref": "#/components/schemas/validation-error" },
2803
- { "$ref": "#/components/schemas/validation-error-simple" }
2804
- ]
2805
- }
2806
- }
2807
- }
2808
- }
2809
- },
2810
- "x-github": {
2811
- "githubCloudOnly": false,
2812
- "enabledForGitHubApps": true,
2813
- "previews": [
2814
- {
2815
- "required": false,
2816
- "name": "surtur",
2817
- "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
2818
- }
2819
- ],
2820
- "category": "orgs",
2821
- "subcategory": null
2822
- },
2823
- "x-octokit": {
2824
- "diff": { "api.github.com.json": { "type": "changed" } }
2825
- }
2826
- }
2827
- },
2828
2646
  "/orgs/{org}/actions/permissions/selected-actions": {
2829
2647
  "get": {
2830
2648
  "summary": "Get allowed actions for an organization",
@@ -2861,40 +2679,6 @@
2861
2679
  "x-octokit": {
2862
2680
  "diff": { "api.github.com.json": { "type": "changed" } }
2863
2681
  }
2864
- },
2865
- "put": {
2866
- "summary": "Set allowed actions for an organization",
2867
- "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
2868
- "operationId": "actions/set-allowed-actions-organization",
2869
- "tags": ["actions"],
2870
- "externalDocs": {
2871
- "description": "API method documentation",
2872
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-an-organization"
2873
- },
2874
- "parameters": [{ "$ref": "#/components/parameters/org" }],
2875
- "responses": { "204": { "description": "Response" } },
2876
- "requestBody": {
2877
- "content": {
2878
- "application/json": {
2879
- "schema": { "$ref": "#/components/schemas/selected-actions" },
2880
- "examples": {
2881
- "selected_actions": {
2882
- "$ref": "#/components/examples/selected-actions"
2883
- }
2884
- }
2885
- }
2886
- }
2887
- },
2888
- "x-github": {
2889
- "enabledForGitHubApps": true,
2890
- "githubCloudOnly": false,
2891
- "previews": [],
2892
- "category": "actions",
2893
- "subcategory": "permissions"
2894
- },
2895
- "x-octokit": {
2896
- "diff": { "api.github.com.json": { "type": "changed" } }
2897
- }
2898
2682
  }
2899
2683
  },
2900
2684
  "/orgs/{org}/pre-receive-hooks": {
@@ -3159,43 +2943,6 @@
3159
2943
  "x-octokit": {
3160
2944
  "diff": { "api.github.com.json": { "type": "changed" } }
3161
2945
  }
3162
- },
3163
- "put": {
3164
- "summary": "Set allowed actions for a repository",
3165
- "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
3166
- "operationId": "actions/set-allowed-actions-repository",
3167
- "tags": ["actions"],
3168
- "externalDocs": {
3169
- "description": "API method documentation",
3170
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-a-repository"
3171
- },
3172
- "parameters": [
3173
- { "$ref": "#/components/parameters/owner" },
3174
- { "$ref": "#/components/parameters/repo" }
3175
- ],
3176
- "responses": { "204": { "description": "Response" } },
3177
- "requestBody": {
3178
- "content": {
3179
- "application/json": {
3180
- "schema": { "$ref": "#/components/schemas/selected-actions" },
3181
- "examples": {
3182
- "selected_actions": {
3183
- "$ref": "#/components/examples/selected-actions"
3184
- }
3185
- }
3186
- }
3187
- }
3188
- },
3189
- "x-github": {
3190
- "enabledForGitHubApps": true,
3191
- "githubCloudOnly": false,
3192
- "previews": [],
3193
- "category": "actions",
3194
- "subcategory": "permissions"
3195
- },
3196
- "x-octokit": {
3197
- "diff": { "api.github.com.json": { "type": "changed" } }
3198
- }
3199
2946
  }
3200
2947
  },
3201
2948
  "/repos/{owner}/{repo}/pre-receive-hooks": {
@@ -3462,98 +3209,6 @@
3462
3209
  "x-octokit": {
3463
3210
  "diff": { "api.github.com.json": { "type": "changed" } }
3464
3211
  }
3465
- },
3466
- "post": {
3467
- "summary": "Create a release",
3468
- "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
3469
- "tags": ["repos"],
3470
- "operationId": "repos/create-release",
3471
- "externalDocs": {
3472
- "description": "API method documentation",
3473
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-release"
3474
- },
3475
- "parameters": [
3476
- { "$ref": "#/components/parameters/owner" },
3477
- { "$ref": "#/components/parameters/repo" }
3478
- ],
3479
- "requestBody": {
3480
- "required": true,
3481
- "content": {
3482
- "application/json": {
3483
- "schema": {
3484
- "type": "object",
3485
- "properties": {
3486
- "tag_name": {
3487
- "type": "string",
3488
- "description": "The name of the tag."
3489
- },
3490
- "target_commitish": {
3491
- "type": "string",
3492
- "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`)."
3493
- },
3494
- "name": {
3495
- "type": "string",
3496
- "description": "The name of the release."
3497
- },
3498
- "body": {
3499
- "type": "string",
3500
- "description": "Text describing the contents of the tag."
3501
- },
3502
- "draft": {
3503
- "type": "boolean",
3504
- "description": "`true` to create a draft (unpublished) release, `false` to create a published one.",
3505
- "default": false
3506
- },
3507
- "prerelease": {
3508
- "type": "boolean",
3509
- "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
3510
- "default": false
3511
- }
3512
- },
3513
- "required": ["tag_name"]
3514
- },
3515
- "example": {
3516
- "tag_name": "v1.0.0",
3517
- "target_commitish": "master",
3518
- "name": "v1.0.0",
3519
- "body": "Description of the release",
3520
- "draft": false,
3521
- "prerelease": false
3522
- }
3523
- }
3524
- }
3525
- },
3526
- "responses": {
3527
- "201": {
3528
- "description": "Response",
3529
- "content": {
3530
- "application/json": {
3531
- "schema": { "$ref": "#/components/schemas/release" },
3532
- "examples": {
3533
- "default": { "$ref": "#/components/examples/release" }
3534
- }
3535
- }
3536
- },
3537
- "headers": {
3538
- "Location": {
3539
- "example": "https://api.github.com/repos/octocat/Hello-World/releases/1",
3540
- "schema": { "type": "string" }
3541
- }
3542
- }
3543
- },
3544
- "422": { "$ref": "#/components/responses/validation_failed" }
3545
- },
3546
- "x-github": {
3547
- "triggersNotification": true,
3548
- "githubCloudOnly": false,
3549
- "enabledForGitHubApps": true,
3550
- "previews": [],
3551
- "category": "repos",
3552
- "subcategory": "releases"
3553
- },
3554
- "x-octokit": {
3555
- "diff": { "api.github.com.json": { "type": "changed" } }
3556
- }
3557
3212
  }
3558
3213
  },
3559
3214
  "/repos/{owner}/{repo}/releases/latest": {
@@ -3682,87 +3337,6 @@
3682
3337
  "x-octokit": {
3683
3338
  "diff": { "api.github.com.json": { "type": "changed" } }
3684
3339
  }
3685
- },
3686
- "patch": {
3687
- "summary": "Update a release",
3688
- "description": "Users with push access to the repository can edit a release.",
3689
- "tags": ["repos"],
3690
- "operationId": "repos/update-release",
3691
- "externalDocs": {
3692
- "description": "API method documentation",
3693
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-a-release"
3694
- },
3695
- "parameters": [
3696
- { "$ref": "#/components/parameters/owner" },
3697
- { "$ref": "#/components/parameters/repo" },
3698
- { "$ref": "#/components/parameters/release-id" }
3699
- ],
3700
- "requestBody": {
3701
- "content": {
3702
- "application/json": {
3703
- "schema": {
3704
- "type": "object",
3705
- "properties": {
3706
- "tag_name": {
3707
- "type": "string",
3708
- "description": "The name of the tag."
3709
- },
3710
- "target_commitish": {
3711
- "type": "string",
3712
- "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`)."
3713
- },
3714
- "name": {
3715
- "type": "string",
3716
- "description": "The name of the release."
3717
- },
3718
- "body": {
3719
- "type": "string",
3720
- "description": "Text describing the contents of the tag."
3721
- },
3722
- "draft": {
3723
- "type": "boolean",
3724
- "description": "`true` makes the release a draft, and `false` publishes the release."
3725
- },
3726
- "prerelease": {
3727
- "type": "boolean",
3728
- "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release."
3729
- }
3730
- }
3731
- },
3732
- "example": {
3733
- "tag_name": "v1.0.0",
3734
- "target_commitish": "master",
3735
- "name": "v1.0.0",
3736
- "body": "Description of the release",
3737
- "draft": false,
3738
- "prerelease": false
3739
- }
3740
- }
3741
- }
3742
- },
3743
- "responses": {
3744
- "200": {
3745
- "description": "Response",
3746
- "content": {
3747
- "application/json": {
3748
- "schema": { "$ref": "#/components/schemas/release" },
3749
- "examples": {
3750
- "default": { "$ref": "#/components/examples/release" }
3751
- }
3752
- }
3753
- }
3754
- }
3755
- },
3756
- "x-github": {
3757
- "githubCloudOnly": false,
3758
- "enabledForGitHubApps": true,
3759
- "previews": [],
3760
- "category": "repos",
3761
- "subcategory": "releases"
3762
- },
3763
- "x-octokit": {
3764
- "diff": { "api.github.com.json": { "type": "changed" } }
3765
- }
3766
3340
  }
3767
3341
  },
3768
3342
  "/repositories": {
@@ -5366,239 +4940,6 @@
5366
4940
  },
5367
4941
  "required": ["verifiable_password_authentication"]
5368
4942
  },
5369
- "organization-full": {
5370
- "title": "Organization Full",
5371
- "description": "Organization Full",
5372
- "type": "object",
5373
- "properties": {
5374
- "login": { "type": "string", "example": "github" },
5375
- "id": { "type": "integer", "example": 1 },
5376
- "node_id": {
5377
- "type": "string",
5378
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
5379
- },
5380
- "url": {
5381
- "type": "string",
5382
- "format": "uri",
5383
- "example": "https://api.github.com/orgs/github"
5384
- },
5385
- "repos_url": {
5386
- "type": "string",
5387
- "format": "uri",
5388
- "example": "https://api.github.com/orgs/github/repos"
5389
- },
5390
- "events_url": {
5391
- "type": "string",
5392
- "format": "uri",
5393
- "example": "https://api.github.com/orgs/github/events"
5394
- },
5395
- "hooks_url": {
5396
- "type": "string",
5397
- "example": "https://api.github.com/orgs/github/hooks"
5398
- },
5399
- "issues_url": {
5400
- "type": "string",
5401
- "example": "https://api.github.com/orgs/github/issues"
5402
- },
5403
- "members_url": {
5404
- "type": "string",
5405
- "example": "https://api.github.com/orgs/github/members{/member}"
5406
- },
5407
- "public_members_url": {
5408
- "type": "string",
5409
- "example": "https://api.github.com/orgs/github/public_members{/member}"
5410
- },
5411
- "avatar_url": {
5412
- "type": "string",
5413
- "example": "https://github.com/images/error/octocat_happy.gif"
5414
- },
5415
- "description": {
5416
- "type": "string",
5417
- "example": "A great organization",
5418
- "nullable": true
5419
- },
5420
- "name": { "type": "string", "example": "github" },
5421
- "company": { "type": "string", "example": "GitHub" },
5422
- "blog": {
5423
- "type": "string",
5424
- "format": "uri",
5425
- "example": "https://github.com/blog"
5426
- },
5427
- "location": { "type": "string", "example": "San Francisco" },
5428
- "email": {
5429
- "type": "string",
5430
- "format": "email",
5431
- "example": "octocat@github.com"
5432
- },
5433
- "twitter_username": {
5434
- "type": "string",
5435
- "example": "github",
5436
- "nullable": true
5437
- },
5438
- "is_verified": { "type": "boolean", "example": true },
5439
- "has_organization_projects": { "type": "boolean", "example": true },
5440
- "has_repository_projects": { "type": "boolean", "example": true },
5441
- "public_repos": { "type": "integer", "example": 2 },
5442
- "public_gists": { "type": "integer", "example": 1 },
5443
- "followers": { "type": "integer", "example": 20 },
5444
- "following": { "type": "integer", "example": 0 },
5445
- "html_url": {
5446
- "type": "string",
5447
- "format": "uri",
5448
- "example": "https://github.com/octocat"
5449
- },
5450
- "created_at": {
5451
- "type": "string",
5452
- "format": "date-time",
5453
- "example": "2008-01-14T04:33:35Z"
5454
- },
5455
- "type": { "type": "string", "example": "Organization" },
5456
- "total_private_repos": { "type": "integer", "example": 100 },
5457
- "owned_private_repos": { "type": "integer", "example": 100 },
5458
- "private_gists": {
5459
- "type": "integer",
5460
- "example": 81,
5461
- "nullable": true
5462
- },
5463
- "disk_usage": {
5464
- "type": "integer",
5465
- "example": 10000,
5466
- "nullable": true
5467
- },
5468
- "collaborators": {
5469
- "type": "integer",
5470
- "example": 8,
5471
- "nullable": true
5472
- },
5473
- "billing_email": {
5474
- "type": "string",
5475
- "format": "email",
5476
- "example": "org@example.com",
5477
- "nullable": true
5478
- },
5479
- "plan": {
5480
- "type": "object",
5481
- "properties": {
5482
- "name": { "type": "string" },
5483
- "space": { "type": "integer" },
5484
- "private_repos": { "type": "integer" },
5485
- "filled_seats": { "type": "integer" },
5486
- "seats": { "type": "integer" }
5487
- },
5488
- "required": ["name", "space", "private_repos"]
5489
- },
5490
- "default_repository_permission": {
5491
- "type": "string",
5492
- "nullable": true
5493
- },
5494
- "members_can_create_repositories": {
5495
- "type": "boolean",
5496
- "example": true,
5497
- "nullable": true
5498
- },
5499
- "two_factor_requirement_enabled": {
5500
- "type": "boolean",
5501
- "example": true,
5502
- "nullable": true
5503
- },
5504
- "members_allowed_repository_creation_type": {
5505
- "type": "string",
5506
- "example": "all"
5507
- },
5508
- "members_can_create_public_repositories": {
5509
- "type": "boolean",
5510
- "example": true
5511
- },
5512
- "members_can_create_private_repositories": {
5513
- "type": "boolean",
5514
- "example": true
5515
- },
5516
- "members_can_create_internal_repositories": {
5517
- "type": "boolean",
5518
- "example": true
5519
- },
5520
- "members_can_create_pages": { "type": "boolean", "example": true },
5521
- "members_can_create_public_pages": {
5522
- "type": "boolean",
5523
- "example": true
5524
- },
5525
- "members_can_create_private_pages": {
5526
- "type": "boolean",
5527
- "example": true
5528
- },
5529
- "updated_at": { "type": "string", "format": "date-time" }
5530
- },
5531
- "required": [
5532
- "login",
5533
- "url",
5534
- "id",
5535
- "node_id",
5536
- "repos_url",
5537
- "events_url",
5538
- "hooks_url",
5539
- "issues_url",
5540
- "members_url",
5541
- "public_members_url",
5542
- "avatar_url",
5543
- "description",
5544
- "html_url",
5545
- "has_organization_projects",
5546
- "has_repository_projects",
5547
- "public_repos",
5548
- "public_gists",
5549
- "followers",
5550
- "following",
5551
- "type",
5552
- "created_at",
5553
- "updated_at"
5554
- ]
5555
- },
5556
- "validation-error": {
5557
- "title": "Validation Error",
5558
- "description": "Validation Error",
5559
- "type": "object",
5560
- "required": ["message", "documentation_url"],
5561
- "properties": {
5562
- "message": { "type": "string" },
5563
- "documentation_url": { "type": "string" },
5564
- "errors": {
5565
- "type": "array",
5566
- "items": {
5567
- "type": "object",
5568
- "required": ["code"],
5569
- "properties": {
5570
- "resource": { "type": "string" },
5571
- "field": { "type": "string" },
5572
- "message": { "type": "string" },
5573
- "code": { "type": "string" },
5574
- "index": { "type": "integer" },
5575
- "value": {
5576
- "oneOf": [
5577
- { "type": "string", "nullable": true },
5578
- { "type": "integer", "nullable": true },
5579
- {
5580
- "type": "array",
5581
- "nullable": true,
5582
- "items": { "type": "string" }
5583
- }
5584
- ]
5585
- }
5586
- }
5587
- }
5588
- }
5589
- }
5590
- },
5591
- "validation-error-simple": {
5592
- "title": "Validation Error Simple",
5593
- "description": "Validation Error Simple",
5594
- "type": "object",
5595
- "required": ["message", "documentation_url"],
5596
- "properties": {
5597
- "message": { "type": "string" },
5598
- "documentation_url": { "type": "string" },
5599
- "errors": { "type": "array", "items": { "type": "string" } }
5600
- }
5601
- },
5602
4943
  "org-pre-receive-hook": {
5603
4944
  "type": "object",
5604
4945
  "properties": {
@@ -7238,6 +6579,41 @@
7238
6579
  "html_url": { "type": "string", "format": "uri", "nullable": true }
7239
6580
  },
7240
6581
  "required": ["url", "html_url", "key", "name"]
6582
+ },
6583
+ "validation-error": {
6584
+ "title": "Validation Error",
6585
+ "description": "Validation Error",
6586
+ "type": "object",
6587
+ "required": ["message", "documentation_url"],
6588
+ "properties": {
6589
+ "message": { "type": "string" },
6590
+ "documentation_url": { "type": "string" },
6591
+ "errors": {
6592
+ "type": "array",
6593
+ "items": {
6594
+ "type": "object",
6595
+ "required": ["code"],
6596
+ "properties": {
6597
+ "resource": { "type": "string" },
6598
+ "field": { "type": "string" },
6599
+ "message": { "type": "string" },
6600
+ "code": { "type": "string" },
6601
+ "index": { "type": "integer" },
6602
+ "value": {
6603
+ "oneOf": [
6604
+ { "type": "string", "nullable": true },
6605
+ { "type": "integer", "nullable": true },
6606
+ {
6607
+ "type": "array",
6608
+ "nullable": true,
6609
+ "items": { "type": "string" }
6610
+ }
6611
+ ]
6612
+ }
6613
+ }
6614
+ }
6615
+ }
6616
+ }
7241
6617
  }
7242
6618
  },
7243
6619
  "examples": {
@@ -7800,56 +7176,6 @@
7800
7176
  "installed_version": "3.2.0"
7801
7177
  }
7802
7178
  },
7803
- "organization-full": {
7804
- "value": {
7805
- "login": "github",
7806
- "id": 1,
7807
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
7808
- "url": "https://api.github.com/orgs/github",
7809
- "repos_url": "https://api.github.com/orgs/github/repos",
7810
- "events_url": "https://api.github.com/orgs/github/events",
7811
- "hooks_url": "https://api.github.com/orgs/github/hooks",
7812
- "issues_url": "https://api.github.com/orgs/github/issues",
7813
- "members_url": "https://api.github.com/orgs/github/members{/member}",
7814
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
7815
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
7816
- "description": "A great organization",
7817
- "name": "github",
7818
- "company": "GitHub",
7819
- "blog": "https://github.com/blog",
7820
- "location": "San Francisco",
7821
- "email": "octocat@github.com",
7822
- "twitter_username": "github",
7823
- "is_verified": true,
7824
- "has_organization_projects": true,
7825
- "has_repository_projects": true,
7826
- "public_repos": 2,
7827
- "public_gists": 1,
7828
- "followers": 20,
7829
- "following": 0,
7830
- "html_url": "https://github.com/octocat",
7831
- "created_at": "2008-01-14T04:33:35Z",
7832
- "type": "Organization",
7833
- "total_private_repos": 100,
7834
- "owned_private_repos": 100,
7835
- "private_gists": 81,
7836
- "disk_usage": 10000,
7837
- "collaborators": 8,
7838
- "billing_email": "mona@github.com",
7839
- "plan": { "name": "Medium", "space": 400, "private_repos": 20 },
7840
- "default_repository_permission": "read",
7841
- "members_can_create_repositories": true,
7842
- "two_factor_requirement_enabled": true,
7843
- "members_allowed_repository_creation_type": "all",
7844
- "members_can_create_public_repositories": false,
7845
- "members_can_create_private_repositories": false,
7846
- "members_can_create_internal_repositories": false,
7847
- "members_can_create_pages": true,
7848
- "members_can_create_public_pages": true,
7849
- "members_can_create_private_pages": true,
7850
- "updated_at": "2014-03-03T18:58:10Z"
7851
- }
7852
- },
7853
7179
  "org-pre-receive-hook-items": {
7854
7180
  "value": [
7855
7181
  {
@@ -8312,29 +7638,6 @@
8312
7638
  }
8313
7639
  },
8314
7640
  "not_modified": { "description": "Not modified" },
8315
- "conflict": {
8316
- "description": "Conflict",
8317
- "content": {
8318
- "application/json": {
8319
- "schema": { "$ref": "#/components/schemas/basic-error" }
8320
- }
8321
- }
8322
- },
8323
- "preview_header_missing": {
8324
- "description": "Preview header missing",
8325
- "content": {
8326
- "application/json": {
8327
- "schema": {
8328
- "type": "object",
8329
- "required": ["message", "documentation_url"],
8330
- "properties": {
8331
- "message": { "type": "string" },
8332
- "documentation_url": { "type": "string" }
8333
- }
8334
- }
8335
- }
8336
- }
8337
- },
8338
7641
  "validation_failed": {
8339
7642
  "description": "Validation failed",
8340
7643
  "content": {