Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document new without_vulnerability_details option for software versions endpoint #24246

Merged
merged 3 commits into from
Dec 5, 2024

Conversation

ksykulev
Copy link
Contributor

#23679

In order to improve performance on the software version endpoint the option without_vulnerability_details has been added. It can be set to true to decrease the size of the response.

On the free tier setting this option to false will have no effect. On Fleet Premium setting it to false or omitting will include verbose vulnerability details.

@ksykulev
Copy link
Contributor Author

Currently in Fleet Premium the software versions endpoint returns verbose details about vulnerabilities. In an effort to keep backwards compatibility in Fleet Premium this option is named in its "negative form", rather than include_vulnerability_details. Omitting it or setting it to false will return full vulnerability details (the current default for Fleet Premium).

However, the front end application will be passing this option as true by default for both the free tier and Fleet Premium, thereby increasing the performance by default.

Copy link

codecov bot commented Nov 30, 2024

Codecov Report

Attention: Patch coverage is 50.02872% with 870 lines in your changes missing coverage. Please review.

Project coverage is 63.44%. Comparing base (22ff501) to head (28f6b19).
Report is 14 commits behind head on docs-v4.61.0.

Files with missing lines Patch % Lines
orbit/pkg/luks/luks_linux.go 0.00% 208 Missing ⚠️
server/mdm/nanomdm/push/nanopush/nanopush.go 0.00% 52 Missing ⚠️
orbit/pkg/execuser/execuser_linux.go 0.00% 51 Missing ⚠️
server/mdm/nanomdm/http/mdm/mdm_cert.go 39.47% 40 Missing and 6 partials ⚠️
server/mdm/nanomdm/cmd/nanomdm/main.go 0.00% 45 Missing ⚠️
server/mdm/nanomdm/http/authproxy/authproxy.go 0.00% 45 Missing ⚠️
server/mdm/nanomdm/push/nanopush/provider.go 61.00% 31 Missing and 8 partials ⚠️
orbit/pkg/zenity/zenity.go 69.79% 29 Missing ⚠️
server/mdm/nanomdm/http/api/api.go 0.00% 17 Missing and 4 partials ⚠️
cmd/fleet/serve.go 0.00% 19 Missing ⚠️
... and 54 more
Additional details and impacted files
@@               Coverage Diff                @@
##           docs-v4.61.0   #24246      +/-   ##
================================================
+ Coverage         63.16%   63.44%   +0.28%     
================================================
  Files              1560     1580      +20     
  Lines            148469   150290    +1821     
  Branches           3736     3770      +34     
================================================
+ Hits              93777    95355    +1578     
- Misses            47289    47342      +53     
- Partials           7403     7593     +190     
Flag Coverage Δ
backend 64.31% <50.03%> (+0.30%) ⬆️
frontend 52.55% <50.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@iansltx
Copy link
Member

iansltx commented Nov 30, 2024

@ksykulev Please rebase your commit on top of this branch. It's behind main enough that catching it up should be its own PR.

@ksykulev
Copy link
Contributor Author

ksykulev commented Dec 2, 2024

Not sure what happened here, looks like some sort of bad rebase or merge?

@ksykulev
Copy link
Contributor Author

ksykulev commented Dec 2, 2024

Also looks like https://github.com/fleetdm/fleet/tree/docs-v4.61.0 is 144 commits behind main (docs-v4.61.0...main)

…ns endpoint

In order to improve performance on the software version endpoint the
option `without_vulnerability_details` has been added. It can be set to
true to decrease the size of the response.

On the free tier setting this option to `false` will have no effect. On
Fleet Premium setting it to `false` or omitting will include verbose
vulnerability details.
docs/REST API/rest-api.md Outdated Show resolved Hide resolved
docs/REST API/rest-api.md Outdated Show resolved Hide resolved
ksykulev and others added 2 commits December 5, 2024 15:48
@rachaelshaw rachaelshaw merged commit 42aa660 into docs-v4.61.0 Dec 5, 2024
5 checks passed
@rachaelshaw rachaelshaw deleted the 23679-docs branch December 5, 2024 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants