Update package metadata resolution design doc#56
Merged
Conversation
Adds section about conditional requests and fixes all linter warnings on the page. Signed-off-by: nscuro <nscuro@protonmail.com>
3 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the package metadata resolution design documentation to better describe how Dependency-Track reduces upstream load, including the use of HTTP conditional requests, and adjusts the Vale vocabulary to eliminate linter warnings triggered by newly used terminology.
Changes:
- Expanded the design doc with a section describing conditional requests (ETag/Last-Modified) and a shared HTTP-resource cache.
- Reworded several sections for clarity/consistency across the workflow, concurrency, and resiliency descriptions.
- Updated the Vale accepted vocabulary list to consolidate singular/plural forms via regex patterns (e.g.,
SBOMs?,ETags?).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/concepts/architecture/design/package-metadata-resolution.md | Adds/clarifies conditional request + cache behavior and refines wording throughout the design doc. |
| .vale/styles/config/vocabularies/DependencyTrack/accept.txt | Updates accepted terms to address Vale warnings (notably ETag-related terminology and pluralization). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds section about conditional requests and fixes all linter warnings on the page.
Related API server PR: DependencyTrack/hyades-apiserver#2086