v5: API endpoint GET /api/v1/project returned only a subset of the project properties

[mulder999]

Current Behavior

According to document, the project should include properties such as children, lastBomImport, isLatest, ... but it is not.

Steps to Reproduce

Example query
/api/v1/project?onlyRoot=true&pageSize=1&pageNumber=1

Expected Behavior

• All properties returned according to specs
• [OR] documented breaking change

Dependency-Track Version

5.x

Browser

N/A

Checklist

• I have read and understand the contributing guidelines
• I have checked the existing issues for whether this defect was already reported

[nscuro]

lastBomImport and isLatest are returned, but they are omitted when null, which matches v4 behavior.

Added missing response fields via #6275 and documented the removal of children via DependencyTrack/docs#130.

[mulder999]

@nscuro Thanks for the quick update! Just to clarify, the onlyRoot parameter was being used specifically to determine whether children should be populated. I think this might have been overlooked in the latest changes.

Please reopen the ticket.

My bad, this is just to filter out elements returned.

[nscuro]

We could add a hasChildren boolean flag instead, which gives you the info you want without us having to embed unbounded collections of large objects in the response.

[mulder999]

To complete my previous message: The onlyRoot used to have a side effect to load children in v4. But according to @nscuro, this is no longer going to happen.

@nscuro thanks for proposal I believe this could allow to avoid going to /project/concise to get that info, hence save some queries to some people. For us it is just an unit test that was breaking but we have no actual code that still rely on it.