@octokit/openapi 5.6.5 → 5.8.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 (27) hide show
  1. package/generated/api.github.com.deref.json +4412 -986
  2. package/generated/api.github.com.json +647 -294
  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 +145 -0
  8. package/generated/ghes-3.0-diff-to-ghes-3.1.deref.json +14577 -3831
  9. package/generated/ghes-3.0-diff-to-ghes-3.1.json +1540 -248
  10. package/generated/ghes-3.0.deref.json +329 -161
  11. package/generated/ghes-3.0.json +280 -102
  12. package/generated/ghes-3.1-anicca-diff-to-ghes-3.2.deref.json +1292 -111
  13. package/generated/ghes-3.1-diff-to-ghes-3.2.deref.json +104093 -56376
  14. package/generated/ghes-3.1-diff-to-ghes-3.2.json +8280 -3015
  15. package/generated/ghes-3.1.deref.json +369 -193
  16. package/generated/ghes-3.1.json +320 -134
  17. package/generated/ghes-3.2-anicca-diff-to-api.github.com.deref.json +305 -1
  18. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +4813 -906
  19. package/generated/ghes-3.2-diff-to-api.github.com.json +2141 -175
  20. package/generated/ghes-3.2.deref.json +390 -204
  21. package/generated/ghes-3.2.json +363 -145
  22. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +59 -0
  23. package/generated/github.ae-diff-to-api.github.com.deref.json +4951 -1
  24. package/generated/github.ae-diff-to-api.github.com.json +2776 -110
  25. package/generated/github.ae.deref.json +3875 -639
  26. package/generated/github.ae.json +425 -235
  27. package/package.json +4 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "5.6.5",
4
+ "version": "5.8.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -2604,6 +2604,41 @@
2604
2604
  "x-octokit": {
2605
2605
  "diff": { "api.github.com.json": { "type": "changed" } }
2606
2606
  }
2607
+ },
2608
+ "put": {
2609
+ "summary": "Set allowed actions for an enterprise",
2610
+ "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.",
2611
+ "operationId": "enterprise-admin/set-allowed-actions-enterprise",
2612
+ "tags": ["enterprise-admin"],
2613
+ "externalDocs": {
2614
+ "description": "API method documentation",
2615
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise"
2616
+ },
2617
+ "parameters": [{ "$ref": "#/components/parameters/enterprise" }],
2618
+ "responses": { "204": { "description": "Response" } },
2619
+ "requestBody": {
2620
+ "required": true,
2621
+ "content": {
2622
+ "application/json": {
2623
+ "schema": { "$ref": "#/components/schemas/selected-actions" },
2624
+ "examples": {
2625
+ "selected_actions": {
2626
+ "$ref": "#/components/examples/selected-actions"
2627
+ }
2628
+ }
2629
+ }
2630
+ }
2631
+ },
2632
+ "x-github": {
2633
+ "enabledForGitHubApps": false,
2634
+ "githubCloudOnly": false,
2635
+ "previews": [],
2636
+ "category": "enterprise-admin",
2637
+ "subcategory": "actions"
2638
+ },
2639
+ "x-octokit": {
2640
+ "diff": { "api.github.com.json": { "type": "changed" } }
2641
+ }
2607
2642
  }
2608
2643
  },
2609
2644
  "/meta": {
@@ -2643,6 +2678,159 @@
2643
2678
  }
2644
2679
  }
2645
2680
  },
2681
+ "/orgs/{org}": {
2682
+ "patch": {
2683
+ "summary": "Update an organization",
2684
+ "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.",
2685
+ "tags": ["orgs"],
2686
+ "operationId": "orgs/update",
2687
+ "externalDocs": {
2688
+ "description": "API method documentation",
2689
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs/#update-an-organization"
2690
+ },
2691
+ "parameters": [{ "$ref": "#/components/parameters/org" }],
2692
+ "requestBody": {
2693
+ "content": {
2694
+ "application/json": {
2695
+ "schema": {
2696
+ "type": "object",
2697
+ "properties": {
2698
+ "billing_email": {
2699
+ "type": "string",
2700
+ "description": "Billing email address. This address is not publicized."
2701
+ },
2702
+ "company": {
2703
+ "type": "string",
2704
+ "description": "The company name."
2705
+ },
2706
+ "email": {
2707
+ "type": "string",
2708
+ "description": "The publicly visible email address."
2709
+ },
2710
+ "twitter_username": {
2711
+ "type": "string",
2712
+ "description": "The Twitter username of the company."
2713
+ },
2714
+ "location": {
2715
+ "type": "string",
2716
+ "description": "The location."
2717
+ },
2718
+ "name": {
2719
+ "type": "string",
2720
+ "description": "The shorthand name of the company."
2721
+ },
2722
+ "description": {
2723
+ "type": "string",
2724
+ "description": "The description of the company."
2725
+ },
2726
+ "has_organization_projects": {
2727
+ "type": "boolean",
2728
+ "description": "Toggles whether an organization can use organization projects."
2729
+ },
2730
+ "has_repository_projects": {
2731
+ "type": "boolean",
2732
+ "description": "Toggles whether repositories that belong to the organization can use repository projects."
2733
+ },
2734
+ "default_repository_permission": {
2735
+ "type": "string",
2736
+ "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.",
2737
+ "enum": ["read", "write", "admin", "none"],
2738
+ "default": "read"
2739
+ },
2740
+ "members_can_create_repositories": {
2741
+ "type": "boolean",
2742
+ "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.",
2743
+ "default": true
2744
+ },
2745
+ "members_can_create_internal_repositories": {
2746
+ "type": "boolean",
2747
+ "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."
2748
+ },
2749
+ "members_can_create_private_repositories": {
2750
+ "type": "boolean",
2751
+ "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."
2752
+ },
2753
+ "members_can_create_public_repositories": {
2754
+ "type": "boolean",
2755
+ "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."
2756
+ },
2757
+ "members_allowed_repository_creation_type": {
2758
+ "type": "string",
2759
+ "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.",
2760
+ "enum": ["all", "private", "none"]
2761
+ },
2762
+ "members_can_create_pages": {
2763
+ "type": "boolean",
2764
+ "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.",
2765
+ "default": true
2766
+ },
2767
+ "blog": {
2768
+ "type": "string",
2769
+ "example": "\"http://github.blog\""
2770
+ }
2771
+ }
2772
+ },
2773
+ "example": {
2774
+ "billing_email": "mona@github.com",
2775
+ "company": "GitHub",
2776
+ "email": "mona@github.com",
2777
+ "twitter_username": "github",
2778
+ "location": "San Francisco",
2779
+ "name": "github",
2780
+ "description": "GitHub, the company.",
2781
+ "default_repository_permission": "read",
2782
+ "members_can_create_repositories": true,
2783
+ "members_allowed_repository_creation_type": "all"
2784
+ }
2785
+ }
2786
+ }
2787
+ },
2788
+ "responses": {
2789
+ "200": {
2790
+ "description": "Response",
2791
+ "content": {
2792
+ "application/json": {
2793
+ "schema": { "$ref": "#/components/schemas/organization-full" },
2794
+ "examples": {
2795
+ "default": {
2796
+ "$ref": "#/components/examples/organization-full"
2797
+ }
2798
+ }
2799
+ }
2800
+ }
2801
+ },
2802
+ "409": { "$ref": "#/components/responses/conflict" },
2803
+ "422": {
2804
+ "description": "Validation failed",
2805
+ "content": {
2806
+ "application/json": {
2807
+ "schema": {
2808
+ "oneOf": [
2809
+ { "$ref": "#/components/schemas/validation-error" },
2810
+ { "$ref": "#/components/schemas/validation-error-simple" }
2811
+ ]
2812
+ }
2813
+ }
2814
+ }
2815
+ }
2816
+ },
2817
+ "x-github": {
2818
+ "githubCloudOnly": false,
2819
+ "enabledForGitHubApps": true,
2820
+ "category": "orgs",
2821
+ "previews": [
2822
+ {
2823
+ "required": false,
2824
+ "name": "surtur",
2825
+ "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```"
2826
+ }
2827
+ ]
2828
+ },
2829
+ "x-octokit": {
2830
+ "diff": { "api.github.com.json": { "type": "changed" } }
2831
+ }
2832
+ }
2833
+ },
2646
2834
  "/orgs/{org}/actions/permissions/selected-actions": {
2647
2835
  "get": {
2648
2836
  "summary": "Get allowed actions for an organization",
@@ -2679,6 +2867,40 @@
2679
2867
  "x-octokit": {
2680
2868
  "diff": { "api.github.com.json": { "type": "changed" } }
2681
2869
  }
2870
+ },
2871
+ "put": {
2872
+ "summary": "Set allowed actions for an organization",
2873
+ "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.",
2874
+ "operationId": "actions/set-allowed-actions-organization",
2875
+ "tags": ["actions"],
2876
+ "externalDocs": {
2877
+ "description": "API method documentation",
2878
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-an-organization"
2879
+ },
2880
+ "parameters": [{ "$ref": "#/components/parameters/org" }],
2881
+ "responses": { "204": { "description": "Response" } },
2882
+ "requestBody": {
2883
+ "content": {
2884
+ "application/json": {
2885
+ "schema": { "$ref": "#/components/schemas/selected-actions" },
2886
+ "examples": {
2887
+ "selected_actions": {
2888
+ "$ref": "#/components/examples/selected-actions"
2889
+ }
2890
+ }
2891
+ }
2892
+ }
2893
+ },
2894
+ "x-github": {
2895
+ "enabledForGitHubApps": true,
2896
+ "githubCloudOnly": false,
2897
+ "previews": [],
2898
+ "category": "actions",
2899
+ "subcategory": "permissions"
2900
+ },
2901
+ "x-octokit": {
2902
+ "diff": { "api.github.com.json": { "type": "changed" } }
2903
+ }
2682
2904
  }
2683
2905
  },
2684
2906
  "/orgs/{org}/pre-receive-hooks": {
@@ -2818,58 +3040,433 @@
2818
3040
  }
2819
3041
  }
2820
3042
  }
