Skip to content

Commit 4649d1a

Browse files
octokitbotoctokitbot
authored
fix: improved response types (#28)
1 parent 228a34b commit 4649d1a

File tree

3 files changed

+62
-271
lines changed

3 files changed

+62
-271
lines changed

‎cache/openapi-schema.json‎

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "2.4.1",
4+
"version": "2.4.2",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -5412,8 +5412,11 @@
54125412
},
54135413
"members_can_create_pages": {
54145414
"type": "boolean",
5415-
"description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. \nDefault: `true`. "
5415+
"description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. \nDefault: `true`. ",
5416+
"default": true
54165417
},
5418+
"members_can_create_public_pages": { "type": "boolean" },
5419+
"members_can_create_private_pages": { "type": "boolean" },
54175420
"blog": {
54185421
"type": "string",
54195422
"example": "\"http://github.blog\""
@@ -16511,15 +16514,18 @@
1651116514
},
1651216515
"summary": {
1651316516
"type": "string",
16517+
"maxLength": 65535,
1651416518
"description": "The summary of the check run. This parameter supports Markdown."
1651516519
},
1651616520
"text": {
1651716521
"type": "string",
16522+
"maxLength": 65535,
1651816523
"description": "The details of the check run. This parameter supports Markdown."
1651916524
},
1652016525
"annotations": {
1652116526
"type": "array",
1652216527
"description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** 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 [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
16528+
"maxItems": 50,
1652316529
"items": {
1652416530
"type": "object",
1652516531
"properties": {
@@ -16598,27 +16604,44 @@
1659816604
"actions": {
1659916605
"type": "array",
1660016606
"description": "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 [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"",
16607+
"maxItems": 3,
1660116608
"items": {
1660216609
"type": "object",
1660316610
"properties": {
1660416611
"label": {
1660516612
"type": "string",
16613+
"maxLength": 20,
1660616614
"description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
1660716615
},
1660816616
"description": {
1660916617
"type": "string",
16618+
"maxLength": 40,
1661016619
"description": "A short explanation of what this action would do. The maximum size is 40 characters."
1661116620
},
1661216621
"identifier": {
1661316622
"type": "string",
16623+
"maxLength": 20,
1661416624
"description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
1661516625
}
1661616626
},
1661716627
"required": ["label", "description", "identifier"]
1661816628
}
1661916629
}
1662016630
},
16621-
"required": ["name", "head_sha"]
16631+
"required": ["name", "head_sha"],
16632+
"anyOf": [
16633+
{
16634+
"properties": { "status": { "enum": ["completed"] } },
16635+
"required": ["conclusion"],
16636+
"additionalProperties": true
16637+
},
16638+
{
16639+
"properties": {
16640+
"status": { "enum": ["queued", "in_progress"] }
16641+
},
16642+
"additionalProperties": true
16643+
}
16644+
]
1662216645
},
1662316646
"examples": {
1662416647
"example-of-in-progress-conclusion": {
@@ -16822,15 +16845,18 @@
1682216845
},
1682316846
"summary": {
1682416847
"type": "string",
16825-
"description": "Can contain Markdown."
16848+
"description": "Can contain Markdown.",
16849+
"maxLength": 65535
1682616850
},
1682716851
"text": {
1682816852
"type": "string",
16829-
"description": "Can contain Markdown."
16853+
"description": "Can contain Markdown.",
16854+
"maxLength": 65535
1683016855
},
1683116856
"annotations": {
1683216857
"type": "array",
1683316858
"description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. 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 [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.",
16859+
"maxItems": 50,
1683416860
"items": {
1683516861
"type": "object",
1683616862
"properties": {
@@ -16909,26 +16935,43 @@
1690916935
"actions": {
1691016936
"type": "array",
1691116937
"description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"",
16938+
"maxItems": 3,
1691216939
"items": {
1691316940
"type": "object",
1691416941
"properties": {
1691516942
"label": {
1691616943
"type": "string",
16944+
"maxLength": 20,
1691716945
"description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
1691816946
},
1691916947
"description": {
1692016948
"type": "string",
16949+
"maxLength": 40,
1692116950
"description": "A short explanation of what this action would do. The maximum size is 40 characters."
1692216951
},
1692316952
"identifier": {
1692416953
"type": "string",
16954+
"maxLength": 20,
1692516955
"description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
1692616956
}
1692716957
},
1692816958
"required": ["label", "description", "identifier"]
1692916959
}
1693016960
}
16931-
}
16961+
},
16962+
"anyOf": [
16963+
{
16964+
"properties": { "status": { "enum": ["completed"] } },
16965+
"required": ["conclusion"],
16966+
"additionalProperties": true
16967+
},
16968+
{
16969+
"properties": {
16970+
"status": { "enum": ["queued", "in_progress"] }
16971+
},
16972+
"additionalProperties": true
16973+
}
16974+
]
1693216975
},
1693316976
"example": {
1693416977
"name": "mighty_readme",
@@ -26528,6 +26571,7 @@
2652826571
"application/json": {
2652926572
"schema": {
2653026573
"type": "object",
26574+
"nullable": true,
2653126575
"properties": {
2653226576
"commit_title": {
2653326577
"type": "string",
@@ -27285,6 +27329,7 @@
2728527329
"application/json": {
2728627330
"schema": {
2728727331
"type": "object",
27332+
"nullable": true,
2728827333
"properties": {
2728927334
"expected_head_sha": {
2729027335
"type": "string",

0 commit comments

Comments
 (0)