Skip to content

Commit e249684

Browse files
docs-botsabrowning1
docs-bot
and
sabrowning1
authored
Update OpenAPI Description (#58655)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
1 parent dfa5a1f commit e249684

File tree

7 files changed

+28
-1400
lines changed

7 files changed

+28
-1400
lines changed

‎src/rest/data/fpt-2022-11-28/schema.json‎

Lines changed: 4 additions & 200 deletions
Original file line numberDiff line numberDiff line change
@@ -145984,209 +145984,13 @@
145984145984
],
145985145985
"bodyParameters": [
145986145986
{
145987-
"type": "string",
145988-
"name": "name",
145989-
"in": "body",
145990-
"description": "<p>The name of the check. For example, \"code-coverage\".</p>",
145991-
"isRequired": true
145992-
},
145993-
{
145994-
"type": "string",
145995-
"name": "head_sha",
145996-
"in": "body",
145997-
"description": "<p>The SHA of the commit.</p>",
145998-
"isRequired": true
145999-
},
146000-
{
146001-
"type": "string",
146002-
"name": "details_url",
146003-
"in": "body",
146004-
"description": "<p>The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.</p>"
146005-
},
146006-
{
146007-
"type": "string",
146008-
"name": "external_id",
146009-
"in": "body",
146010-
"description": "<p>A reference for the run on the integrator's system.</p>"
146011-
},
146012-
{
146013-
"type": "string",
145987+
"type": "",
146014145988
"name": "status",
146015145989
"in": "body",
146016-
"description": "<p>The current status of the check run. Only GitHub Actions can set a status of <code>waiting</code>, <code>pending</code>, or <code>requested</code>.</p>",
146017-
"enum": [
146018-
"queued",
146019-
"in_progress",
146020-
"completed",
146021-
"waiting",
146022-
"requested",
146023-
"pending"
146024-
],
146025-
"default": "queued"
146026-
},
146027-
{
146028-
"type": "string",
146029-
"name": "started_at",
146030-
"in": "body",
146031-
"description": "<p>The time that the check run began. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
146032-
},
146033-
{
146034-
"type": "string",
146035-
"name": "conclusion",
146036-
"in": "body",
146037-
"description": "<p><strong>Required if you provide <code>completed_at</code> or a <code>status</code> of <code>completed</code></strong>. The final conclusion of the check.\n<strong>Note:</strong> Providing <code>conclusion</code> will automatically set the <code>status</code> parameter to <code>completed</code>. You cannot change a check run conclusion to <code>stale</code>, only GitHub can set this.</p>",
145990+
"description": "",
145991+
"isRequired": true,
146038145992
"enum": [
146039-
"action_required",
146040-
"cancelled",
146041-
"failure",
146042-
"neutral",
146043-
"success",
146044-
"skipped",
146045-
"stale",
146046-
"timed_out"
146047-
]
146048-
},
146049-
{
146050-
"type": "string",
146051-
"name": "completed_at",
146052-
"in": "body",
146053-
"description": "<p>The time the check completed. This is a timestamp in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>"
146054-
},
146055-
{
146056-
"type": "object",
146057-
"name": "output",
146058-
"in": "body",
146059-
"description": "<p>Check runs can accept a variety of data in the <code>output</code> object, including a <code>title</code> and <code>summary</code> and can optionally provide descriptive details about the run.</p>",
146060-
"childParamsGroups": [
146061-
{
146062-
"type": "string",
146063-
"name": "title",
146064-
"description": "<p>The title of the check run.</p>",
146065-
"isRequired": true
146066-
},
146067-
{
146068-
"type": "string",
146069-
"name": "summary",
146070-
"description": "<p>The summary of the check run. This parameter supports Markdown. <strong>Maximum length</strong>: 65535 characters.</p>",
146071-
"isRequired": true
146072-
},
146073-
{
146074-
"type": "string",
146075-
"name": "text",
146076-
"description": "<p>The details of the check run. This parameter supports Markdown. <strong>Maximum length</strong>: 65535 characters.</p>"
146077-
},
146078-
{
146079-
"type": "array of objects",
146080-
"name": "annotations",
146081-
"description": "<p>Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the <strong>Checks</strong> and <strong>Files changed</strong> tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the <a href=\"https://docs.github.com/rest/checks/runs#update-a-check-run\">Update a check run</a> endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"<a href=\"https://docs.github.com/articles/about-status-checks#checks\">About status checks</a>\".</p>",
146082-
"childParamsGroups": [
146083-
{
146084-
"type": "string",
146085-
"name": "path",
146086-
"description": "<p>The path of the file to add an annotation to. For example, <code>assets/css/main.css</code>.</p>",
146087-
"isRequired": true
146088-
},
146089-
{
146090-
"type": "integer",
146091-
"name": "start_line",
146092-
"description": "<p>The start line of the annotation. Line numbers start at 1.</p>",
146093-
"isRequired": true
146094-
},
146095-
{
146096-
"type": "integer",
146097-
"name": "end_line",
146098-
"description": "<p>The end line of the annotation.</p>",
146099-
"isRequired": true
146100-
},
146101-
{
146102-
"type": "integer",
146103-
"name": "start_column",
146104-
"description": "<p>The start column of the annotation. Annotations only support <code>start_column</code> and <code>end_column</code> on the same line. Omit this parameter if <code>start_line</code> and <code>end_line</code> have different values. Column numbers start at 1.</p>"
146105-
},
146106-
{
146107-
"type": "integer",
146108-
"name": "end_column",
146109-
"description": "<p>The end column of the annotation. Annotations only support <code>start_column</code> and <code>end_column</code> on the same line. Omit this parameter if <code>start_line</code> and <code>end_line</code> have different values.</p>"
146110-
},
146111-
{
146112-
"type": "string",
146113-
"name": "annotation_level",
146114-
"description": "<p>The level of the annotation.</p>",
146115-
"isRequired": true,
146116-
"enum": [
146117-
"notice",
146118-
"warning",
146119-
"failure"
146120-
]
146121-
},
146122-
{
146123-
"type": "string",
146124-
"name": "message",
146125-
"description": "<p>A short description of the feedback for these lines of code. The maximum size is 64 KB.</p>",
146126-
"isRequired": true
146127-
},
146128-
{
146129-
"type": "string",
146130-
"name": "title",
146131-
"description": "<p>The title that represents the annotation. The maximum size is 255 characters.</p>"
146132-
},
146133-
{
146134-
"type": "string",
146135-
"name": "raw_details",
146136-
"description": "<p>Details about this annotation. The maximum size is 64 KB.</p>"
146137-
}
146138-
]
146139-
},
146140-
{
146141-
"type": "array of objects",
146142-
"name": "images",
146143-
"description": "<p>Adds images to the output displayed in the GitHub pull request UI.</p>",
146144-
"childParamsGroups": [
146145-
{
146146-
"type": "string",
146147-
"name": "alt",
146148-
"description": "<p>The alternative text for the image.</p>",
146149-
"isRequired": true
146150-
},
146151-
{
146152-
"type": "string",
146153-
"name": "image_url",
146154-
"description": "<p>The full URL of the image.</p>",
146155-
"isRequired": true
146156-
},
146157-
{
146158-
"type": "string",
146159-
"name": "caption",
146160-
"description": "<p>A short image description.</p>"
146161-
}
146162-
]
146163-
}
146164-
]
146165-
},
146166-
{
146167-
"type": "array of objects",
146168-
"name": "actions",
146169-
"in": "body",
146170-
"description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
146171-
"childParamsGroups": [
146172-
{
146173-
"type": "string",
146174-
"name": "label",
146175-
"description": "<p>The text to be displayed on a button in the web UI. The maximum size is 20 characters.</p>",
146176-
"isRequired": true
146177-
},
146178-
{
146179-
"type": "string",
146180-
"name": "description",
146181-
"description": "<p>A short explanation of what this action would do. The maximum size is 40 characters.</p>",
146182-
"isRequired": true
146183-
},
146184-
{
146185-
"type": "string",
146186-
"name": "identifier",
146187-
"description": "<p>A reference for the action on the integrator's system. The maximum size is 20 characters.</p>",
146188-
"isRequired": true
146189-
}
145993+
"completed"
146190145994
]
146191145995
}
146192145996
],

0 commit comments

Comments
 (0)