Skip to content

Commit c5f9f2e

Browse files
author
Marc-Andre Giroux
authored
Merge pull request #63 from github/openapi-update-1.1.2
fix: Update the OpenAPI description to the latest version
2 parents 3ab774f + 0faccd8 commit c5f9f2e

24 files changed

+334
-332
lines changed

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

+23-25
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.1",
4+
"version": "1.1.2",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -57361,22 +57361,24 @@
5736157361
"code-scanning-alert-instances": {
5736257362
"nullable": true,
5736357363
"type": "array",
57364-
"properties": {
57365-
"ref": {
57366-
"$ref": "#/components/schemas/code-scanning-alert-ref"
57367-
},
57368-
"analysis_key": {
57369-
"$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
57370-
},
57371-
"environment": {
57372-
"$ref": "#/components/schemas/code-scanning-alert-environment"
57373-
},
57374-
"matrix_vars": {
57375-
"nullable": true,
57376-
"type": "string"
57377-
},
57378-
"state": {
57379-
"$ref": "#/components/schemas/code-scanning-alert-state"
57364+
"items": {
57365+
"properties": {
57366+
"ref": {
57367+
"$ref": "#/components/schemas/code-scanning-alert-ref"
57368+
},
57369+
"analysis_key": {
57370+
"$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
57371+
},
57372+
"environment": {
57373+
"$ref": "#/components/schemas/code-scanning-alert-environment"
57374+
},
57375+
"matrix_vars": {
57376+
"nullable": true,
57377+
"type": "string"
57378+
},
57379+
"state": {
57380+
"$ref": "#/components/schemas/code-scanning-alert-state"
57381+
}
5738057382
}
5738157383
}
5738257384
},
@@ -73708,15 +73710,13 @@
7370873710
{
7370973711
"ref": "refs/heads/codeql-analysis-yml",
7371073712
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
73711-
"environment": {
73712-
},
73713+
"environment": "",
7371373714
"state": "fixed"
7371473715
},
7371573716
{
7371673717
"ref": "refs/pull/3740/head",
7371773718
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
73718-
"environment": {
73719-
},
73719+
"environment": "",
7372073720
"state": "fixed"
7372173721
}
7372273722
],
@@ -73764,15 +73764,13 @@
7376473764
{
7376573765
"ref": "refs/heads/codeql-analysis-yml",
7376673766
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
73767-
"environment": {
73768-
},
73767+
"environment": "",
7376973768
"state": "dismissed"
7377073769
},
7377173770
{
7377273771
"ref": "refs/pull/3740/head",
7377373772
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
73774-
"environment": {
73775-
},
73773+
"environment": "",
7377673774
"state": "dismissed"
7377773775
}
7377873776
],

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

+18-17
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.1.1
4+
version: 1.1.2
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -41594,18 +41594,19 @@ components:
4159441594
code-scanning-alert-instances:
4159541595
nullable: true
4159641596
type: array
41597-
properties:
41598-
ref:
41599-
"$ref": "#/components/schemas/code-scanning-alert-ref"
41600-
analysis_key:
41601-
"$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
41602-
environment:
41603-
"$ref": "#/components/schemas/code-scanning-alert-environment"
41604-
matrix_vars:
41605-
nullable: true
41606-
type: string
41607-
state:
41608-
"$ref": "#/components/schemas/code-scanning-alert-state"
41597+
items:
41598+
properties:
41599+
ref:
41600+
"$ref": "#/components/schemas/code-scanning-alert-ref"
41601+
analysis_key:
41602+
"$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
41603+
environment:
41604+
"$ref": "#/components/schemas/code-scanning-alert-environment"
41605+
matrix_vars:
41606+
nullable: true
41607+
type: string
41608+
state:
41609+
"$ref": "#/components/schemas/code-scanning-alert-state"
4160941610
code-scanning-alert-code-scanning-alert:
4161041611
type: object
4161141612
properties:
@@ -54820,11 +54821,11 @@ components:
5482054821
instances:
5482154822
- ref: refs/heads/codeql-analysis-yml
5482254823
analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build"
54823-
environment: {}
54824+
environment: ''
5482454825
state: fixed
5482554826
- ref: refs/pull/3740/head
5482654827
analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build"
54827-
environment: {}
54828+
environment: ''
5482854829
state: fixed
5482954830
state: fixed
5483054831
dismissed_by:
@@ -54864,11 +54865,11 @@ components:
5486454865
instances:
5486554866
- ref: refs/heads/codeql-analysis-yml
5486654867
analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build"
54867-
environment: {}
54868+
environment: ''
5486854869
state: dismissed
5486954870
- ref: refs/pull/3740/head
5487054871
analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build"
54871-
environment: {}
54872+
environment: ''
5487254873
state: dismissed
5487354874
state: dismissed
5487454875
dismissed_by:

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

