From 0abe26ffd34d3c945a4b721d7b579c52cf310ea5 Mon Sep 17 00:00:00 2001 From: Sam Rice Date: Sun, 7 Jul 2024 11:57:37 -0700 Subject: [PATCH] feat: update api documentation yaml (tree and capture response objects) --- docs/api/spec/query-api.yaml | 57 +++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/docs/api/spec/query-api.yaml b/docs/api/spec/query-api.yaml index 4c96f9e..26ada00 100644 --- a/docs/api/spec/query-api.yaml +++ b/docs/api/spec/query-api.yaml @@ -1302,43 +1302,46 @@ components: maxItems: 2 description: 2 points defining the bounding box tree: - description: a single tree object + description: A single tree object type: object x-examples: {} title: '' properties: id: type: number - photo_url: - type: string - verified: - type: boolean - token_id: - type: string - created_at: + latest_capture_id: + type: number + image_url: type: string lat: type: number lon: type: number - species_id: - type: number - planter_id: - type: number + estimated_geometric_location: + type: string gps_accuracy: type: number - capture_id: + morphology: type: string - description: "In the public.trees table, it's the uuid column" - capture_approval_tag: + age: + type: number + created_at: type: string - domain_specific_data: - type: object - morphology: + updated_at: type: string - rejection_reason: + estimated_geographic_location: type: string - age: + status: + type: string + attributes: + type: string + species_id: + type: number + species_name: + type: string + species_description: + type: string + country_name: type: string country: description: '' @@ -1556,7 +1559,7 @@ components: phone: type: string capture: - description: '' + description: A tree photo capture and its associated data package, representing a tree at a given moment in time type: object properties: id: @@ -1569,6 +1572,18 @@ components: type: string image_url: type: string + grower_id: + type: number + growing_organization_id: + type: number + token_id: + type: number + approved: + type: boolean + wallet_id: + type: number + wallet_name: + type: string grower_account: description: '' type: object