User History Planning

Introduction

This document will go over the proposed structure for a history object for the species selector

Object Example Simple

This object will need to be changed to match the API structure. It holds the minimum set of things that should be remembered

Version 1

{
    "type": "object",
    "properties": {
        "state": {
            "type": "object",
            "properties": {
                "id": {"type":"integer"},
                "label": {"type":"string"}
            }
        },
        "region": {
            "type": "object",
            "properties": {
                "id": {"type":"integer"},
                "shorthand": {"type":"string"}
            }
        },
        "council": {
            "type": "object",
            "properties": {
                "label": {"type":"string"},
                "shorthand": {"type":"string"}
            }
        },
        "consent": {
            "type": "object",
            "properties": {
                "status": {"type":"boolean"}, // add back?
                "date": {"type":"string"},
            },
        }
    }
}

Version 2 (field based)

{
    "type": "object",
    "properties": {
        "state": {
            "type": "object",
            "properties": {
                "id": {"type":"integer"},
                "label": {"type":"string"},
                "shorthand": {"type":"string"} // add back?
            }
        },
        "region": {
            "type": "object",
            "properties": {
                "id": {"type":"integer"},
                "label": {"type":"string"}, // add back?
                "shorthand": {"type":"string"}
            }
        },
        "council": {
            "type": "object",
            "properties": {
                "id": {"type":"integer"}, // add back?
                "label": {"type":"string"},
                "shorthand": {"type":"string"}
            }
        },
        "goals": { // field based
            "type":"array",
            "items": {"type":"integer"}
        },
        "selectedCrops": { // field based
            "type":"array",
            "items": {"type":"integer"}
        },
        "consent": {
            "type": "object",
            "properties": {
                "status": {"type":"boolean"}, // add back?
                "date": {"type":"string"},
            },
        }
    }
}

Questions

Do we want to store soil conditions and weather? → yes, tied to field
Selected crops tied to field or not?
Do we want to store sidebar → my impression is no, need to get more feedback