issy/intel-ark-api

A REST API for the Intel product catalogue, written in Go.

intel-ark-api's Issues

[FEAT] Add CI

Description

Build and testing workflows would be nice to have, to ensure that the code in the repo is of good quality and works as expected. It would also be useful to have unit tests for this purpose.

DOD

• Add linting/formatting workflow
• Add workflow to check that the project builds properly
• Add unit tests and appropriate workflows

[FEAT] Response pagination

Description

Add pagination query params onto the search endpoint. Currently the initial product IDs query is limited to 50. It would be best to remove the limit on the query and instead handle pagination after we have all the product IDs; so that we can provide response metadata such as number of results, limit, offset.

DOD

• Query params added to search endpoint
• Additional metadata provided in response
• Docs updated

[FEAT] Add product type filtering

Description

The Ark database contains many different types of product; including NICs, CPUs, NUCs and many more. There must be a way to distinctly categorise product entries in the database, even if it's not exhaustive. We may only be able to successfully identify NICs and CPUs, but that would still be better than nothing.

As an extension of this, it would be useful to add query params to the search endpoint to filter by a type of product (or even multiple).

It may be that the only way of identifying the type of a product is by checking certain specification fields in the product data. This has the potential to be very time consuming in a large set of products, in which case the outcome may not be desirable. Investigation is needed in this area.

DOD

• Determine which products can be identified by type
• Implement a way of only including products of X type or XY types in a search response