Skip to content

Commit 77c2d0e

Browse files
jkowalleckjkowalleck
committed
Merge remote-tracking branch 'origin/master' into 1.7-dev
2 parents bcea8a9 + 19c11ba commit 77c2d0e

File tree

8 files changed

+127
-70
lines changed

8 files changed

+127
-70
lines changed

‎README.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,24 @@ free, open source, and proprietary tools and solutions that support the CycloneD
4747
The following media types are officially registered with IANA:
4848

4949
| Media Type | Format | Assignment |
50-
| ------- | --------- | --------- |
51-
| application/vnd.cyclonedx+xml | XML | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+xml) |
52-
| application/vnd.cyclonedx+json | JSON | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+json) |
50+
|------------|--------|------------|
51+
| `application/vnd.cyclonedx+xml` | XML | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+xml) |
52+
| `application/vnd.cyclonedx+json` | JSON | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+json) |
53+
| `application/x.vnd.cyclonedx+protobuf` | Protocol Buffer | |
5354

5455
Specific versions of CycloneDX can be specified by using the version parameter. For example: `application/vnd.cyclonedx+xml; version=1.6`.
5556

56-
The officially supported media type for Protocol Buffer format is `application/x.vnd.cyclonedx+protobuf`.
5757

58+
## Recognized file patterns
59+
60+
The following file names are conventionally used for storing CycloneDX BOM files:
61+
* `bom.json` for JSON encoded CycloneDX BOM files.
62+
* `bom.xml` for XML encoded CycloneDX BOM files.
63+
64+
Alternatively, files that match the glob pattern below are also recognized:
65+
* `*.cdx.json` for JSON encoded CycloneDX BOM files.
66+
* `*.cdx.xml` for XML encoded CycloneDX BOM files.
67+
5868

5969
## Release History
6070

‎config‎

Whitespace-only changes.

‎docgen/json/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
json-schema-for-humans==0.47
1+
json-schema-for-humans==1.3.4

‎docgen/json/templates/cyclonedx/base.html‎

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
<meta name="twitter:card" content="summary_large_image"/>
1010
<meta name="twitter:site" content="@CycloneDX_Spec"/>
1111
<meta name="twitter:title" content="${quotedTitle}"/>
12-
<meta name="twitter:image" content="https://cyclonedx.org/theme/assets/images/CycloneDX-Twitter-Card.png"/>
12+
<meta name="twitter:image" content="https://cyclonedx.org/images/CycloneDX-Social-Card.png"/>
1313
<meta name="twitter:description" content="${quotedTitle}"/>
1414
<meta name="description" content="${quotedTitle}"/>
1515
<meta property="og:description" content="${quotedTitle}"/>
1616
<meta property="og:title" content="${quotedTitle}"/>
1717
<meta property="og:locale" content="en_US"/>
1818
<meta property="og:type" content="website" />
19-
<meta property="og:image" content="https://cyclonedx.org/theme/assets/images/CycloneDX-Twitter-Card.png" />
20-
<link rel="icon" href="https://cyclonedx.org/cyclonedx-icon.png" type="image/png"/>
19+
<meta property="og:image" content="https://cyclonedx.org/images/CycloneDX-Social-Card.png" />
20+
<link href="/favicon.ico" rel="shortcut icon" type="image/ico" />
2121
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.2/css/bootstrap.min.css" integrity="sha512-rt/SrQ4UNIaGfDyEXZtNcyWvQeOq0QLygHluFQcSjaGB04IxWhal71tKuzP6K8eYXYB6vJV4pHkXcmFGGQ1/0w==" crossorigin="anonymous" referrerpolicy="no-referrer" />
2222
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha512-SfTiTlX6kk+qitfevl/7LibUOeJWlt9rbyDn92a1DqWOw9vWG2MFoays0sgObmWazO5BQPiFucnnEAjpAB+/Sw==" crossorigin="anonymous" referrerpolicy="no-referrer" />
2323
<link rel="stylesheet" type="text/css" href="schema_doc.css">
@@ -29,7 +29,7 @@
2929
<body class="blue" data-spy="scroll" data-target=".js-scrollspy" onload="anchorOnLoad();" id="root">
3030

