Yaml Documentation Update (tree and capture response objects)

[sam-rice]

Description

This branch updates the OpenAPI documentation for the tree and capture response objects according to the v2 domain model and project discussion on 7/04/24.

Details

The tree and capture database tables specified in the v2 domain model do not include a number of fields that the web map client relies on:

• grower_id
• growing_organization_id
• country_name
• token_id
• approved
• species_name
• species_desc
• wallet_name
• wallet_id

Since the denormalized response objects coming from the query api have not been specified, a discussion was required to decide where these missing fields would likely come from. A number of decisions were made during the 7/04/24 meeting, but changes will be ongoing as v2 development progresses.

As of now:

• Because the Greenstand product changes (v2) will allow a single tree to be cared for and sponsored by different growers and organizations at different stages of the tree's life, data specific to growers, wallets, and organizations will be part of the capture entity only. trees are more dynamic entities that may change over time.
• Species data:
  • Because species information can be updated during the capture verification process (if a tree were previously misidentified, for example), future discussions will need to address how tree.species_id in the tree database table will stay updated.
  • species_desc and species_name fields may end up coming from a client-side request to the herbarium api in the future, but will be included on the tree response object, for now.

@dadiorchen 's Slack notes from 7/04/24 meeting: