Skip to content

Commit a4797d3

Browse files
beccobecco
authored
Merge pull request #330 from github/openapi-update-f660612122f98de52ed8967fbe040f4ef7ff4090921ce2466a81d3933cfb07eb
Update OpenAPI Descriptions
2 parents bc70067 + b32907b commit a4797d3

36 files changed

Lines changed: 888 additions & 355 deletions

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

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16315,7 +16315,7 @@
1631516315
},
1631616316
"post": {
1631716317
"summary": "Create a project card",
16318-
"description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
16318+
"description": "",
1631916319
"tags": [
1632016320
"projects"
1632116321
],
@@ -22914,6 +22914,7 @@
2291422914
},
2291522915
"started_at": {
2291622916
"type": "string",
22917+
"format": "date-time",
2291722918
"description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2291822919
},
2291922920
"conclusion": {
@@ -22932,6 +22933,7 @@
2293222933
},
2293322934
"completed_at": {
2293422935
"type": "string",
22936+
"format": "date-time",
2293522937
"description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2293622938
},
2293722939
"output": {
@@ -23293,6 +23295,7 @@
2329323295
},
2329423296
"started_at": {
2329523297
"type": "string",
23298+
"format": "date-time",
2329623299
"description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2329723300
},
2329823301
"status": {
@@ -23320,6 +23323,7 @@
2332023323
},
2332123324
"completed_at": {
2332223325
"type": "string",
23326+
"format": "date-time",
2332323327
"description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2332423328
},
2332523329
"output": {
@@ -24565,7 +24569,7 @@
2456524569
},
2456624570
"started_at": {
2456724571
"description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
24568-
"format": "date",
24572+
"format": "date-time",
2456924573
"type": "string"
2457024574
},
2457124575
"tool_name": {
@@ -25525,7 +25529,8 @@
2552525529
"in": "query",
2552625530
"required": false,
2552725531
"schema": {
25528-
"type": "string"
25532+
"type": "string",
25533+
"format": "date-time"
2552925534
}
2553025535
},
2553125536
{
@@ -28374,6 +28379,7 @@
2837428379
},
2837528380
"date": {
2837628381
"type": "string",
28382+
"format": "date-time",
2837728383
"description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2837828384
}
2837928385
},
@@ -28396,6 +28402,7 @@
2839628402
},
2839728403
"date": {
2839828404
"type": "string",
28405+
"format": "date-time",
2839928406
"description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2840028407
}
2840128408
}
@@ -28941,6 +28948,7 @@
2894128948
},
2894228949
"date": {
2894328950
"type": "string",
28951+
"format": "date-time",
2894428952
"description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
2894528953
}
2894628954
},
@@ -34638,6 +34646,7 @@
3463834646
"properties": {
3463934647
"last_read_at": {
3464034648
"type": "string",
34649+
"format": "date-time",
3464134650
"description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp."
3464234651
}
3464334652
}
@@ -62675,7 +62684,7 @@
6267562684
},
6267662685
"code-scanning-analysis-category": {
6267762686
"type": "string",
62678-
"description": "Identifies the configuration and environment under which the analysis was executed."
62687+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
6267962688
},
6268062689
"code-scanning-analysis-created-at": {
6268162690
"type": "string",
@@ -91770,7 +91779,8 @@
9177091779
"in": "query",
9177191780
"required": false,
9177291781
"schema": {
91773-
"type": "string"
91782+
"type": "string",
91783+
"format": "date-time"
9177491784
}
9177591785
},
9177691786
"installation_id": {
@@ -92030,7 +92040,8 @@
9203092040
"in": "query",
9203192041
"required": false,
9203292042
"schema": {
92033-
"type": "string"
92043+
"type": "string",
92044+
"format": "date-time"
9203492045
}
9203592046
},
9203692047
"thread_id": {

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

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11635,10 +11635,7 @@ paths:
1163511635
subcategory: cards
1163611636
post:
1163711637
summary: Create a project card
11638-
description: |-
11639-
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.
11640-
11641-
Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
11638+
description: ''
1164211639
tags:
1164311640
- projects
1164411641
operationId: projects/create-card
@@ -16310,6 +16307,7 @@ paths:
1631016307
default: queued
1631116308
started_at:
1631216309
type: string
16310+
format: date-time
1631316311
description: 'The time that the check run began. This is a timestamp
1631416312
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
1631516313
`YYYY-MM-DDTHH:MM:SSZ`.'
@@ -16334,6 +16332,7 @@ paths:
1633416332
- timed_out
1633516333
completed_at:
1633616334
type: string
16335+
format: date-time
1633716336
description: 'The time the check completed. This is a timestamp
1633816337
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
1633916338
`YYYY-MM-DDTHH:MM:SSZ`.'
@@ -16635,6 +16634,7 @@ paths:
1663516634
description: A reference for the run on the integrator's system.
1663616635
started_at:
1663716636
type: string
16637+
format: date-time
1663816638
description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
1663916639
format: `YYYY-MM-DDTHH:MM:SSZ`.'
1664016640
status:
@@ -16665,6 +16665,7 @@ paths:
1666516665
- timed_out
1666616666
completed_at:
1666716667
type: string
16668+
format: date-time
1666816669
description: 'The time the check completed. This is a timestamp
1666916670
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
1667016671
`YYYY-MM-DDTHH:MM:SSZ`.'
@@ -17649,7 +17650,7 @@ paths:
1764917650
description: 'The time that the analysis run began. This is a timestamp
1765017651
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
1765117652
`YYYY-MM-DDTHH:MM:SSZ`.'
17652-
format: date
17653+
format: date-time
1765317654
type: string
1765417655
tool_name:
1765517656
description: The name of the tool used to generate the code scanning
@@ -18354,6 +18355,7 @@ paths:
1835418355
required: false
1835518356
schema:
1835618357
type: string
18358+
format: date-time
1835718359
- "$ref": "#/components/parameters/per_page"
1835818360
- "$ref": "#/components/parameters/page"
1835918361
responses:
@@ -20559,6 +20561,7 @@ paths:
2055920561
description: The email of the author (or committer) of the commit
2056020562
date:
2056120563
type: string
20564+
format: date-time
2056220565
description: 'Indicates when this commit was authored (or committed).
2056320566
This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
2056420567
format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -20579,6 +20582,7 @@ paths:
2057920582
description: The email of the author (or committer) of the commit
2058020583
date:
2058120584
type: string
20585+
format: date-time
2058220586
description: 'Indicates when this commit was authored (or committed).
2058320587
This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
2058420588
format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -21029,6 +21033,7 @@ paths:
2102921033
description: The email of the author of the tag
2103021034
date:
2103121035
type: string
21036+
format: date-time
2103221037
description: 'When this object was tagged. This is a timestamp
2103321038
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
2103421039
`YYYY-MM-DDTHH:MM:SSZ`.'
@@ -24900,6 +24905,7 @@ paths:
2490024905
properties:
2490124906
last_read_at:
2490224907
type: string
24908+
format: date-time
2490324909
description: 'Describes the last point that notifications were checked.
2490424910
Anything updated since this time will not be marked as read. If
2490524911
you omit this parameter, all notifications are marked as read.
@@ -45484,8 +45490,9 @@ components:
4548445490
in which this analysis was performed.
4548545491
code-scanning-analysis-category:
4548645492
type: string
45487-
description: Identifies the configuration and environment under which the analysis
45488-
was executed.
45493+
description: Identifies the configuration under which the analysis was executed.
45494+
Used to distinguish between multiple analyses for the same tool and commit,
45495+
but performed on different languages or different parts of the code.
4548945496
code-scanning-analysis-created-at:
4549045497
type: string
4549145498
description: 'The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -69807,6 +69814,7 @@ components:
6980769814
required: false
6980869815
schema:
6980969816
type: string
69817+
format: date-time
6981069818
installation_id:
6981169819
name: installation_id
6981269820
description: installation_id parameter
@@ -70027,6 +70035,7 @@ components:
7002770035
required: false
7002870036
schema:
7002970037
type: string
70038+
format: date-time
7003070039
thread_id:
7003170040
name: thread_id
7003270041
description: thread_id parameter

0 commit comments

Comments
 (0)