Skip to content

Commit

Permalink
Fix miscellaneous typos
Browse files Browse the repository at this point in the history
While HTTP headers are case-insensitive, these changes align the examples with the rest of the documentation and source code.

Signed-off-by: Steven Buccini <[email protected]>
  • Loading branch information
stevenbuccini committed Jan 12, 2025
1 parent 16a4edf commit a676d0a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/_docs/integrations/badges.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Dependency-Track supports badges in Scalable Vector Graphics (SVG) format. Suppo
basis via permission or globally for unauthenticated access.

To enable badges for a team, activate the permission `VIEW_BADGES`. To deactivate badges, remove the permission. To
retrieve a badge, use a team's API key either in the badge API header `X-API-Key` or in the URI parameter `apiKey`.
retrieve a badge, use a team's API key either in the badge API header `X-Api-Key` or in the URI parameter `apiKey`.

As an alternative, badges can also be accessed without authentication. On new Dependency-Track installations, this is
disabled by default. On Dependency-Track installations updated from &leq; v4.11, where (unauthenticated) badge support
Expand Down
4 changes: 2 additions & 2 deletions docs/_docs/usage/cicd.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ BOM and insert the resulting text into the 'bom' field.
```bash
curl -X "PUT" "http://dtrack.example.com/api/v1/bom" \
-H 'Content-Type: application/json' \
-H 'X-API-Key: LPojpCDSsEd4V9Zi6qCWr4KsiF3Konze' \
-H 'X-Api-Key: LPojpCDSsEd4V9Zi6qCWr4KsiF3Konze' \
-d $'{
"project": "f90934f5-cb88-47ce-81cb-db06fc67d4b4",
"bom": "PD94bWwgdm..."
Expand All @@ -56,7 +56,7 @@ containing a payload may be preferred.
```bash
curl -X "PUT" "http://dtrack.example.com/api/v1/bom" \
-H 'Content-Type: application/json' \
-H 'X-API-Key: LPojpCDSsEd4V9Zi6qCWr4KsiF3Konze' \
-H 'X-Api-Key: LPojpCDSsEd4V9Zi6qCWr4KsiF3Konze' \
-d @payload.json
```

Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/usage/collection-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ Instead they show a list of projects contained in this collection and their metr

![collection projects details](/images/screenshots/collection-projects-details.png)

Collection projects can be easily identified via the "culculator" icon, and hovering it
Collection projects can be easily identified via the "calculator" icon, and hovering it
displays the applied collection logic.

0 comments on commit a676d0a

Please sign in to comment.