From 8e92d91b6b99bfcc4a6136412119ba3e835ebc7a Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 12 Oct 2023 15:03:33 -0700 Subject: [PATCH] Update OpenAPI Description (#44272) Co-authored-by: Felicity Chapman Co-authored-by: Rachael Sewell --- content/rest/orgs/index.md | 3 +- content/rest/orgs/properties.md | 20 + content/rest/repos/index.md | 3 +- content/rest/repos/properties.md | 20 + .../fine-grained-pat-permissions.json | 72 + .../data/fpt-2022-11-28/fine-grained-pat.json | 48 + .../server-to-server-permissions.json | 88 ++ .../fpt-2022-11-28/server-to-server-rest.json | 48 + .../fpt-2022-11-28/user-to-server-rest.json | 48 + .../fine-grained-pat-permissions.json | 72 + .../ghec-2022-11-28/fine-grained-pat.json | 48 + .../server-to-server-permissions.json | 88 ++ .../server-to-server-rest.json | 48 + .../ghec-2022-11-28/user-to-server-rest.json | 48 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 1166 ++++++++++++++++- src/rest/data/ghec-2022-11-28/schema.json | 1166 ++++++++++++++++- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 6 +- src/webhooks/data/ghec/schema.json | 6 +- src/webhooks/lib/config.json | 2 +- 21 files changed, 2977 insertions(+), 27 deletions(-) create mode 100644 content/rest/orgs/properties.md create mode 100644 content/rest/repos/properties.md diff --git a/content/rest/orgs/index.md b/content/rest/orgs/index.md index a9eb11561a..e9610ed3fd 100644 --- a/content/rest/orgs/index.md +++ b/content/rest/orgs/index.md @@ -21,8 +21,9 @@ children: - /orgs - /outside-collaborators - /personal-access-tokens - - /rules + - /properties - /rule-suites + - /rules - /security-managers - /webhooks autogenerated: rest diff --git a/content/rest/orgs/properties.md b/content/rest/orgs/properties.md new file mode 100644 index 0000000000..8332033f09 --- /dev/null +++ b/content/rest/orgs/properties.md @@ -0,0 +1,20 @@ +--- +title: Properties +shortTitle: Properties +intro: 'Use the REST API to create and manage custom properties for an organization. You can use custom properties to define a group of repositories.' +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + +{% note %} + +**Note:** The API endpoints for custom properties are in public beta and subject to change. + +{% endnote %} + + diff --git a/content/rest/repos/index.md b/content/rest/repos/index.md index 720d75997e..5e1214b86b 100644 --- a/content/rest/repos/index.md +++ b/content/rest/repos/index.md @@ -19,9 +19,10 @@ children: - /contents - /forks - /lfs + - /properties - /repos - - /rules - /rule-suites + - /rules - /tags autogenerated: rest --- diff --git a/content/rest/repos/properties.md b/content/rest/repos/properties.md new file mode 100644 index 0000000000..6e69867648 --- /dev/null +++ b/content/rest/repos/properties.md @@ -0,0 +1,20 @@ +--- +title: Properties +shortTitle: Properties +intro: 'Use the REST API to list the custom properties assigned to a repository by the organization.' +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + +{% note %} + +**Note:** The API endpoints for custom properties are in public beta and subject to change. + +{% endnote %} + + diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 448277f971..ee792fd960 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -187,6 +187,42 @@ "additional-permissions": [], "access": "write" }, + { + "category": "orgs", + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "additional-permissions": [], + "access": "write" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": [], + "access": "write" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": [], + "access": "write" + }, + { + "category": "orgs", + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "additional-permissions": [], + "access": "write" + }, { "category": "orgs", "slug": "get-all-organization-repository-rulesets", @@ -535,6 +571,33 @@ "additional-permissions": [], "access": "write" }, + { + "category": "orgs", + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema", + "additional-permissions": [], + "access": "read" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": [], + "access": "read" + }, + { + "category": "orgs", + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "additional-permissions": [], + "access": "read" + }, { "category": "orgs", "slug": "list-public-organization-members", @@ -2808,6 +2871,15 @@ "additional-permissions": [], "access": "write" }, + { + "category": "repos", + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "additional-permissions": [], + "access": "read" + }, { "category": "repos", "slug": "create-a-repository-ruleset", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 20b5d2ff15..91c9daac3b 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -2972,6 +2972,48 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, + { + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values" + }, + { + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values" + }, { "slug": "list-public-organization-members", "subcategory": "members", @@ -3892,6 +3934,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" }, + { + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 78276fd145..c01a7d1d4d 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -227,6 +227,50 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "orgs", + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "orgs", "slug": "get-all-organization-repository-rulesets", @@ -647,6 +691,39 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "orgs", + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "orgs", "slug": "list-public-organization-members", @@ -3492,6 +3569,17 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "repos", + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "repos", "slug": "create-a-repository-ruleset", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index ac96e05f74..b5fcebc965 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -2582,6 +2582,48 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, + { + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values" + }, + { + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values" + }, { "slug": "list-public-organization-members", "subcategory": "members", @@ -3514,6 +3556,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" }, + { + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index baec844cb2..425f5b6a90 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -3038,6 +3038,48 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, + { + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values" + }, + { + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values" + }, { "slug": "list-public-organization-members", "subcategory": "members", @@ -3958,6 +4000,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" }, + { + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index b652adcdae..107607e418 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -459,6 +459,42 @@ "additional-permissions": [], "access": "write" }, + { + "category": "orgs", + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "additional-permissions": [], + "access": "write" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": [], + "access": "write" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": [], + "access": "write" + }, + { + "category": "orgs", + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "additional-permissions": [], + "access": "write" + }, { "category": "orgs", "slug": "get-all-organization-repository-rulesets", @@ -949,6 +985,33 @@ "additional-permissions": [], "access": "write" }, + { + "category": "orgs", + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema", + "additional-permissions": [], + "access": "read" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": [], + "access": "read" + }, + { + "category": "orgs", + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "additional-permissions": [], + "access": "read" + }, { "category": "orgs", "slug": "list-public-organization-members", @@ -3466,6 +3529,15 @@ "additional-permissions": [], "access": "write" }, + { + "category": "repos", + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "additional-permissions": [], + "access": "read" + }, { "category": "repos", "slug": "create-a-repository-ruleset", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index c9af0d52f5..b297e15a4f 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -3294,6 +3294,48 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, + { + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values" + }, + { + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values" + }, { "slug": "list-public-organization-members", "subcategory": "members", @@ -4214,6 +4256,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" }, + { + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index ded4bd6e79..f8329295f8 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -555,6 +555,50 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "orgs", + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "orgs", "slug": "get-all-organization-repository-rulesets", @@ -1145,6 +1189,39 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "orgs", + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "orgs", + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "orgs", "slug": "list-public-organization-members", @@ -4286,6 +4363,17 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "repos", + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "repos", "slug": "create-a-repository-ruleset", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 56136b7751..575ce68d71 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -2904,6 +2904,48 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, + { + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values" + }, + { + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values" + }, { "slug": "list-public-organization-members", "subcategory": "members", @@ -3836,6 +3878,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" }, + { + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index bd1ed9948d..da9f4a1657 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -3360,6 +3360,48 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, + { + "slug": "get-all-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "create-or-update-custom-properties-for-an-organization", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "list-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values" + }, + { + "slug": "create-or-update-custom-property-values-for-organization-repositories", + "subcategory": "properties", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values" + }, { "slug": "list-public-organization-members", "subcategory": "members", @@ -4280,6 +4322,12 @@ "verb": "delete", "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" }, + { + "slug": "get-all-custom-property-values-for-a-repository", + "subcategory": "properties", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index a4e0532551..0da56b5606 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "2ebc81f343d9839e1ed5150caf6dcfed7d92eb11" + "sha": "0590bfae7149f3fee6429d1e031646d79abb8f9a" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 16b8a627e2..427a0768e2 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -341638,7 +341638,7 @@ } ], "previews": [], - "descriptionHTML": "

View the progress of an import.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", + "descriptionHTML": "

View the progress of an import.

\n

Warnings:

\n\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -341909,7 +341909,7 @@ } ], "previews": [], - "descriptionHTML": "

Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarnings:

