Skip to content

Commit fb4ffc1

Browse files
author
Marc-Andre Giroux
committed
Update OpenAPI Description
 - Add a protocol variable to ghes servers - removes the `name` requestBody param on the issues/update-label operation. Use `new_name` instead.
1 parent 140582e commit fb4ffc1

20 files changed

+92
-92
lines changed

‎descriptions/api.github.com/api.github.com.json‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -35609,10 +35609,6 @@
3560935609
"description": {
3561035610
"type": "string",
3561135611
"description": "A short description of the label."
35612-
},
35613-
"name": {
35614-
"type": "string",
35615-
"example": "\"Glorious Label\""
3561635612
}
3561735613
}
3561835614
},

‎descriptions/api.github.com/api.github.com.yaml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 0.0.3
4+
version: 0.0.4
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -25556,9 +25556,6 @@ paths:
2555625556
description:
2555725557
type: string
2555825558
description: A short description of the label.
25559-
name:
25560-
type: string
25561-
example: '"Glorious Label"'
2556225559
example:
2556325560
new_name: 'bug :bug:'
2556425561
description: Small bug fix required

‎descriptions/api.github.com/dereferenced/api.github.com.deref.json‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -237272,10 +237272,6 @@
237272237272
"description": {
237273237273
"type": "string",
237274237274
"description": "A short description of the label."
237275-
},
237276-
"name": {
237277-
"type": "string",
237278-
"example": "\"Glorious Label\""
237279237275
}
237280237276
}
237281237277
},

‎descriptions/api.github.com/dereferenced/api.github.com.deref.yaml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 0.0.3
4+
version: 0.0.4
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -182569,9 +182569,6 @@ paths:
182569182569
description:
182570182570
type: string
182571182571
description: A short description of the label.
182572-
name:
182573-
type: string
182574-
example: '"Glorious Label"'
182575182572
example:
182576182573
new_name: 'bug :bug:'
182577182574
description: Small bug fix required

‎descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -130,11 +130,15 @@
130130
],
131131
"servers": [
132132
{
133-
"url": "http://{hostname}",
133+
"url": "{protocol}://{hostname}",
134134
"variables": {
135135
"hostname": {
136136
"description": "Self-hosted Enterprise Server or Enterprise Cloud hostname",
137137
"default": "HOSTNAME"
138+
},
139+
"protocol": {
140+
"description": "Self-hosted Enterprise Server or Enterprise Cloud protocol",
141+
"default": "http"
138142
}
139143
}
140144
}

‎descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 0.0.3
4+
version: 0.0.4
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -69,11 +69,14 @@ tags:
6969
- name: users
7070
description: Interact with and view information about users and also current user.
7171
servers:
72-
- url: http://{hostname}
72+
- url: "{protocol}://{hostname}"
7373
variables:
7474
hostname:
7575
description: Self-hosted Enterprise Server or Enterprise Cloud hostname
7676
default: HOSTNAME
77+
protocol:
78+
description: Self-hosted Enterprise Server or Enterprise Cloud protocol
79+
default: http
7780
externalDocs:
7881
description: GitHub Enterprise Developer Docs
7982
url: https://developer.github.com/enterprise/2.18/v3/

‎descriptions/ghes-2.18/ghes-2.18.json‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -130,11 +130,15 @@
130130
],
131131
"servers": [
132132
{
133-
"url": "http://{hostname}",
133+
"url": "{protocol}://{hostname}",
134134
"variables": {
135135
"hostname": {
136136
"description": "Self-hosted Enterprise Server or Enterprise Cloud hostname",
137137
"default": "HOSTNAME"
138+
},
139+
"protocol": {
140+
"description": "Self-hosted Enterprise Server or Enterprise Cloud protocol",
141+
"default": "http"
138142
}
139143
}
140144
}

‎descriptions/ghes-2.18/ghes-2.18.yaml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 0.0.3
4+
version: 0.0.4
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -69,11 +69,14 @@ tags:
6969
- name: users
7070
description: Interact with and view information about users and also current user.
7171
servers:
72-
- url: http://{hostname}
72+
- url: "{protocol}://{hostname}"
7373
variables:
7474
hostname:
7575
description: Self-hosted Enterprise Server or Enterprise Cloud hostname
7676
default: HOSTNAME
77+
protocol:
78+
description: Self-hosted Enterprise Server or Enterprise Cloud protocol
79+
default: http
7780
externalDocs:
7881
description: GitHub Enterprise Developer Docs
7982
url: https://developer.github.com/enterprise/2.18/v3/

‎descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -130,11 +130,15 @@
130130
],
131131
"servers": [
132132
{
133-
"url": "http://{hostname}",
133+
"url": "{protocol}://{hostname}",
134134
"variables": {
135135
"hostname": {
136136
"description": "Self-hosted Enterprise Server or Enterprise Cloud hostname",
137137
"default": "HOSTNAME"
138+
},
139+
"protocol": {
140+
"description": "Self-hosted Enterprise Server or Enterprise Cloud protocol",
141+
"default": "http"
138142
}
139143
}
140144
}
@@ -195559,10 +195563,6 @@
195559195563
"description": {
195560195564
"type": "string",
195561195565
"description": "A short description of the label."
195562-
},
195563-
"name": {
195564-
"type": "string",
195565-
"example": "\"Glorious Label\""
195566195566
}
195567195567
}
195568195568
},

‎descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 0.0.3
4+
version: 0.0.4
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -69,11 +69,14 @@ tags:
6969
- name: users
7070
description: Interact with and view information about users and also current user.
7171
servers:
72-
- url: http://{hostname}
72+
- url: "{protocol}://{hostname}"
7373
variables:
7474
hostname:
7575
description: Self-hosted Enterprise Server or Enterprise Cloud hostname
7676
default: HOSTNAME
77+
protocol:
78+
description: Self-hosted Enterprise Server or Enterprise Cloud protocol
79+
default: http
7780
externalDocs:
7881
description: GitHub Enterprise Developer Docs
7982
url: https://developer.github.com/enterprise/2.19/v3/
@@ -150812,9 +150815,6 @@ paths:
150812150815
description:
150813150816
type: string
150814150817
description: A short description of the label.
150815-
name:
150816-
type: string
150817-
example: '"Glorious Label"'
150818150818
example:
150819150819
new_name: 'bug :bug:'
150820150820
description: Small bug fix required

0 commit comments

Comments
 (0)