CycloneDX / CycloneDX/specification

docs tool issues for JSON produces duplicate id

Open
#1,076 1 comment 0 reactions 1 assignee Claimed by @jkowalleck View on GitHub
defect documentation format: JSON
Dominant language
XSLT
Stars
547
Forks
93
Avg merge
7h 11m
Merged PRs (30d)
37

Description

the JSON docs tool produces duplicate ids.

this does not affect the click-ability of an element in the rendered docs,
but it affects the linkablility.

for example, when clicking on `$.components[].mimetype` it changes the browser's location bar to "https://cyclonedx.org/docs/1.7/json/#metadata_tools_oneOf_i0_components_items_mime-type"

this is due to these duplicate ids, see occurrence of "metadata_tools_oneOf_i0_components_items_mime-typ" - it appears 8 times.

```shellSession
$ wget -O - https://cyclonedx.org/docs/1.7/json/ \
| grep -ow 'id="metadata_tools_oneOf_i0_components_items_mime-type"' \
| wc -l
2
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.