Add meta:enum desriptions for Tasktypes

README.md

@@ -68,9 +68,9 @@ The officially supported media type for Protocol Buffer format is `application/x
 ## Related Work
 [SPDX (Software Package Data Exchange)][spdx-url] is a specification that provides low-level details of components, including all files, hashes, authors, and copyrights. SPDX also defines over 300 open source license IDs. CycloneDX builds on top of the work SPDX has accomplished with license IDs, but varies greatly in its approach towards building a software bill of material specification.
 
-[SWID (ISO/IEC 19770-2:2015)][swid-url] is used primarily to identify installed software and is the preferred format of the NVD. SWID tags are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification compliments this work as CycloneDX documents can incorporate SWID tags and other high-level SWID metadata and optionally include entire SWID documents. Use of SWID tag ID's are useful in determining if a specific component has known vulnerabilities.
+[SWID (ISO/IEC 19770-2:2015)][swid-url] is used primarily to identify installed software and is the preferred format of the NVD. SWID tags are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification complements this work as CycloneDX documents can incorporate SWID tags and other high-level SWID metadata and optionally include entire SWID documents. Use of SWID tag ID's are useful in determining if a specific component has known vulnerabilities.
 
-[CPE (Common Platform Enumeration)][cpe-url] is a specification that describes the vendor, name, and version for an application, operating system, or hardware device. CPE identifiers are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification compliments this work as CycloneDX documents can easily be used to construct exact CPE identifiers that are useful in determining if a specific component has known vulnerabilities.
+[CPE (Common Platform Enumeration)][cpe-url] is a specification that describes the vendor, name, and version for an application, operating system, or hardware device. CPE identifiers are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification complements this work as CycloneDX documents can easily be used to construct exact CPE identifiers that are useful in determining if a specific component has known vulnerabilities.
 
 ## Copyright & License
 

docgen/ecma/gen.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+rm -f -R docs temp out
+mkdir -p docs temp
+cp ../../schema/bom-1.6.schema.json temp
+cp ../../schema/jsf-0.82.schema.json temp
+cp ../../schema/spdx.schema.json temp
+
+# Check to see if jsonschema2md is executable and is in the path. If not, install jsonschema2md.
+if ! [ -x "$(command -v jsonschema2md)" ]; then
+  npm install -g @adobe/jsonschema2md
+fi
+
+echo Generating Ecma Documentation
+jsonschema2md -d temp -o docs
+rm -f -R temp out

docgen/json/gen.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
 rm -f -R docs
-mkdir -p docs/{1.2,1.3,1.4,1.5}
+mkdir -p docs/{1.2,1.3,1.4,1.5,1.6}
 
 # Check to see if generate-schema-doc is executable and is in the path. If not, install JSON Schema for Humans.
 if ! [ -x "$(command -v generate-schema-doc)" ]; then
-  pip3 install json-schema-for-humans==0.44.3
+  pip3 install json-schema-for-humans==0.47
 fi
 
 generate () {
@@ -27,4 +27,5 @@ generate () {
 generate 1.2
 generate 1.3
 generate 1.4
-generate 1.5
+generate 1.5
+generate 1.6

docgen/json/templates/cyclonedx/content.html

@@ -17,13 +17,17 @@
 
         {# Display type #}
         {%- if not schema is combining -%}
-            <span class="badge value-type">Type: {{ type_name }}</span>
+            <span class="badge badge-dark value-type">Type: {{ type_name }}</span>
+        {%- endif -%}
+
+        {%- if schema.format -%}
+            <span class="badge badge-info value-type">Format: {{ schema.format }}</span>
         {%- endif -%}
 
         {# Display default #}
         {%- set default_value = schema.default_value -%}
         {%- if default_value -%}
-            {{ " " }}<span class="badge default-value">Default: {{ default_value }}</span>
+            {{ " " }}<span class="badge badge-success default-value">Default: {{ default_value }}</span>
         {%- endif -%}
         <br/>
 
@@ -37,80 +41,78 @@
     {%- elif schema.refers_to -%}
         {{ content(schema.refers_to_merged, True) }}
     {%- else -%}
-        {# Handle having oneOf or allOf with only one condition #}
-        {%- if schema.kw_all_of and (schema.kw_all_of.array_items | length) == 1 -%}
-            {{ content(schema.kw_all_of.array_items[0]) }}
-        {%- elif schema.kw_any_of and (schema.kw_any_of.array_items | length) == 1 -%}
-            {{ content(schema.kw_any_of.array_items[0]) }}
-        {%- else -%}
-            {%- if schema.explicit_no_additional_properties -%}
-                {{ " " }}<span class="badge no-additional">No Additional Properties</span>
-            {%- endif -%}
-
-            {# Combining: allOf, anyOf, oneOf, not #}
-            {%- if schema.kw_all_of -%}
-                <div class="all-of-value" id="{{ schema.kw_all_of.html_id }}">{{ tabbed_section("allOf", schema.kw_all_of) }}</div>
-            {%- endif -%}
-            {%- if schema.kw_any_of -%}
-                <div class="any-of-value" id="{{ schema.kw_any_of.html_id }}">{{ tabbed_section("anyOf", schema.kw_any_of) }}</div>
-            {%- endif -%}
-            {%- if schema.kw_one_of -%}
-                <div class="one-of-value" id="{{ schema.kw_one_of.html_id }}">{{ tabbed_section("oneOf", schema.kw_one_of) }}</div>
-            {%- endif -%}
-            {%- if schema.kw_not -%}
-                {% include "section_not.html" %}
-            {%- endif -%}
-
-            {# Enum and const #}
-            {%- if schema.kw_enum -%}
-                <div class="enum-value" id="{{ schema.kw_enum.html_id }}">
-                <h4>Must be one of:</h4>
-                <ul class="list-group">
-                {%- for enum_choice in schema.kw_enum.array_items -%}
-                    <li class="list-group-item enum-item">{{ enum_choice.literal | python_to_json }}</li>
-                {%- endfor -%}
-                </ul>
-                </div>
-            {%- endif -%}
-            {%- if schema.kw_const -%}
-                <span class="const-value" id="{{ schema.kw_const.html_id }}">Specific value: <code>{{ schema.kw_const.raw | python_to_json }}</code></span>
-            {%- endif -%}
+        {%- if schema.explicit_no_additional_properties -%}
+            {{ " " }}<span class="badge badge-info no-additional">No Additional Properties</span>
+        {%- endif -%}
 
-            {# Pattern (Regular Expression) #}
-            {%- if schema.kw_pattern -%}
-                <span class="pattern-value" id="{{ schema.kw_pattern.html_id }}">Must match regular expression: <code>{{ schema.kw_pattern.literal | escape }}</code></span>
-            {%- endif -%}
+        {# Combining: allOf, anyOf, oneOf, not #}
+        {%- if schema.kw_all_of -%}
+            <div class="all-of-value" id="{{ schema.kw_all_of.html_id }}">{{ tabbed_section("allOf", schema.kw_all_of) }}</div>
+        {%- endif -%}
+        {%- if schema.kw_any_of -%}
+            <div class="any-of-value" id="{{ schema.kw_any_of.html_id }}">{{ tabbed_section("anyOf", schema.kw_any_of) }}</div>
+        {%- endif -%}
+        {%- if schema.kw_one_of -%}
+            <div class="one-of-value" id="{{ schema.kw_one_of.html_id }}">{{ tabbed_section("oneOf", schema.kw_one_of) }}</div>
+        {%- endif -%}
+        {%- if schema.kw_not -%}
+            {% include "section_not.html" %}
+        {%- endif -%}
 
-            {# Conditional subschema, or if-then-else section #}
-            {%- if schema.has_conditional -%}
-                {% include "section_conditional_subschema.html" %}
-            {%- endif -%}
+        {# Enum and const #}
+        {%- if schema.kw_enum -%}
+            <div class="enum-value" id="{{ schema.kw_enum.html_id }}">
+            <h4>Must be one of:</h4>
+            <ul class="list-group">
+            {%- for enum_choice in schema.kw_enum.array_items -%}
+                <li class="list-group-item enum-item">
+                    {%- if schema.kw_meta_enum -%}<strong>{%- endif -%}
+                    {{ enum_choice.literal | python_to_json }}
+                    {%- if schema.kw_meta_enum -%}</strong>
+                        : {{ (schema.enum_description(enum_choice.literal) | get_description_literal) }}
+                    {%- endif -%}
+                </li>
+            {%- endfor -%}
+            </ul>
+            </div>
+        {%- endif -%}
+        {%- if schema.kw_const -%}
+            <span class="const-value" id="{{ schema.kw_const.html_id }}">Specific value: <code>{{ schema.kw_const.raw | python_to_json }}</code></span>
+        {%- endif -%}
 
-            {# Required properties that are not defined under "properties". They will only be listed #}
-            {% include "section_undocumented_required_properties.html" %}
+        {# Pattern (Regular Expression) #}
+        {%- if schema.kw_pattern -%}
+            <span class="pattern-value" id="{{ schema.kw_pattern.html_id }}">Must match regular expression: <code>{{ schema.kw_pattern.literal | escape }}</code></span>
+        {%- endif -%}
 
-            {# Show the requested type(s) #}
-            {% include "badge_type.html" %}
+        {# Conditional subschema, or if-then-else section #}
+        {%- if schema.has_conditional -%}
+            {% include "section_conditional_subschema.html" %}
+        {%- endif -%}
 
-            {# Show array restrictions #}
-            {%- if type_name.startswith("array") -%}
-                {% include "section_array.html" %}
-            {%- endif -%}
+        {# Required properties that are not defined under "properties". They will only be listed #}
+        {% include "section_undocumented_required_properties.html" %}
 
-            {# Display examples #}
-            {%- set examples = schema.examples -%}
-            {%- if examples -%}
-                {% include "section_examples.html" %}
-            {%- endif -%}
+        {# Show the requested type(s) #}
+        {% include "badge_type.html" %}
 
-            {# Properties, pattern properties, additional properties #}
-            {%- for sub_property in schema.iterate_properties -%}
-                {# Custom modification to remove $ properties from documentation #}
-                {%- if not sub_property.property_display_name.startswith("$") -%}
-                    {% include "section_properties.html" %}
-                {%- endif -%}
-            {%- endfor -%}
+        {# Show array restrictions #}
+        {%- if type_name.startswith("array") -%}
+            {% include "section_array.html" %}
+        {%- endif -%}
 
+        {# Display examples #}
+        {%- set examples = schema.examples -%}
+        {%- if examples -%}
+            {% include "section_examples.html" %}
         {%- endif -%}
+
+        {# Properties, pattern properties, additional properties #}
+        {%- for sub_property in schema.iterate_properties -%}
+            {# Custom modification to remove $ properties from documentation #}
+            {%- if not sub_property.property_display_name.startswith("$") -%}
+                {% include "section_properties.html" %}
+            {%- endif -%}
+        {%- endfor -%}
     {%- endif -%}
 {%- endmacro -%}

docgen/json/templates/cyclonedx/schema_doc.js

@@ -19,7 +19,7 @@ function setAnchor(anchorLinkDestination) {
 
 function anchorOnLoad() {
     // Added to onload on body, checks if there is an anchor link and if so, expand
-    let linkTarget = window.location.hash.split("?")[0].split("&")[0];
+    let linkTarget = decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);
     if (linkTarget[0] === "#") {
         linkTarget = linkTarget.substr(1);
     }
@@ -37,7 +37,7 @@ function anchorLink(linkTarget) {
             if($( this ).hasClass("collapse")) {
                 $( this ).collapse("show");
             } else if ($( this ).hasClass("tab-pane")) {
-                // We have the pane and not the the tab itself, find the tab
+                // We have the pane and not the tab itself, find the tab
                 const tabToShow = $( "a[href='#" + $( this ).attr("id") + "']" );
                 if (tabToShow) {
                     tabToShow.tab("show");

docgen/json/templates/cyclonedx/section_array.html

@@ -7,6 +7,9 @@
 {%- if schema.kw_unique_items and schema.kw_unique_items.literal == True -%}
     {{ restriction("All items must be unique", "unique-items", schema.kw_unique_items.html_id) }}
 {%- endif -%}
+{%- if not schema.array_additional_items -%}
+    {{ " " }}<span class="badge badge-info no-additional">No Additional Items</span>
+{%- endif -%}
 {%- if schema.array_items_def -%}
     <h4>Each item of this array must be:</h4>
     <div class="card">
@@ -34,4 +37,12 @@ <h4>At least one of the items must be:</h4>
             {{ content(schema.kw_contains) }}
         </div>
     </div>
+{%- endif -%}
+{%- if schema.array_additional_items_def -%}
+    <h4>All other items must be:</h4>
+    <div class="card">
+        <div class="card-body items-contain-definition" id="{{ schema.array_additional_items_def.html_id }}">
+            {{ content(schema.array_additional_items_def) }}
+        </div>
+    </div>
 {%- endif -%}

docgen/json/templates/cyclonedx/tabbed_section.html

@@ -11,7 +11,11 @@ <h2 class="handle">
             <a class="nav-link {% if loop.index == 1 -%}active {% endif -%} {{ operator }}-option"
                id="{{ node.html_id }}" data-toggle="tab" href="#tab-pane_{{ node.html_id }}" role="tab"
                onclick="setAnchor('#{{ node.html_id }}')"
-            >{{ node.definition_name or tab_label ~ " " ~ loop.index }}</a>
+            >{{ node.definition_name or tab_label ~ " " ~ loop.index }}
+                {%- if node is deprecated -%}
+                {{ " " }}<span class="badge deprecated-property">Deprecated</span>
+                {%- endif -%}
+            </a>
         </li>
     {%- endfor -%}
 </ul>

docgen/xml/gen.sh

@@ -16,4 +16,5 @@ generate 1.1
 generate 1.2
 generate 1.3
 generate 1.4
-generate 1.5
+generate 1.5
+generate 1.6