Add API endpoint to get revisions with CVEs data

[bartaz]

Done

• renames previous /api/cve/[SNAP] endpoints to /api/[SNAP]/cves for consistency with other snap based endpoints
• replaces previous endpoint that only checked for CVEs availability with an endpoint that returns list of revisions that have CVEs data

Current CVEs endpoints are:

• /api/[SNAP]/cves - returns list of revisions that have CVEs data, or error if not found
• /api/[SNAP]/[REVISION/cves - returns list of revisions for given revision of a snap

How to QA

• go to demo, and sign in (ideally with canonical account with superuser access)
• check cves endpoint for a snap that doesn't have data, it should error: https://snapcraft-io-5108.demos.haus/api/firefox/cves
• check CVEs endpoint for a snap that has CVE data: https://snapcraft-io-5108.demos.haus/api/docker/cves
• take one of the revisions from the list in previous step, and check if it returns CVEs: https://snapcraft-io-5108.demos.haus/api/docker/3213/cves

Testing

• This PR has tests
• No testing required (explain why):

Issue / Card

Fixes WD-21559

[webteam-app]

Demo

Jenkins

demos.haus

[Copilot]

Pull Request Overview

This PR refactors the existing CVE API endpoints to improve consistency and functionality by renaming endpoints and updating the logic to return a list of revisions that have CVEs data rather than a simple boolean value.

• Updated URL routes in views to follow a consistent naming pattern.
• Renamed and refactored CVE API functions and helper methods to support returning revision numbers.
• Updated test cases to reflect the new endpoint behavior and naming.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
webapp/publisher/snaps/views.py	Updated API URL rules to match the new endpoint structure.
webapp/publisher/cve/cve_views.py	Renamed function and updated logic to return revisions with CVEs.
webapp/publisher/cve/cve_helper.py	Refactored helper to retrieve revision YAML files under the snap-cves folder.
tests/publisher/cve/test_has_cve_api.py	Updated tests to use the new endpoint and mocked return values.
tests/publisher/cve/test_has_cve.py	Renamed test class and updated tests for the new revisions retrieval.

Comments suppressed due to low confidence (1)

webapp/publisher/cve/cve_helper.py:114

• [nitpick] The function name 'has_revisions_with_cves' implies a boolean return value, but it actually returns a list of revision numbers. Consider renaming it to 'get_revisions_with_cves' for clarity.

def has_revisions_with_cves(snap_name):

[steverydz]

In the API response where there is an error, we usually use message instead of error, although I think error makes more sense, so perhaps we should continue with that going forwards?

[steverydz]

LGTM 👍

Just one small comment and a question/statement

[steverydz]

In other APIs we use data for the main data in the request, so in this case it would be "data": { "revisions": ... }

There are places we don't do that but they are older endpoints from before we started doing this.

[bartaz]

In the API response where there is an error, we usually use message instead of error, although I think error makes more sense, so perhaps we should continue with that going forwards?

I guess consistency matters most at this point, so I'll update accordingly. But is is a potential space for future clean-up and maybe documenting it.

[Copilot]

Pull Request Overview

This PR adds a new API endpoint to retrieve a list of snap revisions that include CVEs data and updates the URL patterns and supporting logic accordingly. Key changes include:

• Renaming and updating API routes for CVE-related endpoints in the publisher views.
• Refactoring the CVE helper function to return a list of revision numbers instead of a boolean.
• Updating tests to match the new endpoint names and functionality.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
webapp/publisher/snaps/views.py	Updated API routes to use the new endpoint naming convention.
webapp/publisher/cve/cve_views.py	Renamed and refactored the view function to return revisions data.
webapp/publisher/cve/cve_helper.py	Modified helper to fetch revisions with CVEs from file metadata.
tests/publisher/cve/test_has_cve_api.py	Updated tests to assert the new revisions data returned by the endpoint.
tests/publisher/cve/test_has_cve.py	Modified tests to reflect the change from boolean to list output.