2821
- }
3043
+ }
3044
+ },
3045
+ "requestBody": {
3046
+ "content": {
3047
+ "application/json": {
3048
+ "schema": {
3049
+ "type": "object",
3050
+ "properties": {
3051
+ "enforcement": {
3052
+ "description": "The state of enforcement for the hook on this repository.",
3053
+ "type": "string"
3054
+ },
3055
+ "allow_downstream_configuration": {
3056
+ "description": "Whether repositories can override enforcement.",
3057
+ "type": "boolean"
3058
+ }
3059
+ }
3060
+ },
3061
+ "example": {
3062
+ "enforcement": "enabled",
3063
+ "allow_downstream_configuration": false
3064
+ }
3065
+ }
3066
+ }
3067
+ },
3068
+ "x-github": {
3069
+ "githubCloudOnly": false,
3070
+ "enabledForGitHubApps": true,
3071
+ "previews": [
3072
+ {
3073
+ "required": true,
3074
+ "name": "eye-scream",
3075
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
3076
+ }
3077
+ ],
3078
+ "category": "enterprise-admin",
3079
+ "subcategory": "org-pre-receive-hooks"
3080
+ },
3081
+ "x-octokit": { "diff": { "api.github.com.json": { "type": "added" } } }
3082
+ },
3083
+ "delete": {
3084
+ "summary": "Remove pre-receive hook enforcement for an organization",
3085
+ "description": "Removes any overrides for this hook at the org level for this org.",
3086
+ "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-org",
3087
+ "tags": ["enterprise-admin"],
3088
+ "externalDocs": {
3089
+ "description": "API method documentation",
3090
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization"
3091
+ },
3092
+ "parameters": [
3093
+ { "$ref": "#/components/parameters/org" },
3094
+ { "$ref": "#/components/parameters/pre-receive-hook-id" }
3095
+ ],
3096
+ "responses": {
3097
+ "200": {
3098
+ "description": "Response",
3099
+ "content": {
3100
+ "application/json": {
3101
+ "schema": {
3102
+ "$ref": "#/components/schemas/org-pre-receive-hook"
3103
+ },
3104
+ "examples": {
3105
+ "default": {
3106
+ "$ref": "#/components/examples/org-pre-receive-hook"
3107
+ }
3108
+ }
3109
+ }
3110
+ }
3111
+ }
3112
+ },
3113
+ "x-github": {
3114
+ "githubCloudOnly": false,
3115
+ "enabledForGitHubApps": true,
3116
+ "previews": [
3117
+ {
3118
+ "required": true,
3119
+ "name": "eye-scream",
3120
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
3121
+ }
3122
+ ],
3123
+ "category": "enterprise-admin",
3124
+ "subcategory": "org-pre-receive-hooks"
3125
+ },
3126
+ "x-octokit": { "diff": { "api.github.com.json": { "type": "added" } } }
3127
+ }
3128
+ },
3129
+ "/repos/{owner}/{repo}/actions/jobs/{job_id}": {
3130
+ "get": {
3131
+ "summary": "Get a job for a workflow run",
3132
+ "description": "Gets a specific job in a workflow run. 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.",
3133
+ "tags": ["actions"],
3134
+ "operationId": "actions/get-job-for-workflow-run",
3135
+ "externalDocs": {
3136
+ "description": "API method documentation",
3137
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-job-for-a-workflow-run"
3138
+ },
3139
+ "parameters": [
3140
+ { "$ref": "#/components/parameters/owner" },
3141
+ { "$ref": "#/components/parameters/repo" },
3142
+ { "$ref": "#/components/parameters/job-id" }
3143
+ ],
3144
+ "responses": {
3145
+ "200": {
3146
+ "description": "Response",
3147
+ "content": {
3148
+ "application/json": {
3149
+ "schema": { "$ref": "#/components/schemas/job" },
3150
+ "examples": {
3151
+ "default": { "$ref": "#/components/examples/job" }
3152
+ }
3153
+ }
3154
+ }
3155
+ }
3156
+ },
3157
+ "x-github": {
3158
+ "githubCloudOnly": false,
3159
+ "enabledForGitHubApps": true,
3160
+ "previews": [],
3161
+ "category": "actions",
3162
+ "subcategory": "workflow-jobs"
3163
+ },
3164
+ "x-octokit": {
3165
+ "diff": { "api.github.com.json": { "type": "changed" } }
3166
+ }
3167
+ }
3168
+ },
3169
+ "/repos/{owner}/{repo}/actions/permissions/selected-actions": {
3170
+ "get": {
3171
+ "summary": "Get allowed actions for a repository",
3172
+ "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository 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\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.",
3173
+ "operationId": "actions/get-allowed-actions-repository",
3174
+ "tags": ["actions"],
3175
+ "externalDocs": {
3176
+ "description": "API method documentation",
3177
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-a-repository"
3178
+ },
3179
+ "parameters": [
3180
+ { "$ref": "#/components/parameters/owner" },
3181
+ { "$ref": "#/components/parameters/repo" }
3182
+ ],
3183
+ "responses": {
3184
+ "200": {
3185
+ "description": "Response",
3186
+ "content": {
3187
+ "application/json": {
3188
+ "schema": { "$ref": "#/components/schemas/selected-actions" },
3189
+ "examples": {
3190
+ "default": {
3191
+ "$ref": "#/components/examples/selected-actions"
3192
+ }
3193
+ }
3194
+ }
3195
+ }
3196
+ }
3197
+ },
3198
+ "x-github": {
3199
+ "enabledForGitHubApps": true,
3200
+ "githubCloudOnly": false,
3201
+ "previews": [],
3202
+ "category": "actions",
3203
+ "subcategory": "permissions"
3204
+ },
3205
+ "x-octokit": {
3206
+ "diff": { "api.github.com.json": { "type": "changed" } }
3207
+ }
3208
+ },
3209
+ "put": {
3210
+ "summary": "Set allowed actions for a repository",
3211
+ "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.",
3212
+ "operationId": "actions/set-allowed-actions-repository",
3213
+ "tags": ["actions"],
3214
+ "externalDocs": {
3215
+ "description": "API method documentation",
3216
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-a-repository"
3217
+ },
3218
+ "parameters": [
3219
+ { "$ref": "#/components/parameters/owner" },
3220
+ { "$ref": "#/components/parameters/repo" }
3221
+ ],
3222
+ "responses": { "204": { "description": "Response" } },
3223
+ "requestBody": {
3224
+ "content": {
3225
+ "application/json": {
3226
+ "schema": { "$ref": "#/components/schemas/selected-actions" },
3227
+ "examples": {
3228
+ "selected_actions": {
3229
+ "$ref": "#/components/examples/selected-actions"
3230
+ }
3231
+ }
3232
+ }
3233
+ }
3234
+ },
3235
+ "x-github": {
3236
+ "enabledForGitHubApps": true,
3237
+ "githubCloudOnly": false,
3238
+ "previews": [],
3239
+ "category": "actions",
3240
+ "subcategory": "permissions"
3241
+ },
3242
+ "x-octokit": {
3243
+ "diff": { "api.github.com.json": { "type": "changed" } }
3244
+ }
3245
+ }
3246
+ },
3247
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
3248
+ "get": {
3249
+ "summary": "List jobs for a workflow run",
3250
+ "description": "Lists jobs for a workflow run. 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. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#parameters).",
3251
+ "tags": ["actions"],
3252
+ "operationId": "actions/list-jobs-for-workflow-run",
3253
+ "externalDocs": {
3254
+ "description": "API method documentation",
3255
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-jobs-for-a-workflow-run"
3256
+ },
3257
+ "parameters": [
3258
+ { "$ref": "#/components/parameters/owner" },
3259
+ { "$ref": "#/components/parameters/repo" },
3260
+ { "$ref": "#/components/parameters/run-id" },
3261
+ {
3262
+ "name": "filter",
3263
+ "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.",
3264
+ "in": "query",
3265
+ "required": false,
3266
+ "schema": {
3267
+ "type": "string",
3268
+ "enum": ["latest", "all"],
3269
+ "default": "latest"
3270
+ }
3271
+ },
3272
+ { "$ref": "#/components/parameters/per-page" },
3273
+ { "$ref": "#/components/parameters/page" }
3274
+ ],
3275
+ "responses": {
3276
+ "200": {
3277
+ "description": "Response",
3278
+ "content": {
3279
+ "application/json": {
3280
+ "schema": {
3281
+ "type": "object",
3282
+ "required": ["total_count", "jobs"],
3283
+ "properties": {
3284
+ "total_count": { "type": "integer" },
3285
+ "jobs": {
3286
+ "type": "array",
3287
+ "items": { "$ref": "#/components/schemas/job" }
3288
+ }
3289
+ }
3290
+ },
3291
+ "examples": {
3292
+ "default": { "$ref": "#/components/examples/job-paginated" }
3293
+ }
3294
+ }
3295
+ },
3296
+ "headers": { "Link": { "$ref": "#/components/headers/link" } }
3297
+ }
3298
+ },
3299
+ "x-github": {
3300
+ "githubCloudOnly": false,
3301
+ "enabledForGitHubApps": true,
3302
+ "previews": [],
3303
+ "category": "actions",
3304
+ "subcategory": "workflow-jobs"
3305
+ },
3306
+ "x-octokit": {
3307
+ "diff": { "api.github.com.json": { "type": "changed" } }
3308
+ }
3309
+ }
3310
+ },
3311
+ "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
3312
+ "get": {
3313
+ "summary": "Get a code scanning alert",
3314
+ "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.",
3315
+ "tags": ["code-scanning"],
3316
+ "operationId": "code-scanning/get-alert",
3317
+ "externalDocs": {
3318
+ "description": "API method documentation",
3319
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#get-a-code-scanning-alert"
3320
+ },
3321
+ "parameters": [
3322
+ { "$ref": "#/components/parameters/owner" },
3323
+ { "$ref": "#/components/parameters/repo" },
3324
+ { "$ref": "#/components/parameters/alert-number" }
3325
+ ],
3326
+ "responses": {
3327
+ "200": {
3328
+ "description": "Response",
3329
+ "content": {
3330
+ "application/json": {
3331
+ "schema": {
3332
+ "$ref": "#/components/schemas/code-scanning-alert"
3333
+ },
3334
+ "examples": {
3335
+ "default": {
3336
+ "$ref": "#/components/examples/code-scanning-alert"
3337
+ }
3338
+ }
3339
+ }
3340
+ }
3341
+ },
3342
+ "403": {
3343
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
3344
+ },
3345
+ "404": { "$ref": "#/components/responses/not_found" },
3346
+ "503": { "$ref": "#/components/responses/service_unavailable" }
3347
+ },
3348
+ "x-github": {
3349
+ "githubCloudOnly": false,
3350
+ "enabledForGitHubApps": true,
3351
+ "previews": [],
3352
+ "category": "code-scanning",
3353
+ "subcategory": null
3354
+ },
3355
+ "x-octokit": {
3356
+ "changes": [
3357
+ {
3358
+ "type": "PARAMETER",
3359
+ "date": "2020-09-17",
3360
+ "parameter": "alert_number",
3361
+ "before": { "name": "alert_id" }
3362
+ }
3363
+ ],
3364
+ "diff": { "api.github.com.json": { "type": "changed" } }
3365
+ }
3366
+ },
3367
+ "patch": {
3368
+ "summary": "Update a code scanning alert",
3369
+ "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.",
3370
+ "operationId": "code-scanning/update-alert",
3371
+ "tags": ["code-scanning"],
3372
+ "externalDocs": {
3373
+ "description": "API method documentation",
3374
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#update-a-code-scanning-alert"
2822
3375
  },
3376
+ "parameters": [
3377
+ { "$ref": "#/components/parameters/owner" },
3378
+ { "$ref": "#/components/parameters/repo" },
3379
+ { "$ref": "#/components/parameters/alert-number" }
3380
+ ],
2823
3381
  "requestBody": {
3382
+ "required": true,
2824
3383
  "content": {
2825
3384
  "application/json": {
2826
3385
  "schema": {
2827
3386
  "type": "object",
2828
3387
  "properties": {
2829
- "enforcement": {
2830
- "description": "The state of enforcement for the hook on this repository.",
2831
- "type": "string"
3388
+ "state": {
3389
+ "$ref": "#/components/schemas/code-scanning-alert-set-state"
2832
3390
  },
2833
- "allow_downstream_configuration": {
2834
- "description": "Whether repositories can override enforcement.",
2835
- "type": "boolean"
3391
+ "dismissed_reason": {
3392
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
2836
3393
  }
2837
- }
3394
+ },
3395
+ "required": ["state"]
2838
3396
  },
2839
3397
  "example": {
2840
- "enforcement": "enabled",
2841
- "allow_downstream_configuration": false
3398
+ "state": "dismissed",
3399
+ "dismissed_reason": "false positive"
2842
3400
  }
2843
3401
  }
2844
3402
  }
2845
3403
  },
3404
+ "responses": {
3405
+ "200": {
3406
+ "description": "Response",
3407
+ "content": {
3408
+ "application/json": {
3409
+ "schema": {
3410
+ "$ref": "#/components/schemas/code-scanning-alert"
3411
+ },
3412
+ "examples": {
3413
+ "default": {
3414
+ "$ref": "#/components/examples/code-scanning-alert-dismissed"
3415
+ }
3416
+ }
3417
+ }
3418
+ }
3419
+ },
3420
+ "403": {
3421
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
3422
+ },
3423
+ "404": { "$ref": "#/components/responses/not_found" },
3424
+ "503": { "$ref": "#/components/responses/service_unavailable" }
3425
+ },
2846
3426
  "x-github": {
2847
- "githubCloudOnly": false,
2848
3427
  "enabledForGitHubApps": true,
2849
- "previews": [
2850
- {
2851
- "required": true,
2852
- "name": "eye-scream",
2853
- "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
2854
- }
2855
- ],
2856
- "category": "enterprise-admin",
2857
- "subcategory": "org-pre-receive-hooks"
3428
+ "githubCloudOnly": false,
3429
+ "previews": [],
3430
+ "category": "code-scanning"
2858
3431
  },
2859
- "x-octokit": { "diff": { "api.github.com.json": { "type": "added" } } }
2860
- },
2861
- "delete": {
2862
- "summary": "Remove pre-receive hook enforcement for an organization",
2863
- "description": "Removes any overrides for this hook at the org level for this org.",
2864
- "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-org",
2865
- "tags": ["enterprise-admin"],
3432
+ "x-octokit": {
3433
+ "diff": { "api.github.com.json": { "type": "changed" } }
3434
+ }
3435
+ }
3436
+ },
3437
+ "/repos/{owner}/{repo}/code-scanning/analyses": {
3438
+ "get": {
3439
+ "summary": "List code scanning analyses for a repository",
3440
+ "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.",
3441
+ "operationId": "code-scanning/list-recent-analyses",
3442
+ "tags": ["code-scanning"],
2866
3443
  "externalDocs": {
2867
3444
  "description": "API method documentation",
2868
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization"
3445
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository"
2869
3446
  },
2870
3447
  "parameters": [
2871
- { "$ref": "#/components/parameters/org" },
2872
- { "$ref": "#/components/parameters/pre-receive-hook-id" }
3448
+ { "$ref": "#/components/parameters/owner" },
3449
+ { "$ref": "#/components/parameters/repo" },
3450
+ { "$ref": "#/components/parameters/tool-name" },
3451
+ { "$ref": "#/components/parameters/tool-guid" },
3452
+ { "$ref": "#/components/parameters/page" },
3453
+ { "$ref": "#/components/parameters/per-page" },
3454
+ {
3455
+ "name": "ref",
3456
+ "in": "query",
3457
+ "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.",
3458
+ "required": false,
3459
+ "schema": { "$ref": "#/components/schemas/code-scanning-ref" }
3460
+ },
3461
+ {
3462
+ "name": "sarif_id",
3463
+ "in": "query",
3464
+ "description": "Filter analyses belonging to the same SARIF upload.",
3465
+ "required": false,
3466
+ "schema": {
3467
+ "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
3468
+ }
3469
+ }
2873
3470
  ],
2874
3471
  "responses": {
2875
3472
  "200": {
@@ -2877,68 +3474,85 @@
2877
3474
  "content": {
2878
3475
  "application/json": {
2879
3476
  "schema": {
2880
- "$ref": "#/components/schemas/org-pre-receive-hook"
3477
+ "type": "array",
3478
+ "items": {
3479
+ "$ref": "#/components/schemas/code-scanning-analysis"
3480
+ }
2881
3481
  },
2882
3482
  "examples": {
2883
3483
  "default": {
2884
- "$ref": "#/components/examples/org-pre-receive-hook"
3484
+ "$ref": "#/components/examples/code-scanning-analysis-items"
2885
3485
  }
2886
3486
  }
2887
3487
  }
2888
3488
  }
2889
- }
3489
+ },
3490
+ "403": {
3491
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
3492
+ },
3493
+ "404": { "$ref": "#/components/responses/not_found" },
3494
+ "503": { "$ref": "#/components/responses/service_unavailable" }
2890
3495
  },
2891
3496
  "x-github": {
2892
- "githubCloudOnly": false,
2893
3497
  "enabledForGitHubApps": true,
2894
- "previews": [
2895
- {
2896
- "required": true,
2897
- "name": "eye-scream",
2898
- "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
2899
- }
2900
- ],
2901
- "category": "enterprise-admin",
2902
- "subcategory": "org-pre-receive-hooks"
3498
+ "githubCloudOnly": false,
3499
+ "previews": [],
3500
+ "category": "code-scanning"
2903
3501
  },
2904
- "x-octokit": { "diff": { "api.github.com.json": { "type": "added" } } }
3502
+ "x-octokit": {
3503
+ "diff": { "api.github.com.json": { "type": "changed" } }
3504
+ }
2905
3505
  }
