[CWM] Whiteboarding session to create API design

[lin-d-hop]

Track under CWM in clockify

Description

The new design of MM involves serving data over an API. We need to design the API - how the requests/response pairs will be formatted, languages and frameworks used etc.

We know that we want to serve the following from the MM BE: 1) Search by search term and/or prop filters (search query parameters -> array of indexes) N * category IDs + (optional) text fragment -> list of indexes http://blah/api/search/categories=A,B,C/text=D

2) Search by search term and/or prop filters (search query parameters + fields to return -> paginated array of objects)

3) Retrieve popup contents (index -> Html) http://blah/api/item/[index]

4) Retrieve full set of lng/lats ( _ -> JSON array)

Acceptance Criteria

• A meeting to design the API
• Issues created to complete this work
• Documentation of the design decisions made to support the team as implementation progresses.

[lin-d-hop]

Notes from meeting 20/8: https://docs.google.com/document/d/1aguAEMKfr8gqZRVkhJnb46VRJKd5wPMLLOQ1UmAKgFo/edit

Issues to be created:

• Create swagger spec from this document
• Investigate API validation libraries
• Build a shared types library to define the API and the types,
• Build mock dataset for responses and build unit tests

[rogup]

The issues have been created (see above) so this ticket can be closed.