\n", "statusCodes": [ { "httpStatusCode": "201", @@ -342533,7 +342533,7 @@ } ], "previews": [], - "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -342592,7 +342592,7 @@ } ], "previews": [], - "descriptionHTML": "

Stop an import for a repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Stop an import for a repository.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "204", @@ -342732,7 +342732,7 @@ } ], "previews": [], - "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -342872,7 +342872,7 @@ } ], "previews": [], - "descriptionHTML": "

Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -342988,7 +342988,7 @@ } ], "previews": [], - "descriptionHTML": "

List files larger than 100MB found during the import

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

List files larger than 100MB found during the import

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -343225,7 +343225,7 @@ } ], "previews": [], - "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -362111,6 +362111,1051 @@ ] } ], + "properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema", + "title": "Get all custom properties for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "title": "Create or update custom properties for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

The array of custom properties to create or update.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string", + "name": "value_type", + "description": "

The type of the value for the property

", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "

Whether the property is required.

" + }, + { + "type": "string or null", + "name": "default_value", + "description": "

Default value of the property

" + }, + { + "type": "string or null", + "name": "description", + "description": "

Short description of the property

" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "

Ordered list of allowed values of the property

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Get a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name. The name is case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Create or update a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name. The name is case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "value_type", + "in": "body", + "description": "

The type of the value for the property

", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "in": "body", + "description": "

Whether the property is required.

" + }, + { + "type": "string or null", + "name": "default_value", + "in": "body", + "description": "

