Change certified API to use the v2 API endpoints

[andrejvelichkovski]

Done

• [List of work items including drive-bys - remember to add the why and what of this work.]

This change updates the certified component to use the new public v2 API our team has already created, instead of the old v1 API. For the v2 API we are using a new REST API framework, which allows us to make the new endpoints significantly more flexible and modular. After finishing all migrations from the old v1 API and ensuring no external users make use of them, we will start with the deprecation of these endpoints.

API client change

As part of this change, we are also slightly modifying the terminology used in the API endpoints. Namely, we are starting to deprecate the use of the model keyword in the endpoints, replacing it with configuration which is what the Certification team currently uses in the business works. Similarly, the make keyword is replaced with the vendor keyword, as this is what reflects the data represented in this field. To minimize the effect of the migration of the API endpoints, we tried to keep the endpoints as backwards-compatible as possible and decided to not change the response structure.

The following seven APIs have been updated and replaces with v2:

v1 API endpoint	v2 API endpoint
/api/v1/certifiedmodels	/api/v2/certified-configurations
/api/v1/certifiedmodeldetails	/api/v2/certified-configuration-details
/api/v1/certifiedmodeldevices	/api/v2/certified-configuration-devices
/api/v1/certifiedreleases	/api/v2/certified-releases
/api/v1/certifiedmakes	/api/v2/certified-vendors
/api/v1/componentsummaries	/api/v2/component-summaries
/api/v1/componentsummaries/ID	/api/v2/component-summaries/ID

Backend views change

Some of the views are slightly modified to reflect for the new response structure of the APIs. Few common changes appearing in the views:

• the total count of objects in the response are now stored under the count field, instead of meta.total_count field in the v1 API
• the list of objects in the response are now stored in the results field, instead of the objects in the v1 API
• the v2 API is paginated using page-numbers by default, but we have provided limit-offset pagination on top of this, which can be specified with the pagination=limitoffset query parameter, which is put in use in the api client.

QA

• Go to https://ubuntu-com-13827.demos.haus/certified
• View the site locally in your web browser at: http://0.0.0.0:8001/
  • Be sure to test on mobile, tablet and desktop screen sizes
• [List additional steps to QA the new features or prove the bug has been resolved]

Issue / Card

This change fixes C3-614

Screenshots

The design of the website hasn't changed.

Help

QA steps - Commit guidelines

[webteam-app]

andrejvelichkovski is not a collaborator of the repo

Demo: https://ubuntu-com-13827.demos.haus/

[carkod]

Can we remove this line? is it necessary?

[andrejvelichkovski]

Thanks for catching this! I have now updated the code to remove this line.