2906
3506
  },
2907
- "/repos/{owner}/{repo}/actions/permissions/selected-actions": {
3507
+ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
2908
3508
  "get": {
2909
- "summary": "Get allowed actions for a repository",
2910
- "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository 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\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.",
2911
- "operationId": "actions/get-allowed-actions-repository",
2912
- "tags": ["actions"],
3509
+ "summary": "Get a code scanning analysis for a repository",
3510
+ "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.",
3511
+ "operationId": "code-scanning/get-analysis",
3512
+ "tags": ["code-scanning"],
2913
3513
  "externalDocs": {
2914
3514
  "description": "API method documentation",
2915
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-a-repository"
3515
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository"
2916
3516
  },
2917
3517
  "parameters": [
2918
3518
  { "$ref": "#/components/parameters/owner" },
2919
- { "$ref": "#/components/parameters/repo" }
3519
+ { "$ref": "#/components/parameters/repo" },
3520
+ {
3521
+ "name": "analysis_id",
3522
+ "in": "path",
3523
+ "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
3524
+ "required": true,
3525
+ "schema": { "type": "integer" }
3526
+ }
2920
3527
  ],
2921
3528
  "responses": {
2922
3529
  "200": {
2923
3530
  "description": "Response",
2924
3531
  "content": {
3532
+ "application/json+sarif": { "schema": { "type": "string" } },
2925
3533
  "application/json": {
2926
- "schema": { "$ref": "#/components/schemas/selected-actions" },
3534
+ "schema": {
3535
+ "$ref": "#/components/schemas/code-scanning-analysis"
3536
+ },
2927
3537
  "examples": {
2928
- "default": {
2929
- "$ref": "#/components/examples/selected-actions"
3538
+ "response": {
3539
+ "$ref": "#/components/examples/code-scanning-analysis-default"
2930
3540
  }
2931
3541
  }
2932
3542
  }
2933
3543
  }
2934
- }
3544
+ },
3545
+ "403": {
3546
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
3547
+ },
3548
+ "404": { "$ref": "#/components/responses/not_found" },
3549
+ "503": { "$ref": "#/components/responses/service_unavailable" }
2935
3550
  },
2936
3551
  "x-github": {
2937
3552
  "enabledForGitHubApps": true,
2938
3553
  "githubCloudOnly": false,
2939
3554
  "previews": [],
2940
- "category": "actions",
2941
- "subcategory": "permissions"
3555
+ "category": "code-scanning"
2942
3556
  },
2943
3557
  "x-octokit": {
2944
3558
  "diff": { "api.github.com.json": { "type": "changed" } }
@@ -3209,6 +3823,98 @@
3209
3823
  "x-octokit": {
3210
3824
  "diff": { "api.github.com.json": { "type": "changed" } }
3211
3825
  }
3826
+ },
3827
+ "post": {
3828
+ "summary": "Create a release",
3829
+ "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.",
3830
+ "tags": ["repos"],
3831
+ "operationId": "repos/create-release",
3832
+ "externalDocs": {
3833
+ "description": "API method documentation",
3834
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-release"
3835
+ },
3836
+ "parameters": [
3837
+ { "$ref": "#/components/parameters/owner" },
3838
+ { "$ref": "#/components/parameters/repo" }
3839
+ ],
3840
+ "requestBody": {
3841
+ "required": true,
3842
+ "content": {
3843
+ "application/json": {
3844
+ "schema": {
3845
+ "type": "object",
3846
+ "properties": {
3847
+ "tag_name": {
3848
+ "type": "string",
3849
+ "description": "The name of the tag."
3850
+ },
3851
+ "target_commitish": {
3852
+ "type": "string",
3853
+ "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`)."
3854
+ },
3855
+ "name": {
3856
+ "type": "string",
3857
+ "description": "The name of the release."
3858
+ },
3859
+ "body": {
3860
+ "type": "string",
3861
+ "description": "Text describing the contents of the tag."
3862
+ },
3863
+ "draft": {
3864
+ "type": "boolean",
3865
+ "description": "`true` to create a draft (unpublished) release, `false` to create a published one.",
3866
+ "default": false
3867
+ },
3868
+ "prerelease": {
3869
+ "type": "boolean",
3870
+ "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
3871
+ "default": false
3872
+ }
3873
+ },
3874
+ "required": ["tag_name"]
3875
+ },
3876
+ "example": {
3877
+ "tag_name": "v1.0.0",
3878
+ "target_commitish": "master",
3879
+ "name": "v1.0.0",
3880
+ "body": "Description of the release",
3881
+ "draft": false,
3882
+ "prerelease": false
3883
+ }
3884
+ }
3885
+ }
3886
+ },
3887
+ "responses": {
3888
+ "201": {
3889
+ "description": "Response",
3890
+ "content": {
3891
+ "application/json": {
3892
+ "schema": { "$ref": "#/components/schemas/release" },
3893
+ "examples": {
3894
+ "default": { "$ref": "#/components/examples/release" }
3895
+ }
3896
+ }
3897
+ },
3898
+ "headers": {
3899
+ "Location": {
3900
+ "example": "https://api.github.com/repos/octocat/Hello-World/releases/1",
3901
+ "schema": { "type": "string" }
3902
+ }
3903
+ }
3904
+ },
3905
+ "422": { "$ref": "#/components/responses/validation_failed" }
3906
+ },
3907
+ "x-github": {
3908
+ "triggersNotification": true,
3909
+ "githubCloudOnly": false,
3910
+ "enabledForGitHubApps": true,
3911
+ "previews": [],
3912
+ "category": "repos",
3913
+ "subcategory": "releases"
3914
+ },
3915
+ "x-octokit": {
3916
+ "diff": { "api.github.com.json": { "type": "changed" } }
3917
+ }
3212
3918
  }
3213
3919
  },
3214
3920
  "/repos/{owner}/{repo}/releases/latest": {
@@ -3337,6 +4043,87 @@
3337
4043
  "x-octokit": {
3338
4044
  "diff": { "api.github.com.json": { "type": "changed" } }
3339
4045
  }
4046
+ },
4047
+ "patch": {
4048
+ "summary": "Update a release",
4049
+ "description": "Users with push access to the repository can edit a release.",
4050
+ "tags": ["repos"],
4051
+ "operationId": "repos/update-release",
4052
+ "externalDocs": {
4053
+ "description": "API method documentation",
4054
+ "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-a-release"
4055
+ },
4056
+ "parameters": [
4057
+ { "$ref": "#/components/parameters/owner" },
4058
+ { "$ref": "#/components/parameters/repo" },
4059
+ { "$ref": "#/components/parameters/release-id" }
4060
+ ],
4061
+ "requestBody": {
4062
+ "content": {
4063
+ "application/json": {
4064
+ "schema": {
4065
+ "type": "object",
4066
+ "properties": {
4067
+ "tag_name": {
4068
+ "type": "string",
4069
+ "description": "The name of the tag."
4070
+ },
4071
+ "target_commitish": {
4072
+ "type": "string",
4073
+ "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`)."
4074
+ },
4075
+ "name": {
4076
+ "type": "string",
4077
+ "description": "The name of the release."
4078
+ },
4079
+ "body": {
4080
+ "type": "string",
4081
+ "description": "Text describing the contents of the tag."
4082
+ },
4083
+ "draft": {
4084
+ "type": "boolean",
4085
+ "description": "`true` makes the release a draft, and `false` publishes the release."
4086
+ },
4087
+ "prerelease": {
4088
+ "type": "boolean",
4089
+ "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release."
4090
+ }
4091
+ }
4092
+ },
4093
+ "example": {
4094
+ "tag_name": "v1.0.0",
4095
+ "target_commitish": "master",
4096
+ "name": "v1.0.0",
4097
+ "body": "Description of the release",
4098
+ "draft": false,
4099
+ "prerelease": false
4100
+ }
4101
+ }
4102
+ }
4103
+ },
4104
+ "responses": {
4105
+ "200": {
4106
+ "description": "Response",
4107
+ "content": {
4108
+ "application/json": {
4109
+ "schema": { "$ref": "#/components/schemas/release" },
4110
+ "examples": {
4111
+ "default": { "$ref": "#/components/examples/release" }
4112
+ }
4113
+ }
4114
+ }
4115
+ }
4116
+ },
4117
+ "x-github": {
4118
+ "githubCloudOnly": false,
4119
+ "enabledForGitHubApps": true,
4120
+ "previews": [],
4121
+ "category": "repos",
4122
+ "subcategory": "releases"
4123
+ },
4124
+ "x-octokit": {
4125
+ "diff": { "api.github.com.json": { "type": "changed" } }
4126
+ }
3340
4127
  }
3341
4128
  },