Default value of the property

" + }, + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "

Short description of the property

" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "in": "body", + "description": "

Ordered list of allowed values of the property

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Remove a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name. The name is case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

A header with no content is returned.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "title": "List custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "title": "Create or update custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repository_names", + "in": "body", + "description": "

The names of repositories that the custom property values will be applied to.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

List of custom property names and associated values to apply to the repositories.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string or null", + "name": "value", + "description": "

The value assigned to the property

", + "isRequired": true + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.

\n

A maximum of 30 repositories can be updated in a single request.

\n

Using a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Only organization owners (or users with the proper permissions granted by them) can update these properties

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", @@ -483619,6 +484664,111 @@ ] } ], + "properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "title": "Get all custom property values for a repository", + "category": "repos", + "subcategory": "properties", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 4128de5f4d..eaf2c1f91c 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -360449,7 +360449,7 @@ } ], "previews": [], - "descriptionHTML": "

View the progress of an import.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", + "descriptionHTML": "

View the progress of an import.

\n

Warnings:

\n\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n\n

If there are problems, you will see one of these in the status field:

\n\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -360720,7 +360720,7 @@ } ], "previews": [], - "descriptionHTML": "

Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarnings:

\n", "statusCodes": [ { "httpStatusCode": "201", @@ -361344,7 +361344,7 @@ } ], "previews": [], - "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -361403,7 +361403,7 @@ } ], "previews": [], - "descriptionHTML": "

Stop an import for a repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Stop an import for a repository.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "204", @@ -361543,7 +361543,7 @@ } ], "previews": [], - "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -361683,7 +361683,7 @@ } ], "previews": [], - "descriptionHTML": "

Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -361799,7 +361799,7 @@ } ], "previews": [], - "descriptionHTML": "

List files larger than 100MB found during the import

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

List files larger than 100MB found during the import

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -362036,7 +362036,7 @@ } ], "previews": [], - "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.

", + "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warnings:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -384407,6 +384407,1051 @@ ] } ], + "properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema", + "title": "Get all custom properties for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "title": "Create or update custom properties for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

The array of custom properties to create or update.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string", + "name": "value_type", + "description": "

The type of the value for the property

", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "

Whether the property is required.

" + }, + { + "type": "string or null", + "name": "default_value", + "description": "

Default value of the property

" + }, + { + "type": "string or null", + "name": "description", + "description": "

Short description of the property

" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "

Ordered list of allowed values of the property

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Get a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name. The name is case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Create or update a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name. The name is case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "value_type", + "in": "body", + "description": "

The type of the value for the property

", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "in": "body", + "description": "

Whether the property is required.

" + }, + { + "type": "string or null", + "name": "default_value", + "in": "body", + "description": "

Default value of the property

" + }, + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "

Short description of the property

" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "in": "body", + "description": "

Ordered list of allowed values of the property

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Remove a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "

The custom property name. The name is case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

" + } + } + ], + "previews": [], + "descriptionHTML": "

Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

A header with no content is returned.

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "title": "List custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "title": "Create or update custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repository_names", + "in": "body", + "description": "

The names of repositories that the custom property values will be applied to.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

List of custom property names and associated values to apply to the repositories.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string or null", + "name": "value", + "description": "

The value assigned to the property

", + "isRequired": true + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.

\n

A maximum of 30 repositories can be updated in a single request.

\n

Using a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Only organization owners (or users with the proper permissions granted by them) can update these properties

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", @@ -506043,6 +507088,111 @@ ] } ], + "properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "title": "Get all custom property values for a repository", + "category": "repos", + "subcategory": "properties", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 01b43f8c81..84c874a210 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -36,5 +36,5 @@ ] } }, - "sha": "2ebc81f343d9839e1ed5150caf6dcfed7d92eb11" + "sha": "0590bfae7149f3fee6429d1e031646d79abb8f9a" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 38cca54ffb..1e7617acb6 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -200833,7 +200833,7 @@ "repository_ruleset": { "created": { "descriptionHtml": "

A repository ruleset was created.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -201664,7 +201664,7 @@ }, "deleted": { "descriptionHtml": "

A repository ruleset was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -202495,7 +202495,7 @@ }, "edited": { "descriptionHtml": "

A repository ruleset was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index f07966cdfb..510901c628 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -200833,7 +200833,7 @@ "repository_ruleset": { "created": { "descriptionHtml": "

A repository ruleset was created.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -201664,7 +201664,7 @@ }, "deleted": { "descriptionHtml": "

A repository ruleset was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -202495,7 +202495,7 @@ }, "edited": { "descriptionHtml": "

A repository ruleset was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 95d43b1c0f..265287ba20 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2ebc81f343d9839e1ed5150caf6dcfed7d92eb11" + "sha": "0590bfae7149f3fee6429d1e031646d79abb8f9a" } \ No newline at end of file