From d4ff8d3467063da073cd0bffa2b4b573182bf799 Mon Sep 17 00:00:00 2001
From: github-openapi-bot
<69533958+github-openapi-bot@users.noreply.github.com>
Date: Tue, 31 May 2022 08:21:36 -0700
Subject: [PATCH] Update OpenAPI Descriptions (#28121)
---
lib/rest/static/decorated/api.github.com.json | 14 ++++++++++----
lib/rest/static/decorated/ghes-3.1.json | 10 ++++++++--
lib/rest/static/decorated/ghes-3.2.json | 10 ++++++++--
lib/rest/static/decorated/ghes-3.3.json | 14 ++++++++++----
lib/rest/static/decorated/ghes-3.4.json | 14 ++++++++++----
lib/rest/static/decorated/ghes-3.5.json | 14 ++++++++++----
lib/rest/static/decorated/github.ae.json | 14 ++++++++++----
.../dereferenced/api.github.com.deref.json | 18 +++++++++++++++++-
.../static/dereferenced/ghes-3.1.deref.json | 16 ++++++++++++++++
.../static/dereferenced/ghes-3.2.deref.json | 16 ++++++++++++++++
.../static/dereferenced/ghes-3.3.deref.json | 18 +++++++++++++++++-
.../static/dereferenced/ghes-3.4.deref.json | 18 +++++++++++++++++-
.../static/dereferenced/ghes-3.5.deref.json | 18 +++++++++++++++++-
.../static/dereferenced/github.ae.deref.json | 18 +++++++++++++++++-
14 files changed, 183 insertions(+), 29 deletions(-)
diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json
index cd7624046936..3e3b7d83eb9c 100644
--- a/lib/rest/static/decorated/api.github.com.json
+++ b/lib/rest/static/decorated/api.github.com.json
@@ -338847,8 +338847,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -391484,7 +391487,7 @@
},
{
"type": "integer",
- "description": "This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
+ "description": "This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
@@ -391492,7 +391495,7 @@
"name": "position",
"in": "body",
"rawType": "integer",
- "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"isRequired": false,
"childParamsGroups": []
},
@@ -507697,8 +507700,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json
index cee58b8e1962..61f00167aade 100644
--- a/lib/rest/static/decorated/ghes-3.1.json
+++ b/lib/rest/static/decorated/ghes-3.1.json
@@ -251130,8 +251130,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -393580,8 +393583,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json
index 755f450946f0..2fb586e7cc6b 100644
--- a/lib/rest/static/decorated/ghes-3.2.json
+++ b/lib/rest/static/decorated/ghes-3.2.json
@@ -257060,8 +257060,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -402132,8 +402135,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json
index aeaa7d86c75a..899da7241096 100644
--- a/lib/rest/static/decorated/ghes-3.3.json
+++ b/lib/rest/static/decorated/ghes-3.3.json
@@ -258006,8 +258006,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -292571,7 +292574,7 @@
},
{
"type": "integer",
- "description": "This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
+ "description": "This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
@@ -292579,7 +292582,7 @@
"name": "position",
"in": "body",
"rawType": "integer",
- "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"isRequired": false,
"childParamsGroups": []
},
@@ -400971,8 +400974,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json
index 1e73192545cf..8d169efba990 100644
--- a/lib/rest/static/decorated/ghes-3.4.json
+++ b/lib/rest/static/decorated/ghes-3.4.json
@@ -277893,8 +277893,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -312458,7 +312461,7 @@
},
{
"type": "integer",
- "description": "This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
+ "description": "This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
@@ -312466,7 +312469,7 @@
"name": "position",
"in": "body",
"rawType": "integer",
- "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"isRequired": false,
"childParamsGroups": []
},
@@ -424023,8 +424026,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json
index be058bfea811..505f3dea9ace 100644
--- a/lib/rest/static/decorated/ghes-3.5.json
+++ b/lib/rest/static/decorated/ghes-3.5.json
@@ -289738,8 +289738,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -324303,7 +324306,7 @@
},
{
"type": "integer",
- "description": "This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
+ "description": "This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
@@ -324311,7 +324314,7 @@
"name": "position",
"in": "body",
"rawType": "integer",
- "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"isRequired": false,
"childParamsGroups": []
},
@@ -436404,8 +436407,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json
index 9123a43d6aa4..8d0aa7a8a437 100644
--- a/lib/rest/static/decorated/github.ae.json
+++ b/lib/rest/static/decorated/github.ae.json
@@ -258982,8 +258982,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Set an organization membership role for a user",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "member"
+ },
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -293123,7 +293126,7 @@
},
{
"type": "integer",
- "description": "This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
+ "description": "This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
@@ -293131,7 +293134,7 @@
"name": "position",
"in": "body",
"rawType": "integer",
- "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "rawDescription": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"isRequired": false,
"childParamsGroups": []
},
@@ -395556,8 +395559,11 @@
"key": "default",
"request": {
"contentType": "application/json",
- "description": "Example",
+ "description": "Add or update team membership for an organization member",
"acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "role": "maintainer"
+ },
"parameters": {
"org": "ORG",
"team_slug": "TEAM_SLUG",
diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json
index be164a268575..bdc167972061 100644
--- a/lib/rest/static/dereferenced/api.github.com.deref.json
+++ b/lib/rest/static/dereferenced/api.github.com.deref.json
@@ -103482,6 +103482,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -137960,6 +137968,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
@@ -416756,7 +416772,7 @@
},
"position": {
"type": "integer",
- "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json
index e261480e022f..c3947cd62e14 100644
--- a/lib/rest/static/dereferenced/ghes-3.1.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json
@@ -91868,6 +91868,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -107913,6 +107921,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json
index 8fd6baf55286..183fb661e423 100644
--- a/lib/rest/static/dereferenced/ghes-3.2.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json
@@ -94105,6 +94105,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -110172,6 +110180,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json
index f4b952fee564..399d7a38065c 100644
--- a/lib/rest/static/dereferenced/ghes-3.3.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json
@@ -94717,6 +94717,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -113651,6 +113659,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
@@ -358035,7 +358051,7 @@
},
"position": {
"type": "integer",
- "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json
index 4b85e089239b..474a341498bd 100644
--- a/lib/rest/static/dereferenced/ghes-3.4.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json
@@ -100734,6 +100734,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -125681,6 +125689,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
@@ -376384,7 +376400,7 @@
},
"position": {
"type": "integer",
- "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json
index 7ad0c5b4b21f..3d43430391b4 100644
--- a/lib/rest/static/dereferenced/ghes-3.5.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json
@@ -104979,6 +104979,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -129946,6 +129954,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
@@ -388399,7 +388415,7 @@
},
"position": {
"type": "integer",
- "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json
index 62f0074fff49..6f48d27f887d 100644
--- a/lib/rest/static/dereferenced/github.ae.deref.json
+++ b/lib/rest/static/dereferenced/github.ae.deref.json
@@ -67494,6 +67494,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
}
}
}
@@ -88790,6 +88798,14 @@
"default": "member"
}
}
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
}
}
}
@@ -340641,7 +340657,7 @@
},
"position": {
"type": "integer",
- "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
+ "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"