+59-59
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.1.1",
4+
"version": "1.1.2",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -123750,31 +123750,33 @@
123750123750
"instances": {
123751123751
"nullable": true,
123752123752
"type": "array",
123753-
"properties": {
123754-
"ref": {
123755-
"type": "string",
123756-
"description": "The full Git reference, formatted as `refs/heads/<branch name>`."
123757-
},
123758-
"analysis_key": {
123759-
"type": "string",
123760-
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
123761-
},
123762-
"environment": {
123763-
"type": "string",
123764-
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
123765-
},
123766-
"matrix_vars": {
123767-
"nullable": true,
123768-
"type": "string"
123769-
},
123770-
"state": {
123771-
"type": "string",
123772-
"description": "State of a code scanning alert.",
123773-
"enum": [
123774-
"open",
123775-
"dismissed",
123776-
"fixed"
123777-
]
123753+
"items": {
123754+
"properties": {
123755+
"ref": {
123756+
"type": "string",
123757+
"description": "The full Git reference, formatted as `refs/heads/<branch name>`."
123758+
},
123759+
"analysis_key": {
123760+
"type": "string",
123761+
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
123762+
},
123763+
"environment": {
123764+
"type": "string",
123765+
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
123766+
},
123767+
"matrix_vars": {
123768+
"nullable": true,
123769+
"type": "string"
123770+
},
123771+
"state": {
123772+
"type": "string",
123773+
"description": "State of a code scanning alert.",
123774+
"enum": [
123775+
"open",
123776+
"dismissed",
123777+
"fixed"
123778+
]
123779+
}
123778123780
}
123779123781
}
123780123782
},
@@ -123987,15 +123989,13 @@
123987123989
{
123988123990
"ref": "refs/heads/codeql-analysis-yml",
123989123991
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
123990-
"environment": {
123991-
},
123992+
"environment": "",
123992123993
"state": "fixed"
123993123994
},
123994123995
{
123995123996
"ref": "refs/pull/3740/head",
123996123997
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
123997-
"environment": {
123998-
},
123998+
"environment": "",
123999123999
"state": "fixed"
124000124000
}
124001124001
],
@@ -124213,31 +124213,33 @@
124213124213
"instances": {
124214124214
"nullable": true,
124215124215
"type": "array",
124216-
"properties": {
124217-
"ref": {
124218-
"type": "string",
124219-
"description": "The full Git reference, formatted as `refs/heads/<branch name>`."
124220-
},
124221-
"analysis_key": {
124222-
"type": "string",
124223-
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
124224-
},
124225-
"environment": {
124226-
"type": "string",
124227-
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
124228-
},
124229-
"matrix_vars": {
124230-
"nullable": true,
124231-
"type": "string"
124232-
},
124233-
"state": {
124234-
"type": "string",
124235-
"description": "State of a code scanning alert.",
124236-
"enum": [
124237-
"open",
124238-
"dismissed",
124239-
"fixed"
124240-
]
124216+
"items": {
124217+
"properties": {
124218+
"ref": {
124219+
"type": "string",
124220+
"description": "The full Git reference, formatted as `refs/heads/<branch name>`."
124221+
},
124222+
"analysis_key": {
124223+
"type": "string",
124224+
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
124225+
},
124226+
"environment": {
124227+
"type": "string",
124228+
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
124229+
},
124230+
"matrix_vars": {
124231+
"nullable": true,
124232+
"type": "string"
124233+
},
124234+
"state": {
124235+
"type": "string",
124236+
"description": "State of a code scanning alert.",
124237+
"enum": [
124238+
"open",
124239+
"dismissed",
124240+
"fixed"
124241+
]
124242+
}
124241124243
}
124242124244
}
124243124245
},
@@ -124450,15 +124452,13 @@
124450124452
{
124451124453
"ref": "refs/heads/codeql-analysis-yml",
124452124454
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
124453-
"environment": {
124454-
},
124455+
"environment": "",
124455124456
"state": "dismissed"
124456124457
},
124457124458
{
124458124459
"ref": "refs/pull/3740/head",
124459124460
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
124460-
"environment": {
124461-
},
124461+
"environment": "",
124462124462
"state": "dismissed"
124463124463
}
124464124464
],

0 commit comments

Comments
 (0)