Document breaking changes in REST API v1#106
Merged
Merged
Conversation
Signed-off-by: nscuro <nscuro@protonmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new API reference page that enumerates the breaking changes between Dependency-Track v4 and v5 in REST API v1, and links to it from the conceptual v5 changes overview.
Changes:
- New
docs/reference/api/v5-breaking-changes.mdwith a removed-endpoints table, cross-cutting changes, and per-resource breaking-change details. - Registers the new page under the API Reference navigation via
docs/reference/api/.pages. - Replaces several REST-API-specific bullets in
docs/concepts/changes-in-v5.mdwith a single pointer to the new page.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/reference/api/v5-breaking-changes.md | New reference page enumerating v1 breaking changes in v5. |
| docs/reference/api/.pages | Adds the new page to the API Reference navigation. |
| docs/concepts/changes-in-v5.md | Replaces three REST API-specific bullets with a single link to the new page. |
💡 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.
No description provided.