diff --git a/assets/scss/_variables_project.scss b/assets/scss/_variables_project.scss index 1e7e3950..637c0575 100644 --- a/assets/scss/_variables_project.scss +++ b/assets/scss/_variables_project.scss @@ -30,6 +30,9 @@ $note: $secondary; $note-background: $secondary-background; $warning-background: #FFE0E0; +// colours for definition tables. +// the border colour matches that used for "highlight" divs +$table-border-color: rgba(black, .125); $table-row-alternate: $secondary-lightest-background; $table-row-default: $secondary-lighter-background; diff --git a/assets/scss/custom.scss b/assets/scss/custom.scss index e8eab983..5a89d648 100644 --- a/assets/scss/custom.scss +++ b/assets/scss/custom.scss @@ -264,13 +264,13 @@ footer { /* Styles for sections that are rendered from data, such as HTTP APIs and event schemas */ .rendered-data { - margin: 1rem 0 3rem 0; + background-color: $secondary-lightest-background; + padding: 1rem; + margin: 1rem 0; details { summary { padding: .5rem 0; - list-style-position: outside; - p { max-width: 80%; } @@ -336,22 +336,30 @@ footer { padding: 1rem; } - th { - background-color: $white; - } + &.object-table, &.response-table { + border: 1px $table-border-color solid; - caption, tr { - background-color: $table-row-default; - } + caption { + // the caption is outside the table's border box, + // so we have to give it its own border. + border: 1px $table-border-color solid; + + // ... but avoid double border between caption and table + border-bottom: 0; + } + + caption, tbody tr { + background-color: $table-row-default; + } - tr:nth-child(even) { - background-color: $table-row-alternate; + tbody tr:nth-child(even) { + background-color: $table-row-alternate; + } } &.basic-info, &.basic-info th, &.basic-info td { table-layout: fixed; margin: 1rem 0 .5rem 0; - background-color: $white; } &.basic-info th { diff --git a/changelogs/internal/newsfragments/1195.clarification b/changelogs/internal/newsfragments/1195.clarification new file mode 100644 index 00000000..da9ce6fe --- /dev/null +++ b/changelogs/internal/newsfragments/1195.clarification @@ -0,0 +1 @@ +Give rendered-data sections a background and some padding. diff --git a/layouts/partials/openapi/render-object-table.html b/layouts/partials/openapi/render-object-table.html index 7de88071..b5e332dd 100644 --- a/layouts/partials/openapi/render-object-table.html +++ b/layouts/partials/openapi/render-object-table.html @@ -21,7 +21,7 @@ {{ if $properties }} - + {{ with $title }} {{ . }} {{ end }} diff --git a/layouts/partials/openapi/render-responses.html b/layouts/partials/openapi/render-responses.html index c6556fbb..9c59b0f2 100644 --- a/layouts/partials/openapi/render-responses.html +++ b/layouts/partials/openapi/render-responses.html @@ -20,7 +20,7 @@

Responses

- +
Status Description