diff --git a/devdocs/specs/core-display-format-template-system.txt b/devdocs/specs/core-display-format-template-system.txt index 0c31ee2a..e6e6fb3b 100644 --- a/devdocs/specs/core-display-format-template-system.txt +++ b/devdocs/specs/core-display-format-template-system.txt @@ -1,8 +1,10 @@ DISPLAY FORMAT TEMPLATE SYSTEM SPECS OVERVIEW -Grids need a way to ensure you can see what you need on small devices as well they need to show the columns desired on larger devices +Narrow grids on small screens as well as picklists need to show a single field of information as required by that shop for selection, recognition etc so templated to format multiple return fields into one +Grids need a way to ensure you can see what you need on small devices as well they need to show the columns desired on larger devices +PickLists need a way to format what is returned for picking (with template) Display format template (aka name display format) templates are used for THREE purposes: - to customize what is shown in XS (<600px) single column grid and inside forms in drop down boxes order for a user to identify a record uniquely for selection purposes. diff --git a/devdocs/specs/core-main-grids.txt b/devdocs/specs/core-main-grids.txt index e11dd520..e01afc31 100644 --- a/devdocs/specs/core-main-grids.txt +++ b/devdocs/specs/core-main-grids.txt @@ -152,4 +152,68 @@ Download "columns":{ ...column definitions .... } +} + + +=-=-=-=-=-=- +PICKLIST FORMAT: +{ + "data": [ + { + "id": 93, + "name": "Awesome Cotton Sausages 117" + } + ], + "paging": { + "count": 100, + "offset": 0, + "limit": 1, + "first": "http://localhost:7575/api/v8/Widget/PickList?pageNo=1&pageSize=1", + "previous": null, + "next": "http://localhost:7575/api/v8/Widget/PickList?pageNo=1&pageSize=1", + "last": "http://localhost:7575/api/v8/Widget/PickList?pageNo=100&pageSize=1" + } +} + +... + +LIST format: + + +Response body +Download + +{ + "data": [ + { + "id": 100, + "concurrencyToken": 3903699, + "name": "Licensed Granite Cheese 124", + "serial": 100, + "dollarAmount": 764.57, + "active": true, + "roles": 8, + "startDate": "2020-01-13T11:54:35.30427Z", + "endDate": "2020-01-13T13:32:24.675256Z", + "notes": "Consequuntur odio itaque quaerat et aspernatur rerum quis. Nam et ex assumenda deleniti. Vel est eum non exercitationem doloremque eos. Nesciunt voluptas et.\n\nCupiditate voluptatem pariatur. Totam et velit labore fugiat repudiandae. Harum consequatur quaerat ducimus animi dolores repellat dolorum. Necessitatibus sapiente non eveniet fugiat. Soluta voluptatem nihil omnis. Quasi et saepe nulla alias illum dolorem necessitatibus ut veniam.\n\nId est ullam quis est velit esse accusantium voluptas consequatur. Nesciunt error ab hic officia ullam sit. Vel inventore voluptatibus nam iure aut velit ducimus repellendus enim. Quisquam consequatur unde.", + "count": null, + "customFields": "{\"c1\":\"2020-09-27T12:59:50.4196015Z\",\"c2\":\"Id voluptatem cum id veniam hic accusamus labore deserunt. Ut non et possimus maiores repudiandae quia ea. Harum quo eius dicta iste laborum culpa in cumque illo.\",\"c3\":41534342,\"c4\":true,\"c5\":0.081620920487503}", + "tags": [ + "jade", + "brown", + "quince", + "zone-6", + "zone-7" + ] + } + ], + "paging": { + "count": 100, + "offset": 0, + "limit": 1, + "first": "http://localhost:7575/api/v8/Widget/ListWidgets?pageNo=1&pageSize=1", + "previous": null, + "next": "http://localhost:7575/api/v8/Widget/ListWidgets?pageNo=1&pageSize=1", + "last": "http://localhost:7575/api/v8/Widget/ListWidgets?pageNo=100&pageSize=1" + } } \ No newline at end of file diff --git a/devdocs/todo.txt b/devdocs/todo.txt index 0fe8cf95..5cfd1673 100644 --- a/devdocs/todo.txt +++ b/devdocs/todo.txt @@ -19,6 +19,18 @@ CURRENT MASTER PLAN IN CLIENT TODO REALLY MAKING MORE PROGRESS WHEN CLIENT DEV DRIVES BACKEND DEV, STICK TO THAT!! ----------------------- +GRID LISTS TODO NOW: + - Turn PagingOptions object into ListOptions object + - Add list format option ("mini"=true thing) to ListOptions object + - It's prescence with mini=true means that the picklist format is returned + - Combine PickList route and WidgetList route into single "List" route with an internal nameof "WidgetList" + - if mini=true then it sends back the two column result templated + - Otherwise it sends back the full list (templated) + - NOTE: REPORT LIST will be it's own kettle of fish so to speak so don't concern about it now YAGNI TTM! + - Update tests when appropriate (when it's working fully and not mocked) + - Mock return objects for now with the new fields to include in the response see core-main-grids.txt and core-display-format-template-system.txt + + DO CLIENT STUFF NOW COME BACK TO THIS STUFF LATER TODO: the license being logged breaks the format of the log file because it has line breaks etc, so instead, maybe log out as a single line (remove breaks)