Skip to content

Commit 4b08885

Browse files
ahoglundahoglund
authored
Merge pull request #660 from github/openapi-update-f7f7b3e5d1cfb30f41020c684e2e5ee7641448beced766018bfe2543c34d55a4
Update OpenAPI Descriptions
2 parents d758b1b + f8c056c commit 4b08885

20 files changed

+449
-118
lines changed

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

Lines changed: 78 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -41216,17 +41216,7 @@
4121641216
"type": "string"
4121741217
},
4121841218
"value": {
41219-
"oneOf": [
41220-
{
41221-
"type": "string"
41222-
},
41223-
{
41224-
"type": "object"
41225-
},
41226-
{
41227-
"type": "array"
41228-
}
41229-
]
41219+
"description": "Can be any value - string, number, array or object."
4123041220
}
4123141221
},
4123241222
"required": [
@@ -55009,10 +54999,16 @@
5500954999
"type": "string"
5501055000
},
5501155001
"config": {
55012-
"type": "array"
55002+
"type": "array",
55003+
"items": {
55004+
"type": "object"
55005+
}
5501355006
},
5501455007
"config_was": {
55015-
"type": "array"
55008+
"type": "array",
55009+
"items": {
55010+
"type": "object"
55011+
}
5501655012
},
5501755013
"content_type": {
5501855014
"type": "string"
@@ -55032,10 +55028,16 @@
5503255028
"type": "string"
5503355029
},
5503455030
"events": {
55035-
"type": "array"
55031+
"type": "array",
55032+
"items": {
55033+
"type": "object"
55034+
}
5503655035
},
5503755036
"events_were": {
55038-
"type": "array"
55037+
"type": "array",
55038+
"items": {
55039+
"type": "object"
55040+
}
5503955041
},
5504055042
"explanation": {
5504155043
"type": "string"
@@ -60304,7 +60306,10 @@
6030460306
"title": "Container Metadata",
6030560307
"properties": {
6030660308
"tags": {
60307-
"type": "array"
60309+
"type": "array",
60310+
"items": {
60311+
"type": "string"
60312+
}
6030860313
}
6030960314
},
6031060315
"required": [
@@ -60316,7 +60321,10 @@
6031660321
"title": "Docker Metadata",
6031760322
"properties": {
6031860323
"tag": {
60319-
"type": "array"
60324+
"type": "array",
60325+
"items": {
60326+
"type": "string"
60327+
}
6032060328
}
6032160329
},
6032260330
"required": [
@@ -64736,6 +64744,7 @@
6473664744
"$ref": "#/components/schemas/nullable-integration"
6473764745
},
6473864746
"pull_requests": {
64747+
"type": "array",
6473964748
"items": {
6474064749
"$ref": "#/components/schemas/pull-request-minimal"
6474164750
}
@@ -65565,7 +65574,7 @@
6556565574
}
6556665575
}
6556765576
},
65568-
"codespace-machine": {
65577+
"nullable-codespace-machine": {
6556965578
"type": "object",
6557065579
"title": "Codespace machine",
6557165580
"description": "A description of the machine powering a codespace.",
@@ -65608,7 +65617,8 @@
6560865617
"storage_in_bytes",
6560965618
"memory_in_bytes",
6561065619
"cpus"
65611-
]
65620+
],
65621+
"nullable": true
6561265622
},
6561365623
"codespace": {
6561465624
"type": "object",
@@ -65640,7 +65650,7 @@
6564065650
"$ref": "#/components/schemas/minimal-repository"
6564165651
},
6564265652
"machine": {
65643-
"$ref": "#/components/schemas/codespace-machine"
65653+
"$ref": "#/components/schemas/nullable-codespace-machine"
6564465654
},
6564565655
"created_at": {
6564665656
"type": "string",
@@ -65790,6 +65800,51 @@
6579065800
"recent_folders"
6579165801
]
6579265802
},
65803+
"codespace-machine": {
65804+
"type": "object",
65805+
"title": "Codespace machine",
65806+
"description": "A description of the machine powering a codespace.",
65807+
"properties": {
65808+
"name": {
65809+
"type": "string",
65810+
"description": "The name of the machine.",
65811+
"example": "standardLinux"
65812+
},
65813+
"display_name": {
65814+
"type": "string",
65815+
"description": "The display name of the machine includes cores, memory, and storage.",
65816+
"example": "4 cores, 8 GB RAM, 64 GB storage"
65817+
},
65818+
"operating_system": {
65819+
"type": "string",
65820+
"description": "The operating system of the machine.",
65821+
"example": "linux"
65822+
},
65823+
"storage_in_bytes": {
65824+
"type": "integer",
65825+
"description": "How much storage is available to the codespace.",
65826+
"example": 68719476736
65827+
},
65828+
"memory_in_bytes": {
65829+
"type": "integer",
65830+
"description": "How much memory is available to the codespace.",
65831+
"example": 8589934592
65832+
},
65833+
"cpus": {
65834+
"type": "integer",
65835+
"description": "How many cores are available to the codespace.",
65836+
"example": 4
65837+
}
65838+
},
65839+
"required": [
65840+
"name",
65841+
"display_name",
65842+
"operating_system",
65843+
"storage_in_bytes",
65844+
"memory_in_bytes",
65845+
"cpus"
65846+
]
65847+
},
6579365848
"collaborator": {
6579465849
"title": "Collaborator",
6579565850
"description": "Collaborator",
@@ -71468,6 +71523,9 @@
7146871523
},
7146971524
"domains": {
7147071525
"type": "array",
71526+
"items": {
71527+
"type": "string"
71528+
},
7147171529
"description": "Array of the domain set and its alternate name (if it is configured)",
7147271530
"example": [
7147371531
"example.com",

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

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29482,10 +29482,7 @@ paths:
2948229482
path:
2948329483
type: string
2948429484
value:
29485-
oneOf:
29486-
- type: string
29487-
- type: object
29488-
- type: array
29485+
description: Can be any value - string, number, array or object.
2948929486
required:
2949029487
- op
2949129488
required:
@@ -39684,8 +39681,12 @@ components:
3968439681
type: string
3968539682
config:
3968639683
type: array
39684+
items:
39685+
type: object
3968739686
config_was:
3968839687
type: array
39688+
items:
39689+
type: object
3968939690
content_type:
3969039691
type: string
3969139692
created_at:
@@ -39701,8 +39702,12 @@ components:
3970139702
type: string
3970239703
events:
3970339704
type: array
39705+
items:
39706+
type: object
3970439707
events_were:
3970539708
type: array
39709+
items:
39710+
type: object
3970639711
explanation:
3970739712
type: string
3970839713
fingerprint:
@@ -43735,6 +43740,8 @@ components:
4373543740
properties:
4373643741
tags:
4373743742
type: array
43743+
items:
43744+
type: string
4373843745
required:
4373943746
- tags
4374043747
docker:
@@ -43743,6 +43750,8 @@ components:
4374343750
properties:
4374443751
tag:
4374543752
type: array
43753+
items:
43754+
type: string
4374643755
required:
4374743756
- tags
4374843757
required:
@@ -47137,6 +47146,7 @@ components:
4713747146
app:
4713847147
"$ref": "#/components/schemas/nullable-integration"
4713947148
pull_requests:
47149+
type: array
4714047150
items:
4714147151
"$ref": "#/components/schemas/pull-request-minimal"
4714247152
deployment:
@@ -47786,7 +47796,7 @@ components:
4778647796
format: uri
4778747797
readOnly: true
4778847798
nullable: true
47789-
codespace-machine:
47799+
nullable-codespace-machine:
4779047800
type: object
4779147801
title: Codespace machine
4779247802
description: A description of the machine powering a codespace.
@@ -47823,6 +47833,7 @@ components:
4782347833
- storage_in_bytes
4782447834
- memory_in_bytes
4782547835
- cpus
47836+
nullable: true
4782647837
codespace:
4782747838
type: object
4782847839
title: Codespace
@@ -47847,7 +47858,7 @@ components:
4784747858
repository:
4784847859
"$ref": "#/components/schemas/minimal-repository"
4784947860
machine:
47850-
"$ref": "#/components/schemas/codespace-machine"
47861+
"$ref": "#/components/schemas/nullable-codespace-machine"
4785147862
created_at:
4785247863
type: string
4785347864
format: date-time
@@ -47976,6 +47987,43 @@ components:
4797647987
- stop_url
4797747988
- pulls_url
4797847989
- recent_folders
47990+
codespace-machine:
47991+
type: object
47992+
title: Codespace machine
47993+
description: A description of the machine powering a codespace.
47994+
properties:
47995+
name:
47996+
type: string
47997+
description: The name of the machine.
47998+
example: standardLinux
47999+
display_name:
48000+
type: string
48001+
description: The display name of the machine includes cores, memory, and
48002+
storage.
48003+
example: 4 cores, 8 GB RAM, 64 GB storage
48004+
operating_system:
48005+
type: string
48006+
description: The operating system of the machine.
48007+
example: linux
48008+
storage_in_bytes:
48009+
type: integer
48010+
description: How much storage is available to the codespace.
48011+
example: 68719476736
48012+
memory_in_bytes:
48013+
type: integer
48014+
description: How much memory is available to the codespace.
48015+
example: 8589934592
48016+
cpus:
48017+
type: integer
48018+
description: How many cores are available to the codespace.
48019+
example: 4
48020+
required:
48021+
- name
48022+
- display_name
48023+
- operating_system
48024+
- storage_in_bytes
48025+
- memory_in_bytes
48026+
- cpus
4797948027
collaborator:
4798048028
title: Collaborator
4798148029
description: Collaborator
@@ -52220,6 +52268,8 @@ components:
5222052268
example: Certificate is approved
5222152269
domains:
5222252270
type: array
52271+
items:
52272+
type: string
5222352273
description: Array of the domain set and its alternate name (if it is configured)
5222452274
example:
5222552275
- example.com

0 commit comments

Comments
 (0)