Skip to content

Commit

Permalink
Update OpenAPI Descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed May 14, 2021
1 parent bc70067 commit b32907b
Show file tree
Hide file tree
Showing 36 changed files with 888 additions and 355 deletions.
23 changes: 17 additions & 6 deletions descriptions/api.github.com/api.github.com.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16315,7 +16315,7 @@
},
"post": {
"summary": "Create a project card",
"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.",
"description": "",
"tags": [
"projects"
],
Expand Down Expand Up @@ -22914,6 +22914,7 @@
},
"started_at": {
"type": "string",
"format": "date-time",
"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`."
},
"conclusion": {
Expand All @@ -22932,6 +22933,7 @@
},
"completed_at": {
"type": "string",
"format": "date-time",
"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`."
},
"output": {
Expand Down Expand Up @@ -23293,6 +23295,7 @@
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
},
"status": {
Expand Down Expand Up @@ -23320,6 +23323,7 @@
},
"completed_at": {
"type": "string",
"format": "date-time",
"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`."
},
"output": {
Expand Down Expand Up @@ -24565,7 +24569,7 @@
},
"started_at": {
"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`.",
"format": "date",
"format": "date-time",
"type": "string"
},
"tool_name": {
Expand Down Expand Up @@ -25525,7 +25529,8 @@
"in": "query",
"required": false,
"schema": {
"type": "string"
"type": "string",
"format": "date-time"
}
},
{
Expand Down Expand Up @@ -28374,6 +28379,7 @@
},
"date": {
"type": "string",
"format": "date-time",
"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`."
}
},
Expand All @@ -28396,6 +28402,7 @@
},
"date": {
"type": "string",
"format": "date-time",
"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`."
}
}
Expand Down Expand Up @@ -28941,6 +28948,7 @@
},
"date": {
"type": "string",
"format": "date-time",
"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`."
}
},
Expand Down Expand Up @@ -34638,6 +34646,7 @@
"properties": {
"last_read_at": {
"type": "string",
"format": "date-time",
"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."
}
}
Expand Down Expand Up @@ -62675,7 +62684,7 @@
},
"code-scanning-analysis-category": {
"type": "string",
"description": "Identifies the configuration and environment under which the analysis was executed."
"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."
},
"code-scanning-analysis-created-at": {
"type": "string",
Expand Down Expand Up @@ -91770,7 +91779,8 @@
"in": "query",
"required": false,
"schema": {
"type": "string"
"type": "string",
"format": "date-time"
}
},
"installation_id": {
Expand Down Expand Up @@ -92030,7 +92040,8 @@
"in": "query",
"required": false,
"schema": {
"type": "string"
"type": "string",
"format": "date-time"
}
},
"thread_id": {
Expand Down
23 changes: 16 additions & 7 deletions descriptions/api.github.com/api.github.com.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11635,10 +11635,7 @@ paths:
subcategory: cards
post:
summary: Create a project card
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.

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.
description: ''
tags:
- projects
operationId: projects/create-card
Expand Down Expand Up @@ -16310,6 +16307,7 @@ paths:
default: queued
started_at:
type: string
format: date-time
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`.'
Expand All @@ -16334,6 +16332,7 @@ paths:
- timed_out
completed_at:
type: string
format: date-time
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`.'
Expand Down Expand Up @@ -16635,6 +16634,7 @@ paths:
description: A reference for the run on the integrator's system.
started_at:
type: string
format: date-time
description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format: `YYYY-MM-DDTHH:MM:SSZ`.'
status:
Expand Down Expand Up @@ -16665,6 +16665,7 @@ paths:
- timed_out
completed_at:
type: string
format: date-time
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`.'
Expand Down Expand Up @@ -17649,7 +17650,7 @@ paths:
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`.'
format: date
format: date-time
type: string
tool_name:
description: The name of the tool used to generate the code scanning
Expand Down Expand Up @@ -18354,6 +18355,7 @@ paths:
required: false
schema:
type: string
format: date-time
- "$ref": "#/components/parameters/per_page"
- "$ref": "#/components/parameters/page"
responses:
Expand Down Expand Up @@ -20559,6 +20561,7 @@ paths:
description: The email of the author (or committer) of the commit
date:
type: string
format: date-time
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`.'
Expand All @@ -20579,6 +20582,7 @@ paths:
description: The email of the author (or committer) of the commit
date:
type: string
format: date-time
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`.'
Expand Down Expand Up @@ -21029,6 +21033,7 @@ paths:
description: The email of the author of the tag
date:
type: string
format: date-time
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`.'
Expand Down Expand Up @@ -24900,6 +24905,7 @@ paths:
properties:
last_read_at:
type: string
format: date-time
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.
Expand Down Expand Up @@ -45484,8 +45490,9 @@ components:
in which this analysis was performed.
code-scanning-analysis-category:
type: string
description: Identifies the configuration and environment under which the analysis
was executed.
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.
code-scanning-analysis-created-at:
type: string
description: 'The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
Expand Down Expand Up @@ -69807,6 +69814,7 @@ components:
required: false
schema:
type: string
format: date-time
installation_id:
name: installation_id
description: installation_id parameter
Expand Down Expand Up @@ -70027,6 +70035,7 @@ components:
required: false
schema:
type: string
format: date-time
thread_id:
name: thread_id
description: thread_id parameter
Expand Down
Loading

0 comments on commit b32907b

Please sign in to comment.