3342
4129
  "/repositories": {
@@ -4073,6 +4860,45 @@
4073
4860
  "required": true,
4074
4861
  "schema": { "type": "string" }
4075
4862
  },
4863
+ "job-id": {
4864
+ "name": "job_id",
4865
+ "description": "job_id parameter",
4866
+ "in": "path",
4867
+ "required": true,
4868
+ "schema": { "type": "integer" }
4869
+ },
4870
+ "run-id": {
4871
+ "name": "run_id",
4872
+ "description": "The id of the workflow run.",
4873
+ "in": "path",
4874
+ "required": true,
4875
+ "schema": { "type": "integer" }
4876
+ },
4877
+ "alert-number": {
4878
+ "name": "alert_number",
4879
+ "in": "path",
4880
+ "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.",
4881
+ "required": true,
4882
+ "schema": { "$ref": "#/components/schemas/alert-number" }
4883
+ },
4884
+ "tool-name": {
4885
+ "name": "tool_name",
4886
+ "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
4887
+ "in": "query",
4888
+ "required": false,
4889
+ "schema": {
4890
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-name"
4891
+ }
4892
+ },
4893
+ "tool-guid": {
4894
+ "name": "tool_guid",
4895
+ "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
4896
+ "in": "query",
4897
+ "required": false,
4898
+ "schema": {
4899
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
4900
+ }
4901
+ },
4076
4902
  "release-id": {
4077
4903
  "name": "release_id",
4078
4904
  "description": "release_id parameter",
@@ -4888,67 +5714,561 @@
4888
5714
  "total_wikis"
4889
5715
  ]
4890
5716
  },
4891
- "enterprise-user-overview": {
4892
- "title": "Enterprise User Stats",
5717
+ "enterprise-user-overview": {
5718
+ "title": "Enterprise User Stats",
5719
+ "type": "object",
5720
+ "properties": {
5721
+ "total_users": { "type": "integer" },
5722
+ "admin_users": { "type": "integer" },
5723
+ "suspended_users": { "type": "integer" }
5724
+ },
5725
+ "required": ["total_users", "admin_users", "suspended_users"]
5726
+ },
5727
+ "selected-actions": {
5728
+ "type": "object",
5729
+ "properties": {
5730
+ "github_owned_allowed": {
5731
+ "type": "boolean",
5732
+ "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
5733
+ },
5734
+ "patterns_allowed": {
5735
+ "type": "array",
5736
+ "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
5737
+ "items": { "type": "string" }
5738
+ }
5739
+ },
5740
+ "required": ["github_owned_allowed", "patterns_allowed"]
5741
+ },
5742
+ "api-overview": {
5743
+ "title": "Api Overview",
5744
+ "description": "Api Overview",
5745
+ "type": "object",
5746
+ "properties": {
5747
+ "verifiable_password_authentication": {
5748
+ "type": "boolean",
5749
+ "example": true
5750
+ },
5751
+ "packages": {
5752
+ "type": "array",
5753
+ "items": { "type": "string" },
5754
+ "example": [
5755
+ "13.65.0.0/16",
5756
+ "157.55.204.33/32",
5757
+ "2a01:111:f403:f90c::/62"
5758
+ ]
5759
+ },
5760
+ "dependabot": {
5761
+ "type": "array",
5762
+ "items": { "type": "string" },
5763
+ "example": ["192.168.7.15/32", "192.168.7.16/32"]
5764
+ },
5765
+ "installed_version": { "type": "string", "example": "3.2.0" }
5766
+ },
5767
+ "required": ["verifiable_password_authentication"]
5768
+ },
5769
+ "organization-full": {
5770
+ "title": "Organization Full",
5771
+ "description": "Organization Full",
5772
+ "type": "object",
5773
+ "properties": {
5774
+ "login": { "type": "string", "example": "github" },
5775
+ "id": { "type": "integer", "example": 1 },
5776
+ "node_id": {
5777
+ "type": "string",
5778
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
5779
+ },
5780
+ "url": {
5781
+ "type": "string",
5782
+ "format": "uri",
5783
+ "example": "https://api.github.com/orgs/github"
5784
+ },
5785
+ "repos_url": {
5786
+ "type": "string",
5787
+ "format": "uri",
5788
+ "example": "https://api.github.com/orgs/github/repos"
5789
+ },
5790
+ "events_url": {
5791
+ "type": "string",
5792
+ "format": "uri",
5793
+ "example": "https://api.github.com/orgs/github/events"
5794
+ },
5795
+ "hooks_url": {
5796
+ "type": "string",
5797
+ "example": "https://api.github.com/orgs/github/hooks"
5798
+ },
5799
+ "issues_url": {
5800
+ "type": "string",
5801
+ "example": "https://api.github.com/orgs/github/issues"
5802
+ },
5803
+ "members_url": {
5804
+ "type": "string",
5805
+ "example": "https://api.github.com/orgs/github/members{/member}"
5806
+ },
5807
+ "public_members_url": {
5808
+ "type": "string",
5809
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
5810
+ },
5811
+ "avatar_url": {
5812
+ "type": "string",
5813
+ "example": "https://github.com/images/error/octocat_happy.gif"
5814
+ },
5815
+ "description": {
5816
+ "type": "string",
5817
+ "example": "A great organization",
5818
+ "nullable": true
5819
+ },
5820
+ "name": { "type": "string", "example": "github" },
5821
+ "company": { "type": "string", "example": "GitHub" },
5822
+ "blog": {
5823
+ "type": "string",
5824
+ "format": "uri",
5825
+ "example": "https://github.com/blog"
5826
+ },
5827
+ "location": { "type": "string", "example": "San Francisco" },
5828
+ "email": {
5829
+ "type": "string",
5830
+ "format": "email",
5831
+ "example": "octocat@github.com"
5832
+ },
5833
+ "twitter_username": {
5834
+ "type": "string",
5835
+ "example": "github",
5836
+ "nullable": true
5837
+ },
5838
+ "is_verified": { "type": "boolean", "example": true },
5839
+ "has_organization_projects": { "type": "boolean", "example": true },
5840
+ "has_repository_projects": { "type": "boolean", "example": true },
5841
+ "public_repos": { "type": "integer", "example": 2 },
5842
+ "public_gists": { "type": "integer", "example": 1 },
5843
+ "followers": { "type": "integer", "example": 20 },
5844
+ "following": { "type": "integer", "example": 0 },
5845
+ "html_url": {
5846
+ "type": "string",
5847
+ "format": "uri",
5848
+ "example": "https://github.com/octocat"
5849
+ },
5850
+ "created_at": {
5851
+ "type": "string",
5852
+ "format": "date-time",
5853
+ "example": "2008-01-14T04:33:35Z"
5854
+ },
5855
+ "type": { "type": "string", "example": "Organization" },
5856
+ "total_private_repos": { "type": "integer", "example": 100 },
5857
+ "owned_private_repos": { "type": "integer", "example": 100 },
5858
+ "private_gists": {
5859
+ "type": "integer",
5860
+ "example": 81,
5861
+ "nullable": true
5862
+ },
5863
+ "disk_usage": {
5864
+ "type": "integer",
5865
+ "example": 10000,
5866
+ "nullable": true
5867
+ },
5868
+ "collaborators": {
5869
+ "type": "integer",
5870
+ "example": 8,
5871
+ "nullable": true
5872
+ },
5873
+ "billing_email": {
5874
+ "type": "string",
5875
+ "format": "email",
5876
+ "example": "org@example.com",
5877
+ "nullable": true
5878
+ },
5879
+ "plan": {
5880
+ "type": "object",
5881
+ "properties": {
5882
+ "name": { "type": "string" },
5883
+ "space": { "type": "integer" },
5884
+ "private_repos": { "type": "integer" },
5885
+ "filled_seats": { "type": "integer" },
5886
+ "seats": { "type": "integer" }
5887
+ },
5888
+ "required": ["name", "space", "private_repos"]
5889
+ },
5890
+ "default_repository_permission": {
5891
+ "type": "string",
5892
+ "nullable": true
5893
+ },
5894
+ "members_can_create_repositories": {
5895
+ "type": "boolean",
5896
+ "example": true,
5897
+ "nullable": true
5898
+ },
5899
+ "two_factor_requirement_enabled": {
5900
+ "type": "boolean",
5901
+ "example": true,
5902
+ "nullable": true
5903
+ },
5904
+ "members_allowed_repository_creation_type": {
5905
+ "type": "string",
5906
+ "example": "all"
5907
+ },
5908
+ "members_can_create_public_repositories": {
5909
+ "type": "boolean",
5910
+ "example": true
5911
+ },
5912
+ "members_can_create_private_repositories": {
5913
+ "type": "boolean",
5914
+ "example": true
5915
+ },
5916
+ "members_can_create_internal_repositories": {
5917
+ "type": "boolean",
5918
+ "example": true
5919
+ },
5920
+ "members_can_create_pages": { "type": "boolean", "example": true },
5921
+ "members_can_create_public_pages": {
5922
+ "type": "boolean",
5923
+ "example": true
5924
+ },
5925
+ "members_can_create_private_pages": {
5926
+ "type": "boolean",
5927
+ "example": true
5928
+ },
5929
+ "updated_at": { "type": "string", "format": "date-time" }
5930
+ },
5931
+ "required": [
5932
+ "login",
5933
+ "url",
5934
+ "id",
5935
+ "node_id",
5936
+ "repos_url",
5937
+ "events_url",
5938
+ "hooks_url",
5939
+ "issues_url",
5940
+ "members_url",
5941
+ "public_members_url",
5942
+ "avatar_url",
5943
+ "description",
5944
+ "html_url",
5945
+ "has_organization_projects",
5946
+ "has_repository_projects",
5947
+ "public_repos",
5948
+ "public_gists",
5949
+ "followers",
5950
+ "following",
5951
+ "type",
5952
+ "created_at",
5953
+ "updated_at"
5954
+ ]
5955
+ },
5956
+ "validation-error": {
5957
+ "title": "Validation Error",
5958
+ "description": "Validation Error",
5959
+ "type": "object",
5960
+ "required": ["message", "documentation_url"],
5961
+ "properties": {
5962
+ "message": { "type": "string" },
5963
+ "documentation_url": { "type": "string" },
5964
+ "errors": {
5965
+ "type": "array",
5966
+ "items": {
5967
+ "type": "object",
5968
+ "required": ["code"],
5969
+ "properties": {
5970
+ "resource": { "type": "string" },
5971
+ "field": { "type": "string" },
5972
+ "message": { "type": "string" },
5973
+ "code": { "type": "string" },
5974
+ "index": { "type": "integer" },
5975
+ "value": {
5976
+ "oneOf": [
5977
+ { "type": "string", "nullable": true },
5978
+ { "type": "integer", "nullable": true },
5979
+ {
5980
+ "type": "array",
5981
+ "nullable": true,
5982
+ "items": { "type": "string" }
5983
+ }
5984
+ ]
5985
+ }
5986
+ }
5987
+ }
5988
+ }
5989
+ }
5990
+ },
5991
+ "validation-error-simple": {
5992
+ "title": "Validation Error Simple",
5993
+ "description": "Validation Error Simple",
5994
+ "type": "object",
5995
+ "required": ["message", "documentation_url"],
5996
+ "properties": {
5997
+ "message": { "type": "string" },
5998
+ "documentation_url": { "type": "string" },
5999
+ "errors": { "type": "array", "items": { "type": "string" } }
6000
+ }
6001
+ },
6002
+ "org-pre-receive-hook": {
4893
6003
  "type": "object",
4894
6004
  "properties": {
4895
- "total_users": { "type": "integer" },
4896
- "admin_users": { "type": "integer" },
4897
- "suspended_users": { "type": "integer" }
4898
- },
4899
- "required": ["total_users", "admin_users", "suspended_users"]
6005
+ "id": { "type": "integer" },
6006
+ "name": { "type": "string" },
6007
+ "enforcement": { "type": "string" },
6008
+ "configuration_url": { "type": "string" },
6009
+ "allow_downstream_configuration": { "type": "boolean" }
6010
+ }
4900
6011
  },
