From 68870cbbc019bbd28f8fef185148b6a8580238bb Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 26 Apr 2021 17:04:49 +0100 Subject: [PATCH 1/3] Change example for `indented_data_reference` in README file (#18967) --- lib/liquid-tags/README.md | 2 +- lib/liquid-tags/indented-data-reference.js | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/liquid-tags/README.md b/lib/liquid-tags/README.md index fe4dfc30dc..dd895d9fb6 100644 --- a/lib/liquid-tags/README.md +++ b/lib/liquid-tags/README.md @@ -63,7 +63,7 @@ Note that link tags will only render links that are available in the current pag | `{% homepage_link_with_intro /href %}` | The linked page's title and intro, with homepage-specific styling. | `{% link_in_list /href %}` | The linked page's title in a list item. | `{% topic_link_in_list /href %}` | The linked map topic's title in a list item (used in category TOCs). -| `{% indented_data_reference foo.bar spaces=NUMBER %}` | A data reference with the specified number of spaces prepended to each line. Defaults to 2 spaces if no spaces included. For example: `{% indented_data_reference reusables.enterprise_management_console.enable-disable-security-features %}` +| `{% indented_data_reference foo.bar spaces=NUMBER %}` | A data reference with the specified number of spaces prepended to each line. Defaults to 2 spaces if no spaces included. For example: `{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}` ## Creating tags diff --git a/lib/liquid-tags/indented-data-reference.js b/lib/liquid-tags/indented-data-reference.js index 03dfeb15cf..3c45993de0 100644 --- a/lib/liquid-tags/indented-data-reference.js +++ b/lib/liquid-tags/indented-data-reference.js @@ -2,7 +2,8 @@ const assert = require('assert') // This class supports a tag that expects two parameters, a data reference and `spaces=NUMBER`: // -// {% indented_data_reference site.data.foo.bar spaces=NUMBER %} +// {% indented_data_reference foo.bar spaces=NUMBER %} +// Example: {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} // // This tag renders the given data reference with the specified number of spaces // prepended to each line. This results in correct formatting when the data From a7623cdb62e1d0eed92957563c0c30e0959515b1 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Mon, 26 Apr 2021 09:18:25 -0700 Subject: [PATCH 2/3] Reorganize SCSS without changing any of the properties or values (#18963) * Reorganize SCSS without changing any of the properties or values * Mis-moved a few files * Split up "other" --- stylesheets/alerts.scss | 13 ++ stylesheets/article.scss | 142 ------------------ stylesheets/breadcrumbs.scss | 18 +++ stylesheets/bump-link.scss | 22 +++ stylesheets/code.scss | 47 ++++++ stylesheets/deprecation-banner.scss | 24 +++ stylesheets/extended-markdown.scss | 17 +++ stylesheets/featured-links.scss | 16 ++ stylesheets/{new-mktg.scss => font-mktg.scss} | 41 ----- stylesheets/headings.scss | 37 +++++ stylesheets/helpfulness.scss | 8 + stylesheets/images.scss | 28 ++++ stylesheets/index.scss | 37 +++-- stylesheets/lists.scss | 77 ++++++++++ stylesheets/overrides.scss | 134 ----------------- stylesheets/summary.scss | 23 +++ stylesheets/syntax-highlighting.scss | 13 -- stylesheets/tables.scss | 7 + stylesheets/type.scss | 41 ----- stylesheets/underline-dashed.scss | 13 ++ 20 files changed, 374 insertions(+), 384 deletions(-) create mode 100644 stylesheets/alerts.scss create mode 100644 stylesheets/breadcrumbs.scss create mode 100644 stylesheets/bump-link.scss create mode 100644 stylesheets/code.scss create mode 100644 stylesheets/deprecation-banner.scss create mode 100644 stylesheets/extended-markdown.scss create mode 100644 stylesheets/featured-links.scss rename stylesheets/{new-mktg.scss => font-mktg.scss} (63%) create mode 100644 stylesheets/headings.scss create mode 100644 stylesheets/helpfulness.scss create mode 100644 stylesheets/images.scss create mode 100644 stylesheets/lists.scss delete mode 100644 stylesheets/overrides.scss create mode 100644 stylesheets/summary.scss delete mode 100644 stylesheets/type.scss create mode 100644 stylesheets/underline-dashed.scss diff --git a/stylesheets/alerts.scss b/stylesheets/alerts.scss new file mode 100644 index 0000000000..e98d25eb78 --- /dev/null +++ b/stylesheets/alerts.scss @@ -0,0 +1,13 @@ +/* Notes, tips, warning, and danger styles +------------------------------------------------------------------------------*/ + +.note, +.tip, +.warning, +.danger { + // remove extra space under lists inside of notes + ul, + ol { + margin-bottom: 0; + } +} diff --git a/stylesheets/article.scss b/stylesheets/article.scss index f7fdf6349a..c4da64df2e 100644 --- a/stylesheets/article.scss +++ b/stylesheets/article.scss @@ -41,145 +41,3 @@ .article-grid-body { grid-area: bottom; } - -/* Deprecation banner -------------------------------------------------------------------------------*/ -.deprecation-banner { - & + .alert { - margin-top: 5px; - } - - & > *:first-child { - margin-top: 0; - } - - & > *:last-child { - margin-bottom: 0; - } - - b, - strong { - font-weight: bold; - } - - p { - margin: 0; - } -} - -/* Code style overrides -------------------------------------------------------------------------------*/ - -.markdown-body .highlight pre, -.markdown-body pre { - margin-top: 10px; -} - -.height-constrained-code-block pre { - max-height: 500px; - overflow: auto; -} - -/* Breadcrumbs -------------------------------------------------------------------------------*/ - -.breadcrumbs-wrapper { - @include breakpoint(xl) { - height: 39px; - } -} - -.breadcrumbs a:not(:last-child)::after, -.breadcrumbs span:not(:last-child)::after { - content: "/"; - color: var(--color-auto-gray-4); - padding-right: $spacer-1; - padding-left: $spacer-2; - display: inline-block; -} - -/* Numbered procedures (step 1, step 2, ...) -------------------------------------------------------------------------------*/ - -.markdown-body ol { - counter-reset: li; - list-style: none; - position: relative; - padding-bottom: 10px; - padding-left: 0; -} - -.markdown-body ol > li { - padding: 15px 0 15px 55px; - position: relative; - margin-bottom: 5px; - border-top: 3px solid var(--color-auto-gray-2); -} - -.markdown-body ol > li:before { - content: counter(li); - counter-increment: li; - position: absolute; - top: 10px; - left: 0; - height: 100%; - width: 30px; - padding: 0 10px 0 0; - color: var(--color-auto-gray-4); - font-size: 22px; - font-weight: bold; - line-height: 35px; - text-align: right; -} - -.markdown-body ol > li > p { - margin: 0; -} - -.markdown-body ol > li > p:first-child { - margin-top: 0; -} - -.markdown-body ol > li:after { - content: "."; - display: block; - clear: both; - visibility: hidden; - line-height: 0; - height: 0; -} - -.procedural-image-wrapper { - display: block; - padding: 10px 0; - margin: 20px auto 0 auto; -} - -.procedural-image-wrapper img { - border-radius: 5px; - border: 2px solid var(--color-auto-gray-2); - width: auto; - height: auto; - max-height: 500px; -} - -// make sure images that contain emoji render at the expected size -img[src*="https://github.githubassets.com/images/icons/emoji"] { - height: 20; - width: 20; - align: absmiddle; -} - -/* Notes, tips, warning, and danger styles -------------------------------------------------------------------------------*/ - -.note, -.tip, -.warning, -.danger { - // remove extra space under lists inside of notes - ul, - ol { - margin-bottom: 0; - } -} diff --git a/stylesheets/breadcrumbs.scss b/stylesheets/breadcrumbs.scss new file mode 100644 index 0000000000..4179042330 --- /dev/null +++ b/stylesheets/breadcrumbs.scss @@ -0,0 +1,18 @@ + +/* Breadcrumbs +------------------------------------------------------------------------------*/ + +.breadcrumbs-wrapper { + @include breakpoint(xl) { + height: 39px; + } +} + +.breadcrumbs a:not(:last-child)::after, +.breadcrumbs span:not(:last-child)::after { + content: "/"; + color: var(--color-auto-gray-4); + padding-right: $spacer-1; + padding-left: $spacer-2; + display: inline-block; +} diff --git a/stylesheets/bump-link.scss b/stylesheets/bump-link.scss new file mode 100644 index 0000000000..df07edc798 --- /dev/null +++ b/stylesheets/bump-link.scss @@ -0,0 +1,22 @@ +// Arrow links +.Bump-link-symbol { + display: inline-block; + transition: $transition-time / 2; + transform: translateX(0); +} + +.Bump-link:hover .Bump-link-symbol { + transform: translateX(3px); +} + +.Bump-link--hover .Bump-link-symbol { + color: inherit; + opacity: 0; + transition: $transition-time / 2; + transform: translateX(0); +} + +.Bump-link--hover:hover .Bump-link-symbol { + opacity: 1; + transform: translateX(3px); +} diff --git a/stylesheets/code.scss b/stylesheets/code.scss new file mode 100644 index 0000000000..3ba21f542d --- /dev/null +++ b/stylesheets/code.scss @@ -0,0 +1,47 @@ +/* Code style overrides +------------------------------------------------------------------------------*/ + +.markdown-body .highlight pre, +.markdown-body pre { + margin-top: 10px; +} + +.height-constrained-code-block pre { + max-height: 500px; + overflow: auto; +} + +.markdown-body .code-extra { + margin-top: $spacer-4; + + pre { + margin-top: 0 !important; + border-top-left-radius: 0 !important; + border-top-right-radius: 0 !important; + border-left: 1px var(--color-auto-gray-2) solid !important; + border-bottom: 1px var(--color-auto-gray-2) solid !important; + border-right: 1px var(--color-auto-gray-2) solid !important; + } +} + +/* code styles */ +pre .redbox { + border: 2px solid var(--color-auto-red-5); + padding: 2px; + border-radius: 2px; + margin-right: 2px; +} + +pre .greenbox { + border: 2px solid var(--color-auto-green-5); + padding: 2px; + border-radius: 2px; + margin-right: 2px; +} + +pre .bluebox { + border: 2px solid var(--color-auto-blue-5); + padding: 2px; + border-radius: 2px; + margin-right: 2px; +} diff --git a/stylesheets/deprecation-banner.scss b/stylesheets/deprecation-banner.scss new file mode 100644 index 0000000000..64d365eed1 --- /dev/null +++ b/stylesheets/deprecation-banner.scss @@ -0,0 +1,24 @@ +/* Deprecation banner +------------------------------------------------------------------------------*/ +.deprecation-banner { + & + .alert { + margin-top: 5px; + } + + & > *:first-child { + margin-top: 0; + } + + & > *:last-child { + margin-bottom: 0; + } + + b, + strong { + font-weight: bold; + } + + p { + margin: 0; + } +} diff --git a/stylesheets/extended-markdown.scss b/stylesheets/extended-markdown.scss new file mode 100644 index 0000000000..80f930bc87 --- /dev/null +++ b/stylesheets/extended-markdown.scss @@ -0,0 +1,17 @@ +.extended-markdown p { + margin: 0; +} + +.extended-markdown p:not(:first-child) { + margin-top: 15px; +} + +.extended-markdown.note pre { + background: none; + padding: 10px 10px 10px 0; + margin-bottom: 0; +} + +.extended-markdown.note pre code { + color: var(--color-text-primary); +} diff --git a/stylesheets/featured-links.scss b/stylesheets/featured-links.scss new file mode 100644 index 0000000000..8c2def48f2 --- /dev/null +++ b/stylesheets/featured-links.scss @@ -0,0 +1,16 @@ +/* Getting Started and Popular Articles sections in article layout */ +.markdown-body div.featured-links { + padding-bottom: 30px; +} + +.markdown-body div.featured-links-heading { + padding-top: 24px; +} + +.markdown-body div.featured-links p.link-with-intro-intro { + margin-bottom: 5px; +} + +.markdown-body div.featured-links h4.link-with-intro-title { + margin-top: 0; +} diff --git a/stylesheets/new-mktg.scss b/stylesheets/font-mktg.scss similarity index 63% rename from stylesheets/new-mktg.scss rename to stylesheets/font-mktg.scss index ecef50779a..5c67076e51 100644 --- a/stylesheets/new-mktg.scss +++ b/stylesheets/font-mktg.scss @@ -1,45 +1,4 @@ -/* Styles not incorporated into Primer yet -------------------------------------------------------------------------------*/ - -// Text styling -.underline-dashed { - display: inline; - padding-bottom: $spacer-1; - background-image: linear-gradient( - to right, - var(--color-auto-gray-3) 50%, - transparent 0% - ); - background-repeat: repeat-x; - background-position: bottom; - background-size: 10px 1px; -} - -// Arrow links -.Bump-link-symbol { - display: inline-block; - transition: $transition-time / 2; - transform: translateX(0); -} - -.Bump-link:hover .Bump-link-symbol { - transform: translateX(3px); -} - -.Bump-link--hover .Bump-link-symbol { - color: inherit; - opacity: 0; - transition: $transition-time / 2; - transform: translateX(0); -} - -.Bump-link--hover:hover .Bump-link-symbol { - opacity: 1; - transform: translateX(3px); -} - // stylelint-disable primer/no-unused-vars - // Typography $marketing-font-path: "/assets/fonts/alliance/"; diff --git a/stylesheets/headings.scss b/stylesheets/headings.scss new file mode 100644 index 0000000000..2a20f81cbb --- /dev/null +++ b/stylesheets/headings.scss @@ -0,0 +1,37 @@ +h1, +h2, +h3, +h4 { + a { + color: var(--color-auto-gray-9); + } +} + +// all h3 headers that are links should be blue-500 +// except those on each product's toc +h3 a { + color: var(--color-auto-blue-5); +} + +.markdown-body { + h1, + h2, + h3, + h4, + h5, + h6 { + font-family: $font-mktg; + font-weight: $font-weight-semibold; + padding-top: $spacer-3; + } +} + +// needs specificity to override +.markdown-body .lead-mktg p { + color: var(--color-auto-gray-9); +} + +.product-callout p, +.contributor-callout p { + margin: 0; +} diff --git a/stylesheets/helpfulness.scss b/stylesheets/helpfulness.scss new file mode 100644 index 0000000000..a5ad0f41a3 --- /dev/null +++ b/stylesheets/helpfulness.scss @@ -0,0 +1,8 @@ +/* Helpfulness survey override */ +:checked + .x-radio-label { + background: var(--color-auto-blue-5); + + svg { + fill: var(--color-auto-inverse); + } +} diff --git a/stylesheets/images.scss b/stylesheets/images.scss new file mode 100644 index 0000000000..b243c4a7b2 --- /dev/null +++ b/stylesheets/images.scss @@ -0,0 +1,28 @@ +.procedural-image-wrapper { + display: block; + padding: 10px 0; + margin: 20px auto 0 auto; +} + +.procedural-image-wrapper img { + border-radius: 5px; + border: 2px solid var(--color-auto-gray-2); + width: auto; + height: auto; + max-height: 500px; +} + +// make sure images that contain emoji render at the expected size +img[src*="https://github.githubassets.com/images/icons/emoji"] { + height: 20; + width: 20; + align: absmiddle; +} + +.markdown-body li img { + max-width: calc(100% - 32px); +} + +.markdown-body img { + max-height: 600px; +} diff --git a/stylesheets/index.scss b/stylesheets/index.scss index 839832056c..338ece7d7d 100644 --- a/stylesheets/index.scss +++ b/stylesheets/index.scss @@ -7,24 +7,35 @@ $marketing-font-path: "/dist/fonts/"; @import "@primer/css/marketing/index.scss"; +@import "font-mktg.scss"; -// Additional styles -@import "new-mktg.scss"; -@import "type.scss"; -@import "nav.scss"; +@import "alerts.scss"; @import "article.scss"; -@import "search.scss"; -@import "overrides.scss"; -@import "sidebar.scss"; -@import "scroll-button.scss"; +@import "breadcrumbs.scss"; +@import "bump-link.scss"; +@import "code.scss"; +@import "deprecation-banner.scss"; +@import "dev-toc.scss"; @import "explorer.scss"; -@import "syntax-highlighting.scss"; -@import "tables.scss"; +@import "extended-markdown.scss"; +@import "featured-links.scss"; +@import "font-mktg.scss"; +@import "gradient.scss"; +@import "headings.scss"; +@import "helpfulness.scss"; +@import "images.scss"; +@import "lists.scss"; +@import "nav.scss"; @import "opacity.scss"; @import "print.scss"; -@import "shadows.scss"; @import "product-landing.scss"; -@import "dev-toc.scss"; -@import "gradient.scss"; @import "product-sublanding.scss"; @import "release-notes.scss"; +@import "scroll-button.scss"; +@import "search.scss"; +@import "shadows.scss"; +@import "sidebar.scss"; +@import "summary.scss"; +@import "syntax-highlighting.scss"; +@import "tables.scss"; +@import "underline-dashed.scss"; diff --git a/stylesheets/lists.scss b/stylesheets/lists.scss new file mode 100644 index 0000000000..05d488dc87 --- /dev/null +++ b/stylesheets/lists.scss @@ -0,0 +1,77 @@ +/* Numbered procedures (step 1, step 2, ...) +------------------------------------------------------------------------------*/ + +.markdown-body ol { + counter-reset: li; + list-style: none; + position: relative; + padding-bottom: 10px; + padding-left: 0; +} + +.markdown-body ol > li { + padding: 15px 0 15px 55px; + position: relative; + margin-bottom: 5px; + border-top: 3px solid var(--color-auto-gray-2); +} + +.markdown-body ol > li:before { + content: counter(li); + counter-increment: li; + position: absolute; + top: 10px; + left: 0; + height: 100%; + width: 30px; + padding: 0 10px 0 0; + color: var(--color-auto-gray-4); + font-size: 22px; + font-weight: bold; + line-height: 35px; + text-align: right; +} + +.markdown-body ol > li > p { + margin: 0; +} + +.markdown-body ol > li > p:first-child { + margin-top: 0; +} + +.markdown-body ol > li:after { + content: "."; + display: block; + clear: both; + visibility: hidden; + line-height: 0; + height: 0; +} + +.markdown-body ol > li { + padding: $spacer-2 0 $spacer-2 $spacer-7; + border: 0; + + &:before { + top: 2px; + font-size: $spacer-3; + width: $spacer-4; + } + + p:not(:first-child) { + margin-top: 15px; + } + + .extended-markdown { + margin-top: 15px; + } +} + +.markdown-body ul ul, +.markdown-body ul ol, +.markdown-body ol ol, +.markdown-body ol ul { + margin-top: 15px; + margin-bottom: 15px; +} diff --git a/stylesheets/overrides.scss b/stylesheets/overrides.scss deleted file mode 100644 index 30f3389ca6..0000000000 --- a/stylesheets/overrides.scss +++ /dev/null @@ -1,134 +0,0 @@ -/* Override Primer styles -------------------------------------------------------------------------------*/ - -.markdown-body { - h1, - h2, - h3, - h4, - h5, - h6 { - font-family: $font-mktg; - font-weight: $font-weight-semibold; - padding-top: $spacer-3; - } -} - -// NB: Note that there's also overlapping styling in "article.scss" -.markdown-body ol > li { - padding: $spacer-2 0 $spacer-2 $spacer-7; - border: 0; - - &:before { - top: 2px; - font-size: $spacer-3; - width: $spacer-4; - } - - p:not(:first-child) { - margin-top: 15px; - } - - .extended-markdown { - margin-top: 15px; - } -} - -.markdown-body ul ul, -.markdown-body ul ol, -.markdown-body ol ol, -.markdown-body ol ul { - margin-top: 15px; - margin-bottom: 15px; -} - -// needs specificity to override -.markdown-body .lead-mktg p { - color: var(--color-auto-gray-9); -} - -.extended-markdown p { - margin: 0; -} - -.extended-markdown p:not(:first-child) { - margin-top: 15px; -} - -.extended-markdown.note pre { - background: none; - padding: 10px 10px 10px 0; - margin-bottom: 0; -} - -.extended-markdown.note pre code { - color: var(--color-text-primary); -} - -.product-callout p, -.contributor-callout p { - margin: 0; -} - -// Largely overwritten in tables.scss -.markdown-body table { - display: table; - table-layout: fixed; - line-height: 1.5; -} - -/* Getting Started and Popular Articles sections in article layout */ -.markdown-body div.featured-links { - padding-bottom: 30px; -} - -.markdown-body div.featured-links-heading { - padding-top: 24px; -} - -.markdown-body div.featured-links p.link-with-intro-intro { - margin-bottom: 5px; -} - -.markdown-body div.featured-links h4.link-with-intro-title { - margin-top: 0; -} - -/* code styles */ -pre .redbox { - border: 2px solid var(--color-auto-red-5); - padding: 2px; - border-radius: 2px; - margin-right: 2px; -} - -pre .greenbox { - border: 2px solid var(--color-auto-green-5); - padding: 2px; - border-radius: 2px; - margin-right: 2px; -} - -pre .bluebox { - border: 2px solid var(--color-auto-blue-5); - padding: 2px; - border-radius: 2px; - margin-right: 2px; -} - -/* Helpfulness survey override */ -:checked + .x-radio-label { - background: var(--color-auto-blue-5); - - svg { - fill: var(--color-auto-inverse); - } -} - -.markdown-body li img { - max-width: calc(100% - 32px); -} - -.markdown-body img { - max-height: 600px; -} diff --git a/stylesheets/summary.scss b/stylesheets/summary.scss new file mode 100644 index 0000000000..58f276feaa --- /dev/null +++ b/stylesheets/summary.scss @@ -0,0 +1,23 @@ +summary { + outline: none; +} + +.markdown-body { + summary { + h1, + h2, + h3, + h4, + h5, + h6 { + display: inline-block; + margin-top: 10px; + margin-bottom: 10px; + + p { + margin: 0; + padding: 0; + } + } + } +} diff --git a/stylesheets/syntax-highlighting.scss b/stylesheets/syntax-highlighting.scss index 1f3a59d144..67f23d5a36 100644 --- a/stylesheets/syntax-highlighting.scss +++ b/stylesheets/syntax-highlighting.scss @@ -5,19 +5,6 @@ from https://unpkg.com/highlight.js@9.15.8/styles/github.css */ -.markdown-body .code-extra { - margin-top: $spacer-4; - - pre { - margin-top: 0 !important; - border-top-left-radius: 0 !important; - border-top-right-radius: 0 !important; - border-left: 1px var(--color-auto-gray-2) solid !important; - border-bottom: 1px var(--color-auto-gray-2) solid !important; - border-right: 1px var(--color-auto-gray-2) solid !important; - } -} - .hljs { display: block; overflow-x: auto; diff --git a/stylesheets/tables.scss b/stylesheets/tables.scss index f402041bf2..16767c2050 100644 --- a/stylesheets/tables.scss +++ b/stylesheets/tables.scss @@ -1,3 +1,10 @@ +// Largely overwritten in tables.scss +.markdown-body table { + display: table; + table-layout: fixed; + line-height: 1.5; +} + .markdown-body table { border-collapse: collapse; position: relative; diff --git a/stylesheets/type.scss b/stylesheets/type.scss deleted file mode 100644 index 9811628ba1..0000000000 --- a/stylesheets/type.scss +++ /dev/null @@ -1,41 +0,0 @@ -/* Global type styles -------------------------------------------------------------------------------*/ - -h1, -h2, -h3, -h4 { - a { - color: var(--color-auto-gray-9); - } -} - -summary { - outline: none; -} - -.markdown-body { - summary { - h1, - h2, - h3, - h4, - h5, - h6 { - display: inline-block; - margin-top: 10px; - margin-bottom: 10px; - - p { - margin: 0; - padding: 0; - } - } - } -} - -// all h3 headers that are links should be blue-500 -// except those on each product's toc -h3 a { - color: var(--color-auto-blue-5); -} diff --git a/stylesheets/underline-dashed.scss b/stylesheets/underline-dashed.scss new file mode 100644 index 0000000000..3d831447ef --- /dev/null +++ b/stylesheets/underline-dashed.scss @@ -0,0 +1,13 @@ +// Text styling +.underline-dashed { + display: inline; + padding-bottom: $spacer-1; + background-image: linear-gradient( + to right, + var(--color-auto-gray-3) 50%, + transparent 0% + ); + background-repeat: repeat-x; + background-position: bottom; + background-size: 10px 1px; +} From 705ae14e9fcd1c1b92da3802f557cbd6f79d0635 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Mon, 26 Apr 2021 13:40:55 -0400 Subject: [PATCH 3/3] Update OpenAPI Descriptions (#18984) --- lib/rest/static/decorated/api.github.com.json | 9 ++----- lib/rest/static/decorated/ghes-2.22.json | 7 +----- lib/rest/static/decorated/ghes-3.0.json | 7 +----- lib/rest/static/decorated/github.ae.json | 9 ++----- .../dereferenced/api.github.com.deref.json | 24 ++++++++++++------- .../static/dereferenced/ghes-2.18.deref.json | 4 ++++ .../static/dereferenced/ghes-2.19.deref.json | 4 ++++ .../static/dereferenced/ghes-2.20.deref.json | 4 ++++ .../static/dereferenced/ghes-2.21.deref.json | 4 ++++ .../static/dereferenced/ghes-2.22.deref.json | 19 ++++++++------- .../static/dereferenced/ghes-3.0.deref.json | 19 ++++++++------- .../static/dereferenced/github.ae.deref.json | 24 ++++++++++++------- 12 files changed, 72 insertions(+), 62 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 1259f8093a..3fd6794fdc 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -46895,7 +46895,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/codeql-analysis.yml:analyze/language:python\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/shiftleft.yml:build/\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" }, { "httpStatusCode": "403", @@ -46987,7 +46987,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true,\n  \"warning\": \"\"\n}\n
" + "payload": "
{\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"category\": \".github/workflows/codeql-analysis.yml:analyze/language:javascript\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true,\n  \"warning\": \"\"\n}\n
" }, { "httpStatusCode": "403", @@ -47310,11 +47310,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 65ad3f00f8..145e129012 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -41292,7 +41292,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/codeql-analysis.yml:analyze/language:python\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/shiftleft.yml:build/\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" }, { "httpStatusCode": "403", @@ -41507,11 +41507,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index b4b8627b92..d65a4d6669 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -45773,7 +45773,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/codeql-analysis.yml:analyze/language:python\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/shiftleft.yml:build/\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" }, { "httpStatusCode": "403", @@ -45988,11 +45988,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 7ebd0bb8be..09b7c4acee 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -39584,7 +39584,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/codeql-analysis.yml:analyze/language:python\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"category\": \".github/workflows/shiftleft.yml:build/\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
" }, { "httpStatusCode": "403", @@ -39676,7 +39676,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true,\n  \"warning\": \"\"\n}\n
" + "payload": "
{\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"category\": \".github/workflows/codeql-analysis.yml:analyze/language:javascript\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true,\n  \"warning\": \"\"\n}\n
" }, { "httpStatusCode": "403", @@ -39891,11 +39891,6 @@ } ], "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" - }, { "httpStatusCode": "202", "httpStatusMessage": "Accepted", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 1bc109dea1..83eaa47098 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." @@ -164291,6 +164295,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -164382,6 +164390,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -164402,6 +164411,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -164577,6 +164587,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -164667,6 +164681,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, @@ -165080,15 +165095,6 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - } - } - } - }, "202": { "description": "Response", "content": { diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 8d755f6c3a..4d24b6f8b9 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index 153ae67761..1bd752c2ff 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index ad60611bb7..72f0e2ca16 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 5c61fafda1..5b10162d5b 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index f73b948562..88f249fc96 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." @@ -145516,6 +145520,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -145607,6 +145615,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -145627,6 +145636,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -145808,15 +145818,6 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - } - } - } - }, "202": { "description": "Response", "content": { diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 532bac8266..1e18f42253 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." @@ -150799,6 +150803,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -150890,6 +150898,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -150910,6 +150919,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -151091,15 +151101,6 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - } - } - } - }, "202": { "description": "Response", "content": { diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 2e50c3ce44..435f61eab2 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -35,6 +35,10 @@ "name": "checks", "description": "Rich interactions with checks run by your integrations." }, + { + "name": "classroom", + "description": "Endpoints that give information about Classroom-related data." + }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." @@ -130943,6 +130947,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -131034,6 +131042,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -131054,6 +131063,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -131229,6 +131239,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -131319,6 +131333,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, @@ -131499,15 +131514,6 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - } - } - } - }, "202": { "description": "Response", "content": {