3131
<nav class="navbar fixed-top navbar-expand-sm navbar-inverse">
32-
<a href="https://cyclonedx.org" class="navbar-brand site-header__logo"><img src="https://cyclonedx.org/theme/assets/images/layout/logo-white.svg" width="150"></img></a>
32+
<a href="/" class="navbar-brand site-header__logo"><img src="https://cyclonedx.org/images/logo-all-white.svg" height="48" width="276"></img></a>
3333
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarScroll" aria-controls="navbarScroll" aria-expanded="false" aria-label="Toggle navigation">
3434
<span class="navbar-toggler-icon"></span>
3535
</button>
@@ -40,29 +40,29 @@
4040
v${version} (JSON)
4141
</a>
4242
<ul class="dropdown-menu" aria-labelledby="navbarScrollingDropdown">
43-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.7/json/">v1.7 (JSON)</a></li>
44-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/json/">v1.6 (JSON)</a></li>
45-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/json/">v1.5 (JSON)</a></li>
46-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/json/">v1.4 (JSON)</a></li>
47-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/json/">v1.3 (JSON)</a></li>
48-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/json/">v1.2 (JSON)</a></li>
43+
<li><a class="dropdown-item" href="/docs/1.7/json/">v1.7 (JSON)</a></li>
44+
<li><a class="dropdown-item" href="/docs/1.6/json/">v1.6 (JSON)</a></li>
45+
<li><a class="dropdown-item" href="/docs/1.5/json/">v1.5 (JSON)</a></li>
46+
<li><a class="dropdown-item" href="/docs/1.4/json/">v1.4 (JSON)</a></li>
47+
<li><a class="dropdown-item" href="/docs/1.3/json/">v1.3 (JSON)</a></li>
48+
<li><a class="dropdown-item" href="/docs/1.2/json/">v1.2 (JSON)</a></li>
4949
<li><hr class="dropdown-divider"/></li>
50-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.7/xml/">v1.7 (XML)</a></li>
51-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.6/xml/">v1.6 (XML)</a></li>
52-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.5/xml/">v1.5 (XML)</a></li>
53-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.4/xml/">v1.4 (XML)</a></li>
54-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.3/xml/">v1.3 (XML)</a></li>
55-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.2/xml/">v1.2 (XML)</a></li>
56-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.1/xml/">v1.1 (XML)</a></li>
57-
<li><a class="dropdown-item" href="https://cyclonedx.org/docs/1.0/xml/">v1.0 (XML)</a></li>
50+
<li><a class="dropdown-item" href="/docs/1.7/xml/">v1.7 (XML)</a></li>
51+
<li><a class="dropdown-item" href="/docs/1.6/xml/">v1.6 (XML)</a></li>
52+
<li><a class="dropdown-item" href="/docs/1.5/xml/">v1.5 (XML)</a></li>
53+
<li><a class="dropdown-item" href="/docs/1.4/xml/">v1.4 (XML)</a></li>
54+
<li><a class="dropdown-item" href="/docs/1.3/xml/">v1.3 (XML)</a></li>
55+
<li><a class="dropdown-item" href="/docs/1.2/xml/">v1.2 (XML)</a></li>
56+
<li><a class="dropdown-item" href="/docs/1.1/xml/">v1.1 (XML)</a></li>
57+
<li><a class="dropdown-item" href="/docs/1.0/xml/">v1.0 (XML)</a></li>
5858
</ul>
5959
</li>
6060
</ul>
6161
</div>
6262
</nav>
6363

6464

65-
<div class="container-fluid" style="margin-top:70px; margin-bottom:3rem">
65+
<div class="container-fluid" style="margin-top:110px; margin-bottom:3rem">
6666
<h1>${title}</h1>
6767

6868
{%- if title -%}
@@ -77,6 +77,7 @@ <h1>{{ title }}</h1>
7777

7878
{{ content(schema) }}
7979