4901
- "selected-actions": {
6012
+ "job": {
6013
+ "title": "Job",
6014
+ "description": "Information of a job execution in a workflow run",
4902
6015
  "type": "object",
4903
6016
  "properties": {
4904
- "github_owned_allowed": {
4905
- "type": "boolean",
4906
- "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
6017
+ "id": {
6018
+ "description": "The id of the job.",
6019
+ "example": 21,
6020
+ "type": "integer"
4907
6021
  },
4908
- "patterns_allowed": {
6022
+ "run_id": {
6023
+ "description": "The id of the associated workflow run.",
6024
+ "example": 5,
6025
+ "type": "integer"
6026
+ },
6027
+ "run_url": {
6028
+ "type": "string",
6029
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
6030
+ },
6031
+ "run_attempt": {
6032
+ "type": "integer",
6033
+ "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
6034
+ "example": 1
6035
+ },
6036
+ "node_id": { "type": "string", "example": "MDg6Q2hlY2tSdW40" },
6037
+ "head_sha": {
6038
+ "description": "The SHA of the commit that is being run.",
6039
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
6040
+ "type": "string"
6041
+ },
6042
+ "url": {
6043
+ "type": "string",
6044
+ "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21"
6045
+ },
6046
+ "html_url": {
6047
+ "type": "string",
6048
+ "example": "https://github.com/github/hello-world/runs/4",
6049
+ "nullable": true
6050
+ },
6051
+ "status": {
6052
+ "description": "The phase of the lifecycle that the job is currently in.",
6053
+ "example": "queued",
6054
+ "type": "string",
6055
+ "enum": ["queued", "in_progress", "completed"]
6056
+ },
6057
+ "conclusion": {
6058
+ "description": "The outcome of the job.",
6059
+ "example": "success",
6060
+ "type": "string",
6061
+ "nullable": true
6062
+ },
6063
+ "started_at": {
6064
+ "description": "The time that the job started, in ISO 8601 format.",
6065
+ "example": "2019-08-08T08:00:00-07:00",
6066
+ "format": "date-time",
6067
+ "type": "string"
6068
+ },
6069
+ "completed_at": {
6070
+ "description": "The time that the job finished, in ISO 8601 format.",
6071
+ "example": "2019-08-08T08:00:00-07:00",
6072
+ "format": "date-time",
6073
+ "type": "string",
6074
+ "nullable": true
6075
+ },
6076
+ "name": {
6077
+ "description": "The name of the job.",
6078
+ "example": "test-coverage",
6079
+ "type": "string"
6080
+ },
6081
+ "steps": {
6082
+ "description": "Steps in this job.",
4909
6083
  "type": "array",
4910
- "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
4911
- "items": { "type": "string" }
6084
+ "items": {
6085
+ "type": "object",
6086
+ "required": ["name", "status", "conclusion", "number"],
6087
+ "properties": {
6088
+ "status": {
6089
+ "description": "The phase of the lifecycle that the job is currently in.",
6090
+ "example": "queued",
6091
+ "type": "string",
6092
+ "enum": ["queued", "in_progress", "completed"]
6093
+ },
6094
+ "conclusion": {
6095
+ "description": "The outcome of the job.",
6096
+ "example": "success",
6097
+ "type": "string",
6098
+ "nullable": true
6099
+ },
6100
+ "name": {
6101
+ "description": "The name of the job.",
6102
+ "example": "test-coverage",
6103
+ "type": "string"
6104
+ },
6105
+ "number": { "type": "integer", "example": 1 },
6106
+ "started_at": {
6107
+ "description": "The time that the step started, in ISO 8601 format.",
6108
+ "example": "2019-08-08T08:00:00-07:00",
6109
+ "format": "date-time",
6110
+ "type": "string",
6111
+ "nullable": true
6112
+ },
6113
+ "completed_at": {
6114
+ "description": "The time that the job finished, in ISO 8601 format.",
6115
+ "example": "2019-08-08T08:00:00-07:00",
6116
+ "format": "date-time",
6117
+ "type": "string",
6118
+ "nullable": true
6119
+ }
6120
+ }
6121
+ }
6122
+ },
6123
+ "check_run_url": {
6124
+ "type": "string",
6125
+ "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
4912
6126
  }
4913
6127
  },
4914
- "required": ["github_owned_allowed", "patterns_allowed"]
6128
+ "required": [
6129
+ "id",
6130
+ "node_id",
6131
+ "run_id",
6132
+ "run_url",
6133
+ "head_sha",
6134
+ "name",
6135
+ "url",
6136
+ "html_url",
6137
+ "status",
6138
+ "conclusion",
6139
+ "started_at",
6140
+ "completed_at",
6141
+ "check_run_url"
6142
+ ]
4915
6143
  },
4916
- "api-overview": {
4917
- "title": "Api Overview",
4918
- "description": "Api Overview",
6144
+ "code-scanning-alert": {
4919
6145
  "type": "object",
4920
6146
  "properties": {
4921
- "verifiable_password_authentication": {
4922
- "type": "boolean",
4923
- "example": true
6147
+ "number": { "$ref": "#/components/schemas/alert-number" },
6148
+ "created_at": { "$ref": "#/components/schemas/alert-created-at" },
6149
+ "url": { "$ref": "#/components/schemas/alert-url" },
6150
+ "html_url": { "$ref": "#/components/schemas/alert-html-url" },
6151
+ "instances_url": {
6152
+ "$ref": "#/components/schemas/alert-instances-url"
6153
+ },
6154
+ "state": { "$ref": "#/components/schemas/code-scanning-alert-state" },
6155
+ "dismissed_by": {
6156
+ "$ref": "#/components/schemas/nullable-simple-user"
4924
6157
  },
4925
- "packages": {
4926
- "type": "array",
4927
- "items": { "type": "string" },
4928
- "example": [
4929
- "13.65.0.0/16",
4930
- "157.55.204.33/32",
4931
- "2a01:111:f403:f90c::/62"
4932
- ]
6158
+ "dismissed_at": {
6159
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-at"
4933
6160
  },
4934
- "dependabot": {
4935
- "type": "array",
4936
- "items": { "type": "string" },
4937
- "example": ["192.168.7.15/32", "192.168.7.16/32"]
6161
+ "dismissed_reason": {
6162
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
4938
6163
  },
4939
- "installed_version": { "type": "string", "example": "3.2.0" }
6164
+ "rule": { "$ref": "#/components/schemas/code-scanning-alert-rule" },
6165
+ "tool": {
6166
+ "$ref": "#/components/schemas/code-scanning-analysis-tool"
6167
+ },
6168
+ "most_recent_instance": {
6169
+ "$ref": "#/components/schemas/code-scanning-alert-instance"
6170
+ },
6171
+ "instances": { "deprecated": true }
4940
6172
  },
4941
- "required": ["verifiable_password_authentication"]
6173
+ "required": [
6174
+ "number",
6175
+ "created_at",
6176
+ "url",
6177
+ "html_url",
6178
+ "instances_url",
6179
+ "state",
6180
+ "dismissed_by",
6181
+ "dismissed_at",
6182
+ "dismissed_reason",
6183
+ "rule",
6184
+ "tool",
6185
+ "most_recent_instance"
6186
+ ]
4942
6187
  },
4943
- "org-pre-receive-hook": {
6188
+ "code-scanning-alert-set-state": {
6189
+ "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.",
6190
+ "type": "string",
6191
+ "enum": ["open", "dismissed"]
6192
+ },
6193
+ "code-scanning-alert-dismissed-reason": {
6194
+ "type": "string",
6195
+ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
6196
+ "nullable": true,
6197
+ "enum": [null, "false positive", "won't fix", "used in tests"]
6198
+ },
6199
+ "code-scanning-ref": {
6200
+ "type": "string",
6201
+ "description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
6202
+ },
6203
+ "code-scanning-analysis-sarif-id": {
6204
+ "type": "string",
6205
+ "description": "An identifier for the upload.",
6206
+ "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
6207
+ "nullable": false
6208
+ },
6209
+ "code-scanning-analysis": {
4944
6210
  "type": "object",
4945
6211
  "properties": {
4946
- "id": { "type": "integer" },
4947
- "name": { "type": "string" },
4948
- "enforcement": { "type": "string" },
4949
- "configuration_url": { "type": "string" },
4950
- "allow_downstream_configuration": { "type": "boolean" }
4951
- }
6212
+ "ref": { "$ref": "#/components/schemas/code-scanning-ref" },
6213
+ "commit_sha": {
6214
+ "$ref": "#/components/schemas/code-scanning-analysis-commit-sha"
6215
+ },
6216
+ "analysis_key": {
6217
+ "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
6218
+ },
6219
+ "environment": {
6220
+ "$ref": "#/components/schemas/code-scanning-analysis-environment"
6221
+ },
6222
+ "category": {
6223
+ "$ref": "#/components/schemas/code-scanning-analysis-category"
6224
+ },
6225
+ "error": { "type": "string", "example": "error reading field xyz" },
6226
+ "created_at": {
6227
+ "$ref": "#/components/schemas/code-scanning-analysis-created-at"
6228
+ },
6229
+ "results_count": {
6230
+ "type": "integer",
6231
+ "description": "The total number of results in the analysis."
6232
+ },
6233
+ "rules_count": {
6234
+ "type": "integer",
6235
+ "description": "The total number of rules used in the analysis."
6236
+ },
6237
+ "id": {
6238
+ "type": "integer",
6239
+ "description": "Unique identifier for this analysis."
6240
+ },
6241
+ "url": { "$ref": "#/components/schemas/code-scanning-analysis-url" },
6242
+ "sarif_id": {
6243
+ "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
6244
+ },
6245
+ "tool": {
6246
+ "$ref": "#/components/schemas/code-scanning-analysis-tool"
6247
+ },
6248
+ "deletable": { "type": "boolean" },
6249
+ "warning": {
6250
+ "type": "string",
6251
+ "description": "Warning generated when processing the analysis",
6252
+ "example": "123 results were ignored"
6253
+ },
6254
+ "tool_name": { "type": "string" }
6255
+ },
6256
+ "required": [
6257
+ "ref",
6258
+ "commit_sha",
6259
+ "analysis_key",
6260
+ "environment",
6261
+ "error",
6262
+ "created_at",
6263
+ "results_count",
6264
+ "rules_count",
6265
+ "id",
6266
+ "url",
6267
+ "sarif_id",
6268
+ "tool",
6269
+ "deletable",
6270
+ "warning"
6271
+ ]
4952
6272
  },
4953
6273
  "repository-pre-receive-hook": {
4954
6274
  "type": "object",
@@ -5854,61 +7174,266 @@
5854
7174
  "description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
5855
7175
  "enum": ["read", "write", "admin"]
5856
7176
  },
5857
- "organization_packages": {
5858
- "type": "string",
5859
- "description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.",
5860
- "enum": ["read", "write"]
7177
+ "organization_packages": {
7178
+ "type": "string",
7179
+ "description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.",
7180
+ "enum": ["read", "write"]
7181
+ },
7182
+ "organization_secrets": {
7183
+ "type": "string",
7184
+ "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
7185
+ "enum": ["read", "write"]
7186
+ },
7187
+ "organization_self_hosted_runners": {
7188
+ "type": "string",
7189
+ "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.",
7190
+ "enum": ["read", "write"]
7191
+ },
7192
+ "organization_user_blocking": {
7193
+ "type": "string",
7194
+ "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.",
7195
+ "enum": ["read", "write"]
7196
+ },
7197
+ "team_discussions": {
7198
+ "type": "string",
7199
+ "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
7200
+ "enum": ["read", "write"]
7201
+ }
7202
+ },
7203
+ "example": {
7204
+ "contents": "read",
7205
+ "issues": "read",
7206
+ "deployments": "write",
7207
+ "single_file": "read"
7208
+ }
7209
+ },
7210
+ "basic-error": {
7211
+ "title": "Basic Error",
7212
+ "description": "Basic Error",
7213
+ "type": "object",
7214
+ "properties": {
7215
+ "message": { "type": "string" },
7216
+ "documentation_url": { "type": "string" },
7217
+ "url": { "type": "string" },
7218
+ "status": { "type": "string" }
7219
+ }
7220
+ },
7221
+ "announcement-message": {
7222
+ "type": "string",
7223
+ "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
7224
+ "example": "Very **important** announcement about _nothing_."
7225
+ },
7226
+ "announcement-expiration": {
7227
+ "type": "string",
7228
+ "format": "date-time",
7229
+ "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.",
7230
+ "example": "\"2021-01-01T00:00:00.000-07:00\"",
7231
+ "nullable": true
7232
+ },
7233
+ "alert-number": {
7234
+ "type": "integer",
7235
+ "description": "The security alert number.",
7236
+ "readOnly": true,
7237
+ "nullable": false
7238
+ },
7239
+ "alert-created-at": {
7240
+ "type": "string",
7241
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
7242
+ "format": "date-time",
7243
+ "readOnly": true,
7244
+ "nullable": false
7245
+ },
7246
+ "alert-url": {
7247
+ "type": "string",
7248
+ "description": "The REST API URL of the alert resource.",
7249
+ "format": "uri",
7250
+ "readOnly": true,
7251
+ "nullable": false
7252
+ },
7253
+ "alert-html-url": {
7254
+ "type": "string",
7255
+ "description": "The GitHub URL of the alert resource.",
7256
+ "format": "uri",
7257
+ "readOnly": true,
7258
+ "nullable": false
7259
+ },
7260
+ "alert-instances-url": {
7261
+ "type": "string",
7262
+ "description": "The REST API URL for fetching the list of instances for an alert.",
7263
+ "format": "uri",
7264
+ "readOnly": true,
7265
+ "nullable": false
7266
+ },
7267
+ "code-scanning-alert-state": {
7268
+ "type": "string",
7269
+ "description": "State of a code scanning alert.",
7270
+ "enum": ["open", "closed", "dismissed", "fixed"]
7271
+ },
7272
+ "code-scanning-alert-dismissed-at": {
7273
+ "type": "string",
7274
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
7275
+ "format": "date-time",
7276
+ "readOnly": true,
7277
+ "nullable": true
7278
+ },
7279
+ "code-scanning-alert-rule": {
7280
+ "type": "object",
7281
+ "properties": {
7282
+ "id": {
7283
+ "nullable": true,
7284
+ "type": "string",
7285
+ "description": "A unique identifier for the rule used to detect the alert."
7286
+ },
7287
+ "name": {
7288
+ "type": "string",
7289
+ "description": "The name of the rule used to detect the alert."
7290
+ },
7291
+ "severity": {
7292
+ "nullable": true,
7293
+ "type": "string",
7294
+ "description": "The severity of the alert.",
7295
+ "enum": ["none", "note", "warning", "error"]
7296
+ },
7297
+ "security_severity_level": {
7298
+ "nullable": true,
7299
+ "type": "string",
7300
+ "description": "The security severity of the alert.",
7301
+ "enum": ["low", "medium", "high", "critical"]
7302
+ },
7303
+ "description": {
7304
+ "type": "string",
7305
+ "description": "A short description of the rule used to detect the alert."
7306
+ },
7307
+ "full_description": {
7308
+ "type": "string",
7309
+ "description": "description of the rule used to detect the alert."
7310
+ },
7311
+ "tags": {
7312
+ "nullable": true,
7313
+ "type": "array",
7314
+ "description": "A set of tags applicable for the rule.",
7315
+ "items": { "type": "string" }
7316
+ },
7317
+ "help": {
7318
+ "nullable": true,
7319
+ "type": "string",
7320
+ "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
7321
+ }
7322
+ }
7323
+ },
7324
+ "code-scanning-analysis-tool": {
7325
+ "type": "object",
7326
+ "properties": {
7327
+ "name": {
7328
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-name"
7329
+ },
7330
+ "version": {
7331
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-version"
7332
+ },
7333
+ "guid": {
7334
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
7335
+ }
7336
+ }
7337
+ },
7338
+ "code-scanning-analysis-tool-name": {
7339
+ "type": "string",
7340
+ "description": "The name of the tool used to generate the code scanning analysis."
7341
+ },
7342
+ "code-scanning-analysis-tool-version": {
7343
+ "nullable": true,
7344
+ "type": "string",
7345
+ "description": "The version of the tool used to generate the code scanning analysis."
7346
+ },
7347
+ "code-scanning-analysis-tool-guid": {
7348
+ "nullable": true,
7349
+ "type": "string",
7350
+ "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
7351
+ },
7352
+ "code-scanning-alert-instance": {
7353
+ "type": "object",
7354
+ "properties": {
7355
+ "ref": { "$ref": "#/components/schemas/code-scanning-ref" },
7356
+ "analysis_key": {
7357
+ "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
7358
+ },
7359
+ "environment": {
7360
+ "$ref": "#/components/schemas/code-scanning-alert-environment"
5861
7361
  },
5862
- "organization_secrets": {
5863
- "type": "string",
5864
- "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
5865
- "enum": ["read", "write"]
7362
+ "category": {
7363
+ "$ref": "#/components/schemas/code-scanning-analysis-category"
5866
7364
  },
5867
- "organization_self_hosted_runners": {
5868
- "type": "string",
5869
- "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.",
5870
- "enum": ["read", "write"]
7365
+ "state": { "$ref": "#/components/schemas/code-scanning-alert-state" },
7366
+ "commit_sha": { "type": "string" },
7367
+ "message": {
7368
+ "type": "object",
7369
+ "properties": { "text": { "type": "string" } }
5871
7370
  },
5872
- "organization_user_blocking": {
5873
- "type": "string",
5874
- "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.",
5875
- "enum": ["read", "write"]
7371
+ "location": {
7372
+ "$ref": "#/components/schemas/code-scanning-alert-location"
5876
7373
  },
5877
- "team_discussions": {
5878
- "type": "string",
5879
- "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
5880
- "enum": ["read", "write"]
7374
+ "html_url": { "type": "string" },
7375
+ "classifications": {
7376
+ "type": "array",
7377
+ "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.",
7378
+ "items": {
7379
+ "$ref": "#/components/schemas/code-scanning-alert-classification"
7380
+ }
5881
7381
  }
5882
- },
5883
- "example": {
5884
- "contents": "read",
5885
- "issues": "read",
5886
- "deployments": "write",
5887
- "single_file": "read"
5888
7382
  }
5889
7383
  },
5890
- "basic-error": {
5891
- "title": "Basic Error",
5892
- "description": "Basic Error",
7384
+ "code-scanning-analysis-analysis-key": {
7385
+ "type": "string",
7386
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
7387
+ },
7388
+ "code-scanning-alert-environment": {
7389
+ "type": "string",
7390
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
7391
+ },
7392
+ "code-scanning-analysis-category": {
7393
+ "type": "string",
7394
+ "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
7395
+ },
7396
+ "code-scanning-alert-location": {
5893
7397
  "type": "object",
7398
+ "description": "Describe a region within a file for the alert.",
5894
7399
  "properties": {
5895
- "message": { "type": "string" },
5896
- "documentation_url": { "type": "string" },
5897
- "url": { "type": "string" },
5898
- "status": { "type": "string" }
7400
+ "path": { "type": "string" },
7401
+ "start_line": { "type": "integer" },
7402
+ "end_line": { "type": "integer" },
7403
+ "start_column": { "type": "integer" },
7404
+ "end_column": { "type": "integer" }
5899
7405
  }
5900
7406
  },
5901
- "announcement-message": {
7407
+ "code-scanning-alert-classification": {
5902
7408
  "type": "string",
5903
- "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
5904
- "example": "Very **important** announcement about _nothing_."
7409
+ "description": "A classification of the file. For example to identify it as generated.",
7410
+ "nullable": true,
7411
+ "enum": ["source", "generated", "test", "library"]
5905
7412
  },
5906
- "announcement-expiration": {
7413
+ "code-scanning-analysis-commit-sha": {
7414
+ "description": "The SHA of the commit to which the analysis you are uploading relates.",
7415
+ "type": "string",
7416
+ "minLength": 40,
7417
+ "maxLength": 40,
7418
+ "pattern": "^[0-9a-fA-F]+$"
7419
+ },
7420
+ "code-scanning-analysis-environment": {
7421
+ "type": "string",
7422
+ "description": "Identifies the variable values associated with the environment in which this analysis was performed."
7423
+ },
7424
+ "code-scanning-analysis-created-at": {
5907
7425
  "type": "string",
7426
+ "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
5908
7427
  "format": "date-time",
5909
- "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.",
5910
- "example": "\"2021-01-01T00:00:00.000-07:00\"",
5911
- "nullable": true
7428
+ "readOnly": true,
7429
+ "nullable": false
7430
+ },
7431
+ "code-scanning-analysis-url": {
7432
+ "type": "string",
7433
+ "description": "The REST API URL of the analysis resource.",
7434
+ "format": "uri",
7435
+ "readOnly": true,
7436
+ "nullable": false
5912
7437
  },
5913
7438
  "release-asset": {
5914
7439
  "title": "Release Asset",
@@ -6579,41 +8104,6 @@
6579
8104
  "html_url": { "type": "string", "format": "uri", "nullable": true }
6580
8105
  },
6581
8106
  "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
- }
6617
8107
  }
6618
8108
  },
6619
8109
  "examples": {
@@ -7176,6 +8666,56 @@
7176
8666
  "installed_version": "3.2.0"
7177
8667
  }
7178
8668
  },
8669
+ "organization-full": {
8670
+ "value": {
8671
+ "login": "github",
8672
+ "id": 1,
8673
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
8674
+ "url": "https://api.github.com/orgs/github",
8675
+ "repos_url": "https://api.github.com/orgs/github/repos",
8676
+ "events_url": "https://api.github.com/orgs/github/events",
8677
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
8678
+ "issues_url": "https://api.github.com/orgs/github/issues",
8679
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
8680
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
8681
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
8682
+ "description": "A great organization",
8683
+ "name": "github",
8684
+ "company": "GitHub",
8685
+ "blog": "https://github.com/blog",
8686
+ "location": "San Francisco",
8687
+ "email": "octocat@github.com",
8688
+ "twitter_username": "github",
8689
+ "is_verified": true,
8690
+ "has_organization_projects": true,
8691
+ "has_repository_projects": true,
8692
+ "public_repos": 2,
8693
+ "public_gists": 1,
8694
+ "followers": 20,
8695
+ "following": 0,
8696
+ "html_url": "https://github.com/octocat",
8697
+ "created_at": "2008-01-14T04:33:35Z",
8698
+ "type": "Organization",
8699
+ "total_private_repos": 100,
8700
+ "owned_private_repos": 100,
8701
+ "private_gists": 81,
8702
+ "disk_usage": 10000,
8703
+ "collaborators": 8,
8704
+ "billing_email": "mona@github.com",
8705
+ "plan": { "name": "Medium", "space": 400, "private_repos": 20 },
8706
+ "default_repository_permission": "read",
8707
+ "members_can_create_repositories": true,
8708
+ "two_factor_requirement_enabled": true,
8709
+ "members_allowed_repository_creation_type": "all",
8710
+ "members_can_create_public_repositories": false,
8711
+ "members_can_create_private_repositories": false,
8712
+ "members_can_create_internal_repositories": false,
8713
+ "members_can_create_pages": true,
8714
+ "members_can_create_public_pages": true,
8715
+ "members_can_create_private_pages": true,
8716
+ "updated_at": "2014-03-03T18:58:10Z"
8717
+ }
8718
+ },
7179
8719
  "org-pre-receive-hook-items": {
7180
8720
  "value": [
7181
8721
  {
@@ -7205,6 +8745,393 @@
7205
8745
  "allow_downstream_configuration": false
7206
8746
  }
7207
8747
  },
8748
+ "job": {
8749
+ "value": {
8750
+ "id": 399444496,
8751
+ "run_id": 29679449,
8752
+ "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
8753
+ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
8754
+ "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
8755
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
8756
+ "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
8757
+ "status": "completed",
8758
+ "conclusion": "success",
8759
+ "started_at": "2020-01-20T17:42:40Z",
8760
+ "completed_at": "2020-01-20T17:44:39Z",
8761
+ "name": "build",
8762
+ "steps": [
8763
+ {
8764
+ "name": "Set up job",
8765
+ "status": "completed",
8766
+ "conclusion": "success",
8767
+ "number": 1,
8768
+ "started_at": "2020-01-20T09:42:40.000-08:00",
8769
+ "completed_at": "2020-01-20T09:42:41.000-08:00"
8770
+ },
8771
+ {
8772
+ "name": "Run actions/checkout@v2",
8773
+ "status": "completed",
8774
+ "conclusion": "success",
8775
+ "number": 2,
8776
+ "started_at": "2020-01-20T09:42:41.000-08:00",
8777
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
8778
+ },
8779
+ {
8780
+ "name": "Set up Ruby",
8781
+ "status": "completed",
8782
+ "conclusion": "success",
8783
+ "number": 3,
8784
+ "started_at": "2020-01-20T09:42:45.000-08:00",
8785
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
8786
+ },
8787
+ {
8788
+ "name": "Run actions/cache@v2",
8789
+ "status": "completed",
8790
+ "conclusion": "success",
8791
+ "number": 4,
8792
+ "started_at": "2020-01-20T09:42:45.000-08:00",
8793
+ "completed_at": "2020-01-20T09:42:48.000-08:00"
8794
+ },
8795
+ {
8796
+ "name": "Install Bundler",
8797
+ "status": "completed",
8798
+ "conclusion": "success",
8799
+ "number": 5,
8800
+ "started_at": "2020-01-20T09:42:48.000-08:00",
8801
+ "completed_at": "2020-01-20T09:42:52.000-08:00"
8802
+ },
8803
+ {
8804
+ "name": "Install Gems",
8805
+ "status": "completed",
8806
+ "conclusion": "success",
8807
+ "number": 6,
8808
+ "started_at": "2020-01-20T09:42:52.000-08:00",
8809
+ "completed_at": "2020-01-20T09:42:53.000-08:00"
8810
+ },
8811
+ {
8812
+ "name": "Run Tests",
8813
+ "status": "completed",
8814
+ "conclusion": "success",
8815
+ "number": 7,
8816
+ "started_at": "2020-01-20T09:42:53.000-08:00",
8817
+ "completed_at": "2020-01-20T09:42:59.000-08:00"
8818
+ },
8819
+ {
8820
+ "name": "Deploy to Heroku",
8821
+ "status": "completed",
8822
+ "conclusion": "success",
8823
+ "number": 8,
8824
+ "started_at": "2020-01-20T09:42:59.000-08:00",
8825
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
8826
+ },
8827
+ {
8828
+ "name": "Post actions/cache@v2",
8829
+ "status": "completed",
8830
+ "conclusion": "success",
8831
+ "number": 16,
8832
+ "started_at": "2020-01-20T09:44:39.000-08:00",
8833
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
8834
+ },
8835
+ {
8836
+ "name": "Complete job",
8837
+ "status": "completed",
8838
+ "conclusion": "success",
8839
+ "number": 17,
8840
+ "started_at": "2020-01-20T09:44:39.000-08:00",
8841
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
8842
+ }
8843
+ ],
8844
+ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496"
8845
+ }
8846
+ },
8847
+ "job-paginated": {
8848
+ "value": {
8849
+ "total_count": 1,
8850
+ "jobs": [
8851
+ {
8852
+ "id": 399444496,
8853
+ "run_id": 29679449,
8854
+ "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
8855
+ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
8856
+ "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
8857
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
8858
+ "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
8859
+ "status": "completed",
8860
+ "conclusion": "success",
8861
+ "started_at": "2020-01-20T17:42:40Z",
8862
+ "completed_at": "2020-01-20T17:44:39Z",
8863
+ "name": "build",
8864
+ "steps": [
8865
+ {
8866
+ "name": "Set up job",
8867
+ "status": "completed",
8868
+ "conclusion": "success",
8869
+ "number": 1,
8870
+ "started_at": "2020-01-20T09:42:40.000-08:00",
8871
+ "completed_at": "2020-01-20T09:42:41.000-08:00"
8872
+ },
8873
+ {
8874
+ "name": "Run actions/checkout@v2",
8875
+ "status": "completed",
8876
+ "conclusion": "success",
8877
+ "number": 2,
8878
+ "started_at": "2020-01-20T09:42:41.000-08:00",
8879
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
8880
+ },
8881
+ {
8882
+ "name": "Set up Ruby",
8883
+ "status": "completed",
8884
+ "conclusion": "success",
8885
+ "number": 3,
8886
+ "started_at": "2020-01-20T09:42:45.000-08:00",
8887
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
8888
+ },
8889
+ {
8890
+ "name": "Run actions/cache@v2",
8891
+ "status": "completed",
8892
+ "conclusion": "success",
8893
+ "number": 4,
8894
+ "started_at": "2020-01-20T09:42:45.000-08:00",
8895
+ "completed_at": "2020-01-20T09:42:48.000-08:00"
8896
+ },
8897
+ {
8898
+ "name": "Install Bundler",
8899
+ "status": "completed",
8900
+ "conclusion": "success",
8901
+ "number": 5,
8902
+ "started_at": "2020-01-20T09:42:48.000-08:00",
8903
+ "completed_at": "2020-01-20T09:42:52.000-08:00"
8904
+ },
8905
+ {
8906
+ "name": "Install Gems",
8907
+ "status": "completed",
8908
+ "conclusion": "success",
8909
+ "number": 6,
8910
+ "started_at": "2020-01-20T09:42:52.000-08:00",
8911
+ "completed_at": "2020-01-20T09:42:53.000-08:00"
8912
+ },
8913
+ {
8914
+ "name": "Run Tests",
8915
+ "status": "completed",
8916
+ "conclusion": "success",
8917
+ "number": 7,
8918
+ "started_at": "2020-01-20T09:42:53.000-08:00",
8919
+ "completed_at": "2020-01-20T09:42:59.000-08:00"
8920
+ },
8921
+ {
8922
+ "name": "Deploy to Heroku",
8923
+ "status": "completed",
8924
+ "conclusion": "success",
8925
+ "number": 8,
8926
+ "started_at": "2020-01-20T09:42:59.000-08:00",
8927
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
8928
+ },
8929
+ {
8930
+ "name": "Post actions/cache@v2",
8931
+ "status": "completed",
8932
+ "conclusion": "success",
8933
+ "number": 16,
8934
+ "started_at": "2020-01-20T09:44:39.000-08:00",
8935
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
8936
+ },
8937
+ {
8938
+ "name": "Complete job",
8939
+ "status": "completed",
8940
+ "conclusion": "success",
8941
+ "number": 17,
8942
+ "started_at": "2020-01-20T09:44:39.000-08:00",
8943
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
8944
+ }
8945
+ ],
8946
+ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496"
8947
+ }
8948
+ ]
8949
+ }
8950
+ },
8951
+ "code-scanning-alert": {
8952
+ "value": {
8953
+ "number": 42,
8954
+ "created_at": "2020-06-19T11:21:34Z",
8955
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
8956
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/42",
8957
+ "state": "dismissed",
8958
+ "dismissed_by": {
8959
+ "login": "octocat",
8960
+ "id": 54933897,
8961
+ "node_id": "MDQ6VXNlcjE=",
8962
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
8963
+ "gravatar_id": "",
8964
+ "url": "https://api.github.com/users/octocat",
8965
+ "html_url": "https://github.com/octocat",
8966
+ "followers_url": "https://api.github.com/users/octocat/followers",
8967
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
8968
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
8969
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
8970
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
8971
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
8972
+ "repos_url": "https://api.github.com/users/octocat/repos",
8973
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
8974
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
8975
+ "type": "User",
8976
+ "site_admin": false
8977
+ },
8978
+ "dismissed_at": "2020-02-14T12:29:18Z",
8979
+ "dismissed_reason": "false positive",
8980
+ "rule": {
8981
+ "id": "js/zipslip",
8982
+ "severity": "error",
8983
+ "security_severity_level": "high",
8984
+ "description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
8985
+ "name": "js/zipslip",
8986
+ "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
8987
+ "tags": ["security", "external/cwe/cwe-022"],
8988
+ "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
8989
+ },
8990
+ "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
8991
+ "most_recent_instance": {
8992
+ "ref": "refs/heads/main",
8993
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
8994
+ "environment": "{}",
8995
+ "state": "dismissed",
8996
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
8997
+ "message": {
8998
+ "text": "This path depends on a user-provided value."
8999
+ },
9000
+ "location": {
9001
+ "path": "spec-main/api-session-spec.ts",
9002
+ "start_line": 917,
9003
+ "end_line": 917,
9004
+ "start_column": 7,
9005
+ "end_column": 18
9006
+ },
9007
+ "classifications": ["test"]
9008
+ },
9009
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
9010
+ }
9011
+ },
9012
+ "code-scanning-alert-dismissed": {
9013
+ "value": {
9014
+ "number": 42,
9015
+ "created_at": "2020-08-25T21:28:36Z",
9016
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
9017
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/42",
9018
+ "state": "dismissed",
9019
+ "dismissed_by": {
9020
+ "login": "octocat",
9021
+ "id": 1,
9022
+ "node_id": "MDQ6VXNlcjE=",
9023
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
9024
+ "gravatar_id": "",
9025
+ "url": "https://api.github.com/users/octocat",
9026
+ "html_url": "https://github.com/octocat",
9027
+ "followers_url": "https://api.github.com/users/octocat/followers",
9028
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
9029
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
9030
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
9031
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
9032
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
9033
+ "repos_url": "https://api.github.com/users/octocat/repos",
9034
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
9035
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
9036
+ "type": "User",
9037
+ "site_admin": false
9038
+ },
9039
+ "dismissed_at": "2020-09-02T22:34:56Z",
9040
+ "dismissed_reason": "false positive",
9041
+ "rule": {
9042
+ "id": "js/zipslip",
9043
+ "severity": "error",
9044
+ "security_severity_level": "high",
9045
+ "description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
9046
+ "name": "js/zipslip",
9047
+ "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
9048
+ "tags": ["security", "external/cwe/cwe-022"],
9049
+ "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..."
9050
+ },
9051
+ "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
9052
+ "most_recent_instance": {
9053
+ "ref": "refs/heads/main",
9054
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
9055
+ "environment": "{}",
9056
+ "state": "dismissed",
9057
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
9058
+ "message": {
9059
+ "text": "This path depends on a user-provided value."
9060
+ },
9061
+ "location": {
9062
+ "path": "spec-main/api-session-spec.ts",
9063
+ "start_line": 917,
9064
+ "end_line": 917,
9065
+ "start_column": 7,
9066
+ "end_column": 18
9067
+ },
9068
+ "classifications": ["test"]
9069
+ },
9070
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
9071
+ }
9072
+ },
9073
+ "code-scanning-analysis-items": {
9074
+ "value": [
9075
+ {
9076
+ "ref": "refs/heads/main",
9077
+ "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83",
9078
+ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
9079
+ "environment": "{\"language\":\"python\"}",
9080
+ "error": "",
9081
+ "category": ".github/workflows/codeql-analysis.yml:analyze/language:python",
9082
+ "created_at": "2020-08-27T15:05:21Z",
9083
+ "results_count": 17,
9084
+ "rules_count": 49,
9085
+ "id": 201,
9086
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
9087
+ "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
9088
+ "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
9089
+ "deletable": true,
9090
+ "warning": ""
9091
+ },
9092
+ {
9093
+ "ref": "refs/heads/my-branch",
9094
+ "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321",
9095
+ "analysis_key": ".github/workflows/shiftleft.yml:build",
9096
+ "environment": "{}",
9097
+ "error": "",
9098
+ "category": ".github/workflows/shiftleft.yml:build/",
9099
+ "created_at": "2020-08-31T22:46:44Z",
9100
+ "results_count": 17,
9101
+ "rules_count": 32,
9102
+ "id": 200,
9103
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200",
9104
+ "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582",
9105
+ "tool": {
9106
+ "name": "Python Security Analysis",
9107
+ "guid": null,
9108
+ "version": "1.2.0"
9109
+ },
9110
+ "deletable": true,
9111
+ "warning": ""
9112
+ }
9113
+ ]
9114
+ },
9115
+ "code-scanning-analysis-default": {
9116
+ "summary": "Default response",
9117
+ "value": {
9118
+ "ref": "refs/heads/main",
9119
+ "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
9120
+ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
9121
+ "environment": "{\"language\":\"javascript\"}",
9122
+ "error": "",
9123
+ "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript",
9124
+ "created_at": "2021-01-13T11:55:49Z",
9125
+ "results_count": 3,
9126
+ "rules_count": 67,
9127
+ "id": 3602840,
9128
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
9129
+ "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
9130
+ "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
9131
+ "deletable": true,
9132
+ "warning": ""
9133
+ }
9134
+ },
7208
9135
  "repository-pre-receive-hook-items": {
7209
9136
  "value": [
7210
9137
  {
@@ -7638,6 +9565,45 @@
7638
9565
  }
7639
9566
  },
7640
9567
  "not_modified": { "description": "Not modified" },
9568
+ "conflict": {
9569
+ "description": "Conflict",
9570
+ "content": {
9571
+ "application/json": {
9572
+ "schema": { "$ref": "#/components/schemas/basic-error" }
9573
+ }
9574
+ }
9575
+ },
9576
+ "code_scanning_forbidden_read": {
9577
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
9578
+ "content": {
9579
+ "application/json": {
9580
+ "schema": { "$ref": "#/components/schemas/basic-error" }
9581
+ }
9582
+ }
9583
+ },
9584
+ "service_unavailable": {
9585
+ "description": "Service unavailable",
9586
+ "content": {
9587
+ "application/json": {
9588
+ "schema": {
9589
+ "type": "object",
9590
+ "properties": {
9591
+ "code": { "type": "string" },
9592
+ "message": { "type": "string" },
9593
+ "documentation_url": { "type": "string" }
9594
+ }
9595
+ }
9596
+ }
9597
+ }
9598
+ },
9599
+ "code_scanning_forbidden_write": {
9600
+ "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
9601
+ "content": {
9602
+ "application/json": {
9603
+ "schema": { "$ref": "#/components/schemas/basic-error" }
9604
+ }
9605
+ }
9606
+ },
7641
9607
  "validation_failed": {
7642
9608
  "description": "Validation failed",
7643
9609
  "content": {