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

Return API and scanner version in the json output #265

Closed
demeringo opened this issue Apr 29, 2023 · 3 comments · Fixed by #639
Closed

Return API and scanner version in the json output #265

demeringo opened this issue Apr 29, 2023 · 3 comments · Fixed by #639
Labels
enhancement New feature or request
Milestone

Comments

@demeringo
Copy link
Collaborator

Problem

As the underlying Boavizta API may evolve over time, it becomes difficult to compare results of cloud scanner (they may vary depending on the improvements on the API itself).

The same thing may be true for the scanner, if the calclulation method evolves for example.

Solution

The scanner should return some metadata in addition to the values/estimations provided in the json output.

Alternatives

Additional context or elements

Not sure if the API returns it's version or other metadata on a given route.

  1. Verify if info exists in a easy to consume way (or maybe implement it) on the API
  2. Add it to the output of cloud-scanner
@demeringo
Copy link
Collaborator Author

API version maybe should be picked up directly from the openapi spec.

@demeringo
Copy link
Collaborator Author

Fetch API version directly from the API once Boavizta/boaviztapi#326 and Boavizta/boaviztapi#299 have been released.

Implies to regenerate an API client SDK (which should be done anyway for #576).

@demeringo
Copy link
Collaborator Author

We should implement it now that we have a route on the API that returns it's version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants