Skip to content

Commit 349e55f

Browse files
ahoglundahoglund
authored
Merge pull request #677 from github/openapi-update-bbbd0f9430a4145cf45104ab47b98d1bf5b03d58ac1fb12d06a92702186aaa4c
change: Add endpoints, add fields to existing responses, Remove false nullables, update descriptions
2 parents 968a842 + 8ad06d4 commit 349e55f

24 files changed

+638036
-4663
lines changed

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

Lines changed: 771 additions & 470 deletions
Large diffs are not rendered by default.

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

Lines changed: 630 additions & 424 deletions
Large diffs are not rendered by default.

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

Lines changed: 3552 additions & 244 deletions
Large diffs are not rendered by default.

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

Lines changed: 3100 additions & 2883 deletions
Large diffs are not rendered by default.

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

Lines changed: 26 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -23058,7 +23058,7 @@
2305823058
"properties": {
2305923059
"announcement": {
2306023060
"type": "string",
23061-
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
23061+
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/[email protected]/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"",
2306223062
"example": "Very **important** announcement about _nothing_."
2306323063
},
2306423064
"expires_at": {
@@ -23111,7 +23111,7 @@
2311123111
"properties": {
2311223112
"announcement": {
2311323113
"type": "string",
23114-
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
23114+
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/[email protected]/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"",
2311523115
"example": "Very **important** announcement about _nothing_."
2311623116
},
2311723117
"expires_at": {
@@ -23141,7 +23141,7 @@
2314123141
"properties": {
2314223142
"announcement": {
2314323143
"type": "string",
23144-
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"",
23144+
"description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/[email protected]/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"",
2314523145
"example": "Very **important** announcement about _nothing_."
2314623146
},
2314723147
"expires_at": {
@@ -154593,36 +154593,31 @@
154593154593
"number": {
154594154594
"type": "integer",
154595154595
"description": "The security alert number.",
154596-
"readOnly": true,
154597-
"nullable": false
154596+
"readOnly": true
154598154597
},
154599154598
"created_at": {
154600154599
"type": "string",
154601154600
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
154602154601
"format": "date-time",
154603-
"readOnly": true,
154604-
"nullable": false
154602+
"readOnly": true
154605154603
},
154606154604
"url": {
154607154605
"type": "string",
154608154606
"description": "The REST API URL of the alert resource.",
154609154607
"format": "uri",
154610-
"readOnly": true,
154611-
"nullable": false
154608+
"readOnly": true
154612154609
},
154613154610
"html_url": {
154614154611
"type": "string",
154615154612
"description": "The GitHub URL of the alert resource.",
154616154613
"format": "uri",
154617-
"readOnly": true,
154618-
"nullable": false
154614+
"readOnly": true
154619154615
},
154620154616
"instances_url": {
154621154617
"type": "string",
154622154618
"description": "The REST API URL for fetching the list of instances for an alert.",
154623154619
"format": "uri",
154624-
"readOnly": true,
154625-
"nullable": false
154620+
"readOnly": true
154626154621
},
154627154622
"state": {
154628154623
"type": "string",
@@ -155149,8 +155144,7 @@
155149155144
"schema": {
155150155145
"type": "integer",
155151155146
"description": "The security alert number.",
155152-
"readOnly": true,
155153-
"nullable": false
155147+
"readOnly": true
155154155148
}
155155155149
}
155156155150
],
@@ -155165,36 +155159,31 @@
155165155159
"number": {
155166155160
"type": "integer",
155167155161
"description": "The security alert number.",
155168-
"readOnly": true,
155169-
"nullable": false
155162+
"readOnly": true
155170155163
},
155171155164
"created_at": {
155172155165
"type": "string",
155173155166
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
155174155167
"format": "date-time",
155175-
"readOnly": true,
155176-
"nullable": false
155168+
"readOnly": true
155177155169
},
155178155170
"url": {
155179155171
"type": "string",
155180155172
"description": "The REST API URL of the alert resource.",
155181155173
"format": "uri",
155182-
"readOnly": true,
155183-
"nullable": false
155174+
"readOnly": true
155184155175
},
155185155176
"html_url": {
155186155177
"type": "string",
155187155178
"description": "The GitHub URL of the alert resource.",
155188155179
"format": "uri",
155189-
"readOnly": true,
155190-
"nullable": false
155180+
"readOnly": true
155191155181
},
155192155182
"instances_url": {
155193155183
"type": "string",
155194155184
"description": "The REST API URL for fetching the list of instances for an alert.",
155195155185
"format": "uri",
155196-
"readOnly": true,
155197-
"nullable": false
155186+
"readOnly": true
155198155187
},
155199155188
"state": {
155200155189
"type": "string",
@@ -155701,8 +155690,7 @@
155701155690
"schema": {
155702155691
"type": "integer",
155703155692
"description": "The security alert number.",
155704-
"readOnly": true,
155705-
"nullable": false
155693+
"readOnly": true
155706155694
}
155707155695
}
155708155696
],
@@ -155755,36 +155743,31 @@
155755155743
"number": {
155756155744
"type": "integer",
155757155745
"description": "The security alert number.",
155758-
"readOnly": true,
155759-
"nullable": false
155746+
"readOnly": true
155760155747
},
155761155748
"created_at": {
155762155749
"type": "string",
155763155750
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
155764155751
"format": "date-time",
155765-
"readOnly": true,
155766-
"nullable": false
155752+
"readOnly": true
155767155753
},
155768155754
"url": {
155769155755
"type": "string",
155770155756
"description": "The REST API URL of the alert resource.",
155771155757
"format": "uri",
155772-
"readOnly": true,
155773-
"nullable": false
155758+
"readOnly": true
155774155759
},
155775155760
"html_url": {
155776155761
"type": "string",
155777155762
"description": "The GitHub URL of the alert resource.",
155778155763
"format": "uri",
155779-
"readOnly": true,
155780-
"nullable": false
155764+
"readOnly": true
155781155765
},
155782155766
"instances_url": {
155783155767
"type": "string",
155784155768
"description": "The REST API URL for fetching the list of instances for an alert.",
155785155769
"format": "uri",
155786-
"readOnly": true,
155787-
"nullable": false
155770+
"readOnly": true
155788155771
},
155789155772
"state": {
155790155773
"type": "string",
@@ -156341,8 +156324,7 @@
156341156324
"schema": {
156342156325
"type": "string",
156343156326
"description": "An identifier for the upload.",
156344-
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
156345-
"nullable": false
156327+
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53"
156346156328
}
156347156329
}
156348156330
],
@@ -156387,8 +156369,7 @@
156387156369
"type": "string",
156388156370
"description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
156389156371
"format": "date-time",
156390-
"readOnly": true,
156391-
"nullable": false
156372+
"readOnly": true
156392156373
},
156393156374
"results_count": {
156394156375
"type": "integer",
@@ -156406,14 +156387,12 @@
156406156387
"type": "string",
156407156388
"description": "The REST API URL of the analysis resource.",
156408156389
"format": "uri",
156409-
"readOnly": true,
156410-
"nullable": false
156390+
"readOnly": true
156411156391
},
156412156392
"sarif_id": {
156413156393
"type": "string",
156414156394
"description": "An identifier for the upload.",
156415-
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
156416-
"nullable": false
156395+
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53"
156417156396
},
156418156397
"tool": {
156419156398
"type": "object",
@@ -156684,15 +156663,13 @@
156684156663
"id": {
156685156664
"type": "string",
156686156665
"description": "An identifier for the upload.",
156687-
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
156688-
"nullable": false
156666+
"example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53"
156689156667
},
156690156668
"url": {
156691156669
"type": "string",
156692156670
"description": "The REST API URL for checking the status of the upload.",
156693156671
"format": "uri",
156694-
"readOnly": true,
156695-
"nullable": false
156672+
"readOnly": true
156696156673
}
156697156674
}
156698156675
},

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

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6876,8 +6876,8 @@ paths:
68766876
announcement:
68776877
type: string
68786878
description: The announcement text in GitHub Flavored Markdown.
6879-
For more information about GitHub Flavored Markdown, see "[Mastering
6880-
markdown](https://guides.github.com/features/mastering-markdown/)."
6879+
For more information about GitHub Flavored Markdown, see "[Basic
6880+
writing and formatting syntax](https://docs.github.com/[email protected]/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."
68816881
example: Very **important** announcement about _nothing_.
68826882
expires_at:
68836883
type: string
@@ -35740,33 +35740,28 @@ paths:
3574035740
type: integer
3574135741
description: The security alert number.
3574235742
readOnly: true
35743-
nullable: false
3574435743
created_at:
3574535744
type: string
3574635745
description: 'The time that the alert was created in ISO 8601
3574735746
format: `YYYY-MM-DDTHH:MM:SSZ`.'
3574835747
format: date-time
3574935748
readOnly: true
35750-
nullable: false
3575135749
url:
3575235750
type: string
3575335751
description: The REST API URL of the alert resource.
3575435752
format: uri
3575535753
readOnly: true
35756-
nullable: false
3575735754
html_url:
3575835755
type: string
3575935756
description: The GitHub URL of the alert resource.
3576035757
format: uri
3576135758
readOnly: true
35762-
nullable: false
3576335759
instances_url:
3576435760
type: string
3576535761
description: The REST API URL for fetching the list of instances
3576635762
for an alert.
3576735763
format: uri
3576835764
readOnly: true
35769-
nullable: false
3577035765
state:
3577135766
type: string
3577235767
description: State of a code scanning alert.
@@ -36060,7 +36055,6 @@ paths:
3606036055
type: integer
3606136056
description: The security alert number.
3606236057
readOnly: true
36063-
nullable: false
3606436058
responses:
3606536059
'200':
3606636060
description: Response
@@ -36073,33 +36067,28 @@ paths:
3607336067
type: integer
3607436068
description: The security alert number.
3607536069
readOnly: true
36076-
nullable: false
3607736070
created_at:
3607836071
type: string
3607936072
description: 'The time that the alert was created in ISO 8601
3608036073
format: `YYYY-MM-DDTHH:MM:SSZ`.'
3608136074
format: date-time
3608236075
readOnly: true
36083-
nullable: false
3608436076
url:
3608536077
type: string
3608636078
description: The REST API URL of the alert resource.
3608736079
format: uri
3608836080
readOnly: true
36089-
nullable: false
3609036081
html_url:
3609136082
type: string
3609236083
description: The GitHub URL of the alert resource.
3609336084
format: uri
3609436085
readOnly: true
36095-
nullable: false
3609636086
instances_url:
3609736087
type: string
3609836088
description: The REST API URL for fetching the list of instances
3609936089
for an alert.
3610036090
format: uri
3610136091
readOnly: true
36102-
nullable: false
3610336092
state:
3610436093
type: string
3610536094
description: State of a code scanning alert.
@@ -36498,7 +36487,6 @@ paths:
3649836487
type: string
3649936488
description: An identifier for the upload.
3650036489
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
36501-
nullable: false
3650236490
responses:
3650336491
'200':
3650436492
description: Response
@@ -36545,7 +36533,6 @@ paths:
3654536533
8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
3654636534
format: date-time
3654736535
readOnly: true
36548-
nullable: false
3654936536
results_count:
3655036537
type: integer
3655136538
description: The total number of results in the analysis.
@@ -36560,12 +36547,10 @@ paths:
3656036547
description: The REST API URL of the analysis resource.
3656136548
format: uri
3656236549
readOnly: true
36563-
nullable: false
3656436550
sarif_id:
3656536551
type: string
3656636552
description: An identifier for the upload.
3656736553
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
36568-
nullable: false
3656936554
tool:
3657036555
type: object
3657136556
properties: *266
@@ -36742,13 +36727,11 @@ paths:
3674236727
type: string
3674336728
description: An identifier for the upload.
3674436729
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
36745-
nullable: false
3674636730
url:
3674736731
type: string
3674836732
description: The REST API URL for checking the status of the upload.
3674936733
format: uri
3675036734
readOnly: true
36751-
nullable: false
3675236735
examples:
3675336736
default:
3675436737
summary: Default response

0 commit comments

Comments
 (0)