Skip to content

Commit 9267300

Browse files
github-openapi-botgithub-openapi-bot
authored
Updating OpenAPI descriptions (#17316)
* Updating OpenAPI descriptions * Add decorated OpenAPI schema files
1 parent 9035d8c commit 9267300

16 files changed

Lines changed: 13524 additions & 556 deletions

‎lib/rest/static/decorated/api.github.com.json‎

Lines changed: 1469 additions & 73 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.18.json‎

Lines changed: 1455 additions & 59 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.19.json‎

Lines changed: 1455 additions & 59 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.20.json‎

Lines changed: 1455 additions & 59 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.21.json‎

Lines changed: 1455 additions & 59 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.22.json‎

Lines changed: 1455 additions & 59 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-3.0.json‎

Lines changed: 1469 additions & 73 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/github.ae.json‎

Lines changed: 1455 additions & 59 deletions
Large diffs are not rendered by default.

‎lib/rest/static/dereferenced/api.github.com.deref.json‎

Lines changed: 232 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2521,23 +2521,248 @@
25212521
}
25222522
},
25232523
"permissions": {
2524+
"title": "App Permissions",
25242525
"type": "object",
2526+
"description": "The permissions granted to the user-to-server access token.",
25252527
"properties": {
2528+
"actions": {
2529+
"type": "string",
2530+
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.",
2531+
"enum": [
2532+
"read",
2533+
"write"
2534+
]
2535+
},
2536+
"administration": {
2537+
"type": "string",
2538+
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.",
2539+
"enum": [
2540+
"read",
2541+
"write"
2542+
]
2543+
},
2544+
"checks": {
2545+
"type": "string",
2546+
"description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.",
2547+
"enum": [
2548+
"read",
2549+
"write"
2550+
]
2551+
},
2552+
"content_references": {
2553+
"type": "string",
2554+
"description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.",
2555+
"enum": [
2556+
"read",
2557+
"write"
2558+
]
2559+
},
25262560
"contents": {
2527-
"type": "string"
2561+
"type": "string",
2562+
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.",
2563+
"enum": [
2564+
"read",
2565+
"write"
2566+
]
2567+
},
2568+
"deployments": {
2569+
"type": "string",
2570+
"description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.",
2571+
"enum": [
2572+
"read",
2573+
"write"
2574+
]
2575+
},
2576+
"environments": {
2577+
"type": "string",
2578+
"description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.",
2579+
"enum": [
2580+
"read",
2581+
"write"
2582+
]
25282583
},
25292584
"issues": {
2530-
"type": "string"
2585+
"type": "string",
2586+
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.",
2587+
"enum": [
2588+
"read",
2589+
"write"
2590+
]
25312591
},
2532-
"deployments": {
2533-
"type": "string"
2592+
"metadata": {
2593+
"type": "string",
2594+
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.",
2595+
"enum": [
2596+
"read",
2597+
"write"
2598+
]
2599+
},
2600+
"packages": {
2601+
"type": "string",
2602+
"description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.",
2603+
"enum": [
2604+
"read",
2605+
"write"
2606+
]
2607+
},
2608+
"pages": {
2609+
"type": "string",
2610+
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.",
2611+
"enum": [
2612+
"read",
2613+
"write"
2614+
]
2615+
},
2616+
"pull_requests": {
2617+
"type": "string",
2618+
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.",
2619+
"enum": [
2620+
"read",
2621+
"write"
2622+
]
2623+
},
2624+
"repository_hooks": {
2625+
"type": "string",
2626+
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.",
2627+
"enum": [
2628+
"read",
2629+
"write"
2630+
]
2631+
},
2632+
"repository_projects": {
2633+
"type": "string",
2634+
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.",
2635+
"enum": [
2636+
"read",
2637+
"write",
2638+
"admin"
2639+
]
2640+
},
2641+
"secret_scanning_alerts": {
2642+
"type": "string",
2643+
"description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.",
2644+
"enum": [
2645+
"read",
2646+
"write"
2647+
]
2648+
},
2649+
"secrets": {
2650+
"type": "string",
2651+
"description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.",
2652+
"enum": [
2653+
"read",
2654+
"write"
2655+
]
2656+
},
2657+
"security_events": {
2658+
"type": "string",
2659+
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.",
2660+
"enum": [
2661+
"read",
2662+
"write"
2663+
]
25342664
},
25352665
"single_file": {
2536-
"type": "string"
2666+
"type": "string",
2667+
"description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.",
2668+
"enum": [
2669+
"read",
2670+
"write"
2671+
]
2672+
},
2673+
"statuses": {
2674+
"type": "string",
2675+
"description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.",
2676+
"enum": [
2677+
"read",
2678+
"write"
2679+
]
2680+
},
2681+
"vulnerability_alerts": {
2682+
"type": "string",
2683+
"description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.",
2684+
"enum": [
2685+
"read"
2686+
]
2687+
},
2688+
"workflows": {
2689+
"type": "string",
2690+
"description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.",
2691+
"enum": [
2692+
"write"
2693+
]
2694+
},
2695+
"members": {
2696+
"type": "string",
2697+
"description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.",
2698+
"enum": [
2699+
"read",
2700+
"write"
2701+
]
2702+
},
2703+
"organization_administration": {
2704+
"type": "string",
2705+
"description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.",
2706+
"enum": [
2707+
"read",
2708+
"write"
2709+
]
2710+
},
2711+
"organization_hooks": {
2712+
"type": "string",
2713+
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.",
2714+
"enum": [
2715+
"read",
2716+
"write"
2717+
]
2718+
},
2719+
"organization_plan": {
2720+
"type": "string",
2721+
"description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.",
2722+
"enum": [
2723+
"read"
2724+
]
25372725
},
2538-
"def_not_a_repo": {
2726+
"organization_projects": {
2727+
"type": "string",
2728+
"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`.",
2729+
"enum": [
2730+
"read",
2731+
"write",
2732+
"admin"
2733+
]
2734+
},
2735+
"organization_secrets": {
25392736
"type": "string",
2540-
"example": "\"read\""
2737+
"description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.",
2738+
"enum": [
2739+
"read",
2740+
"write"
2741+
]
2742+
},
2743+
"organization_self_hosted_runners": {
2744+
"type": "string",
2745+
"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`.",
2746+
"enum": [
2747+
"read",
2748+
"write"
2749+
]
2750+
},
2751+
"organization_user_blocking": {
2752+
"type": "string",
2753+
"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`.",
2754+
"enum": [
2755+
"read",
2756+
"write"
2757+
]
2758+
},
2759+
"team_discussions": {
2760+
"type": "string",
2761+
"description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.",
2762+
"enum": [
2763+
"read",
2764+
"write"
2765+
]
25412766
}
25422767
},
25432768
"example": {

0 commit comments

Comments
 (0)