80+
<!--
8081
<footer class="site-footer__copyright fixed-bottom">
8182
<div class="container">
8283
<div class="row">
@@ -86,6 +87,7 @@ <h1>{{ title }}</h1>
8687
</div>
8788
</div>
8889
</footer>
90+
-->
8991

9092
</body>
91-
</html>
93+
</html>

‎docgen/json/templates/cyclonedx/content.html‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,37 @@
6060
{%- endif -%}
6161

6262
{# Enum and const #}
63-
{%- if schema.kw_enum -%}
63+
{%- if schema.kw_enum and schema.kw_meta_enum -%}
64+
<div class="enum-value" id="{{ schema.kw_enum.html_id }}">
65+
<h4>Must be one of:</h4>
66+
<table class="table table-striped table-bordered">
67+
<thead class="thead-dark">
68+
<tr>
69+
<th class="text-nowrap" scope="col">Name</th>
70+
<th scope="col">Description</th>
71+
</tr>
72+
</thead>
73+
<tbody>
74+
{%- for enum_choice in schema.kw_enum.array_items -%}
75+
<tr>
76+
<td class="text-nowrap">
77+
<strong>{{ enum_choice.literal | python_to_json }}</strong>
78+
</td>
79+
<td>
80+
{{ (schema.enum_description(enum_choice.literal) | get_description_literal) }}
81+
</td>
82+
</tr>
83+
{%- endfor -%}
84+
</tbody>
85+
</table>
86+
</div>
87+
{%- elif schema.kw_enum -%}
6488
<div class="enum-value" id="{{ schema.kw_enum.html_id }}">
6589
<h4>Must be one of:</h4>
6690
<ul class="list-group">
6791
{%- for enum_choice in schema.kw_enum.array_items -%}
6892
<li class="list-group-item enum-item">
69-
{%- if schema.kw_meta_enum -%}<strong>{%- endif -%}
7093
{{ enum_choice.literal | python_to_json }}
71-
{%- if schema.kw_meta_enum -%}</strong>
72-
: {{ (schema.enum_description(enum_choice.literal) | get_description_literal) }}
73-
{%- endif -%}
7494
</li>
7595
{%- endfor -%}
7696
</ul>

‎docgen/json/templates/cyclonedx/schema_doc.css‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,39 @@ body {
44
margin: 0;
55
padding: 0;
66
}
7+
.navbar {
8+
height: 90px;
9+
padding: 0;
10+
}
711
.navbar-inverse .navbar-nav>.open>a,
812
.navbar-inverse .navbar-nav>.open>a:focus,
913
.navbar-inverse .navbar-nav>.open>a:hover,
1014
.navbar-inverse {
11-
background-color: #071525;
15+
background-image: linear-gradient(269.12deg, rgba(232, 52, 82, 1) 0%, rgba(136, 38, 125, 1) 51.26%, rgba(52, 57, 175, 1) 100%);
1216
}
1317
.navbar-brand, .navbar-fixed-top {
14-
padding: 0 15px 0 15px;
18+
padding: 0 30px 0 30px;
1519
}
1620
.navbar-inverse .navbar-nav>li>a {
1721
color: #ffffff;
1822
}
1923
.site-header__logo img {
20-
height: 50px;
24+
height: 90px;
2125
}
2226
.version-selector {
2327
font-size: 1.2rem
2428
}
29+
.table .thead-dark th {
30+
background-color: #323550;
31+
}
2532
.container {
2633
margin-right: auto;
2734
margin-left: auto;
2835
padding-left: 15px;
2936
padding-right: 15px;
3037
}
3138
.container-fluid {
32-
padding: 15px 15px;
39+
padding: 30px 30px;
3340
}
3441
.site-footer__copyright {
3542
text-align: center;
@@ -45,7 +52,7 @@ body {
4552
padding-left: 30px !important;
4653
}
4754
h1, h2, h3, h4, h5, h6 {
48-
color: #23527c;
55+
color: rgb(52 57 175);
4956
}
5057
h1 {
5158
font-size: 36px;

0 commit comments

Comments
 (0)