feat: soil id endpoints

terraso_backend/apps/graphql/schema/__init__.py

@@ -41,6 +41,7 @@
     SoilDataUpdateDepthIntervalMutation,
     SoilDataUpdateMutation,
 )
+from apps.soil_id.graphql.soil_id import SoilID
 
 from .audit_logs import AuditLogNode
 from .commons import TerrasoRelayNode
@@ -141,6 +142,7 @@ class Query(graphene.ObjectType):
     sites = DjangoFilterConnectionField(SiteNode, required=True)
     audit_logs = DjangoFilterConnectionField(AuditLogNode)
     shared_resource = SharedResourceRelayNode.Field()
+    soil_id = graphene.Field(SoilID, required=True)
     from .shared_resources import resolve_shared_resource
 
 

terraso_backend/apps/graphql/schema/schema.graphql

@@ -90,6 +90,7 @@ type Query {
     orderBy: String
   ): AuditLogNodeConnection
   sharedResource(shareUuid: String!): SharedResourceNode
+  soilId: SoilID!
 }
 
 type GroupNode implements Node {
@@ -1527,6 +1528,106 @@ String, Boolean, Int, Float, List or Object.
 """
 scalar GenericScalar
 
+"""Soil ID algorithm queries."""
+type SoilID {
+  locationBasedSoilMatches(latitude: Float!, longitude: Float!): LocationBasedSoilMatches!
+  dataBasedSoilMatches(latitude: Float!, longitude: Float!, data: SoilIDInputData!): DataBasedSoilMatches!
+}
+
+"""A ranked group of soil matches based solely on a coordinate pair."""
+type LocationBasedSoilMatches {
+  matches: [LocationBasedSoilMatch]!
+}
+
+"""A soil match based solely on a coordinate pair."""
+type LocationBasedSoilMatch {
+  soilInfo: SoilInfo!
+  match: SoilMatch!
+}
+
+"""Provides information about soil at a particular location."""
+type SoilInfo {
+  dataSource: String!
+  soilSeries: SoilSeries!
+  ecologicalSite: EcologicalSite
+  landCapabilityClass: LandCapabilityClass!
+  soilData: [SoilIdSoilData!]!
+}
+
+"""Information about a soil series."""
+type SoilSeries {
+  name: String!
+  taxonomySubgroup: String!
+  description: String!
+  fullDescriptionUrl: String!
+}
+
+"""Information about an ecological site."""
+type EcologicalSite {
+  name: String!
+  id: String!
+  url: String!
+}
+
+"""Caveat: may want to update these fields to an enum at some point."""
+type LandCapabilityClass {
+  capabilityClass: String!
+  subClass: String!
+}
+
+type SoilIdSoilData {
+  depthInterval: DepthInterval!
+  texture: SoilIdDepthDependentSoilDataTextureChoices
+  rockFragmentVolume: SoilIdDepthDependentSoilDataRockFragmentVolumeChoices
+  colorHue: Float
+  colorValue: Float
+  colorChroma: Float
+}
+
+"""
+The likelihood score and rank within the match group for a particular soil type.
+"""
+type SoilMatch {
+  score: Float!
+  rank: Int!
+}
+
+"""
+A ranked group of soil matches based on a coordinate pair and soil data.
+"""
+type DataBasedSoilMatches {
+  matches: [DataBasedSoilMatch]!
+}
+
+"""A soil match based on a coordinate pair and soil data."""
+type DataBasedSoilMatch {
+  soilInfo: SoilInfo!
+  locationMatch: SoilMatch!
+  dataMatch: SoilMatch!
+  combinedMatch: SoilMatch!
+}
+
+"""Soil data provided to the soil ID algorithm."""
+input SoilIDInputData {
+  slope: SoilIdSoilDataSlopeSteepnessSelectChoices
+  intervals: [SoilIDInputDepthDependentData]!
+}
+
+"""Depth dependent data provided to the soil ID algorithm."""
+input SoilIDInputDepthDependentData {
+  depthInterval: DepthIntervalInput!
+  texture: SoilIdDepthDependentSoilDataTextureChoices = null
+  rockFragmentVolume: SoilIdDepthDependentSoilDataRockFragmentVolumeChoices = null
+  colorHue: Float
+  colorValue: Float
+  colorChroma: Float
+}
+
+input DepthIntervalInput {
+  start: Int!
+  end: Int!
+}
+
 type Mutations {
   addGroup(input: GroupAddMutationInput!): GroupAddMutationPayload!
   addLandscape(input: LandscapeAddMutationInput!): LandscapeAddMutationPayload!
@@ -2193,11 +2294,6 @@ input DepthDependentSoilDataUpdateMutationInput {
   clientMutationId: String
 }
 
-input DepthIntervalInput {
-  start: Int!
-  end: Int!
-}
-
 type SoilDataUpdateDepthIntervalMutationPayload {
   errors: GenericScalar
   soilData: SoilDataNode