From 325348efd64f170d442122bf351dd550537c0a98 Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Thu, 26 Jan 2023 16:34:31 -0800 Subject: [PATCH] Update OpenAPI Description (#34179) --- .../client-side-rest-api-redirects.json | 2 + .../decorated/api.github.com.2022-11-28.json | 196 +++++++++++++++++- .../static/decorated/ghec.2022-11-28.json | 196 +++++++++++++++++- lib/rest/static/decorated/ghes-3.3.json | 12 +- lib/rest/static/decorated/ghes-3.4.json | 12 +- lib/rest/static/decorated/ghes-3.5.json | 12 +- lib/rest/static/decorated/ghes-3.6.json | 12 +- lib/rest/static/decorated/ghes-3.7.json | 12 +- lib/rest/static/decorated/github.ae.json | 12 +- 9 files changed, 414 insertions(+), 52 deletions(-) diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index 40c300c9d0..948d653793 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -320,6 +320,8 @@ "/rest/codespaces#list-in-organization": "/rest/codespaces/organizations#list-in-organization", "/rest/codespaces#organizations": "/rest/codespaces/organizations", "/rest/codespaces#set-codespaces-billing": "/rest/codespaces/organizations#set-codespaces-billing", + "/rest/codespaces#set-codespaces-billing-users": "/rest/codespaces/organizations#set-codespaces-billing-users", + "/rest/codespaces#delete-codespaces-billing-users": "/rest/codespaces/organizations#delete-codespaces-billing-users", "/rest/codespaces#list-organization-secrets": "/rest/codespaces/organization-secrets#list-organization-secrets", "/rest/codespaces#organization-secrets": "/rest/codespaces/organization-secrets", "/rest/codespaces#get-an-organization-public-key": "/rest/codespaces/organization-secrets#get-an-organization-public-key", diff --git a/lib/rest/static/decorated/api.github.com.2022-11-28.json b/lib/rest/static/decorated/api.github.com.2022-11-28.json index ea7987d779..a4a5fcb438 100644 --- a/lib/rest/static/decorated/api.github.com.2022-11-28.json +++ b/lib/rest/static/decorated/api.github.com.2022-11-28.json @@ -30766,6 +30766,15 @@ "schema": { "type": "string" } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } } ], "bodyParameters": [ @@ -30796,7 +30805,8 @@ }, "parameters": { "repository_id": "REPOSITORY_ID", - "name": "NAME" + "name": "NAME", + "environment_name": "ENVIRONMENT_NAME" } }, "response": { @@ -30839,6 +30849,15 @@ "schema": { "type": "string" } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -30851,7 +30870,8 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", - "name": "NAME" + "name": "NAME", + "environment_name": "ENVIRONMENT_NAME" } }, "response": { @@ -198188,6 +198208,166 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/codespaces/billing/selected_users", + "title": "Add users to Codespaces billing for an organization", + "category": "codespaces", + "subcategory": "organizations", + "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": "selected_usernames", + "in": "body", + "description": "

The usernames of the organization members whose codespaces be billed to the organization.

", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response when successfully modifying permissions.

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

Codespaces for the specified users will be billed to the organization.\nTo use this endpoint, the billing settings for the organization must be set to selected_members. For information on how to change this setting please see [these docs].(https://docs.github.com/en/rest/codespaces/organizations?apiVersion=2022-11-28#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the admin:org scope to use this endpoint.

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

Response when successfully modifying permissions.

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

Not modified

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

Users are neither members nor collaborators of this organization.

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

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

Internal Error

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/codespaces/billing/selected_users", + "title": "Removes users from Codespaces billing for an organization", + "category": "codespaces", + "subcategory": "organizations", + "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": "selected_usernames", + "in": "body", + "description": "

The usernames of the organization members whose codespaces should not be billed to the organization.

", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response when successfully modifying permissions.

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

Codespaces for the specified users will no longer be billed to the organization.\nTo use this endpoint, the billing settings for the organization must be set to selected_members. For information on how to change this setting please see [these docs].(https://docs.github.com/en/rest/codespaces/organizations?apiVersion=2022-11-28#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the admin:org scope to use this endpoint.

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

Response when successfully modifying permissions.

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

Not modified

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

Users are neither members nor collaborators of this organization.

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

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

Internal Error

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -279347,13 +279527,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -279363,7 +279543,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -279375,19 +279555,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghec.2022-11-28.json b/lib/rest/static/decorated/ghec.2022-11-28.json index fffe2f5d0f..9f3d0b445e 100644 --- a/lib/rest/static/decorated/ghec.2022-11-28.json +++ b/lib/rest/static/decorated/ghec.2022-11-28.json @@ -36673,6 +36673,15 @@ "schema": { "type": "string" } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } } ], "bodyParameters": [ @@ -36703,7 +36712,8 @@ }, "parameters": { "repository_id": "REPOSITORY_ID", - "name": "NAME" + "name": "NAME", + "environment_name": "ENVIRONMENT_NAME" } }, "response": { @@ -36746,6 +36756,15 @@ "schema": { "type": "string" } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "

The name of the environment.

", + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -36758,7 +36777,8 @@ "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", - "name": "NAME" + "name": "NAME", + "environment_name": "ENVIRONMENT_NAME" } }, "response": { @@ -206180,6 +206200,166 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/codespaces/billing/selected_users", + "title": "Add users to Codespaces billing for an organization", + "category": "codespaces", + "subcategory": "organizations", + "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": "selected_usernames", + "in": "body", + "description": "

The usernames of the organization members whose codespaces be billed to the organization.

", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response when successfully modifying permissions.

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

Codespaces for the specified users will be billed to the organization.\nTo use this endpoint, the billing settings for the organization must be set to selected_members. For information on how to change this setting please see [these docs].(https://docs.github.com/en/rest/codespaces/organizations?apiVersion=2022-11-28#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the admin:org scope to use this endpoint.

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

Response when successfully modifying permissions.

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

Not modified

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

Users are neither members nor collaborators of this organization.

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

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

Internal Error

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/codespaces/billing/selected_users", + "title": "Removes users from Codespaces billing for an organization", + "category": "codespaces", + "subcategory": "organizations", + "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": "selected_usernames", + "in": "body", + "description": "

The usernames of the organization members whose codespaces should not be billed to the organization.

", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "204", + "description": "

Response when successfully modifying permissions.

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

Codespaces for the specified users will no longer be billed to the organization.\nTo use this endpoint, the billing settings for the organization must be set to selected_members. For information on how to change this setting please see [these docs].(https://docs.github.com/en/rest/codespaces/organizations?apiVersion=2022-11-28#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the admin:org scope to use this endpoint.

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

Response when successfully modifying permissions.

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

Not modified

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

Users are neither members nor collaborators of this organization.

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

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

Internal Error

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -288805,13 +288985,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -288821,7 +289001,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -288833,19 +289013,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index d44959e74c..75814ea6e7 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -209453,13 +209453,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -209469,7 +209469,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -209481,19 +209481,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index e880393ca2..404519b5a4 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -217138,13 +217138,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -217154,7 +217154,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -217166,19 +217166,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index c0be5efb72..ef927c10ad 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -224296,13 +224296,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -224312,7 +224312,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -224324,19 +224324,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index ddeb2e9f93..3be0eb3f67 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -232831,13 +232831,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -232847,7 +232847,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -232859,19 +232859,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.7.json b/lib/rest/static/decorated/ghes-3.7.json index 900b3ab2f9..2f6ceaad67 100644 --- a/lib/rest/static/decorated/ghes-3.7.json +++ b/lib/rest/static/decorated/ghes-3.7.json @@ -235705,13 +235705,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -235721,7 +235721,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -235733,19 +235733,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 65e3474857..0995247352 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -184071,13 +184071,13 @@ "type": "string or null", "name": "assignee", "in": "body", - "description": "

Login for the user that this issue should be assigned to. This field is deprecated.

" + "description": "

Username to assign to this issue. This field is deprecated.

" }, { "type": "string", "name": "state", "in": "body", - "description": "

State of the issue. Either open or closed.

", + "description": "

The open or closed state of the issue.

", "enum": [ "open", "closed" @@ -184087,7 +184087,7 @@ "type": "string or null", "name": "state_reason", "in": "body", - "description": "

The reason for the current state

", + "description": "

The reason for the state change. Ignored unless state is changed.

", "enum": [ "completed", "not_planned", @@ -184099,19 +184099,19 @@ "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

" + "description": "

The number of the milestone to associate this issue with or use null to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.

" }, { "type": "array", "name": "labels", "in": "body", - "description": "

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

" + "description": "

Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array ([]) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.

" }, { "type": "array of strings", "name": "assignees", "in": "body", - "description": "

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

" + "description": "

Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array ([]) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

" } ], "enabledForGitHubApps": true,