UPDATE
This commit is contained in:
@@ -0,0 +1,62 @@
|
||||
from rest_framework import serializers
|
||||
|
||||
|
||||
class IrrigationFarmDataSerializer(serializers.Serializer):
|
||||
soilType = serializers.CharField(required=False, allow_blank=True)
|
||||
waterQuality = serializers.CharField(required=False, allow_blank=True)
|
||||
climateZone = serializers.CharField(required=False, allow_blank=True)
|
||||
|
||||
|
||||
class IrrigationRecommendRequestSerializer(serializers.Serializer):
|
||||
crop_id = serializers.CharField(required=False, allow_blank=True)
|
||||
farm_data = IrrigationFarmDataSerializer(required=False)
|
||||
soilType = serializers.CharField(required=False, allow_blank=True)
|
||||
waterQuality = serializers.CharField(required=False, allow_blank=True)
|
||||
climateZone = serializers.CharField(required=False, allow_blank=True)
|
||||
|
||||
|
||||
class IrrigationPlanSerializer(serializers.Serializer):
|
||||
frequencyPerWeek = serializers.CharField(required=False, allow_blank=True)
|
||||
durationMinutes = serializers.CharField(required=False, allow_blank=True)
|
||||
bestTimeOfDay = serializers.CharField(required=False, allow_blank=True)
|
||||
moistureLevel = serializers.CharField(required=False, allow_blank=True)
|
||||
warning = serializers.CharField(required=False, allow_blank=True)
|
||||
|
||||
|
||||
class IrrigationWaterBalanceDaySerializer(serializers.Serializer):
|
||||
forecast_date = serializers.CharField(required=False, allow_blank=True)
|
||||
et0_mm = serializers.FloatField(required=False)
|
||||
etc_mm = serializers.FloatField(required=False)
|
||||
effective_rainfall_mm = serializers.FloatField(required=False)
|
||||
gross_irrigation_mm = serializers.FloatField(required=False)
|
||||
irrigation_timing = serializers.CharField(required=False, allow_blank=True)
|
||||
|
||||
|
||||
class IrrigationCropProfileSerializer(serializers.Serializer):
|
||||
kc_initial = serializers.FloatField(required=False)
|
||||
kc_mid = serializers.FloatField(required=False)
|
||||
kc_end = serializers.FloatField(required=False)
|
||||
|
||||
|
||||
class IrrigationWaterBalanceSerializer(serializers.Serializer):
|
||||
daily = IrrigationWaterBalanceDaySerializer(many=True, required=False)
|
||||
crop_profile = IrrigationCropProfileSerializer(required=False)
|
||||
active_kc = serializers.FloatField(required=False)
|
||||
|
||||
|
||||
class IrrigationRecommendResponseDataSerializer(serializers.Serializer):
|
||||
plan = IrrigationPlanSerializer(required=False)
|
||||
raw_response = serializers.CharField(required=False, allow_blank=True)
|
||||
water_balance = IrrigationWaterBalanceSerializer(required=False)
|
||||
status = serializers.CharField(required=False, allow_blank=True)
|
||||
|
||||
|
||||
class IrrigationTaskSubmitDataSerializer(serializers.Serializer):
|
||||
task_id = serializers.CharField(required=False, allow_blank=True)
|
||||
status = serializers.CharField(required=False, allow_blank=True)
|
||||
|
||||
|
||||
class IrrigationTaskStatusDataSerializer(serializers.Serializer):
|
||||
task_id = serializers.CharField(required=False, allow_blank=True)
|
||||
status = serializers.CharField(required=False, allow_blank=True)
|
||||
result = IrrigationRecommendResponseDataSerializer(required=False)
|
||||
@@ -1,8 +1,10 @@
|
||||
from django.urls import path
|
||||
|
||||
from .views import ConfigView, RecommendView
|
||||
from .views import ConfigView, RecommendTaskCreateView, RecommendTaskStatusView, RecommendView
|
||||
|
||||
urlpatterns = [
|
||||
path("config/", ConfigView.as_view(), name="irrigation-recommendation-config"),
|
||||
path("recommend/", RecommendView.as_view(), name="irrigation-recommendation-recommend"),
|
||||
path("recommend/task/", RecommendTaskCreateView.as_view(), name="irrigation-recommendation-task-create"),
|
||||
path("recommend/<str:task_id>/status/", RecommendTaskStatusView.as_view(), name="irrigation-recommendation-task-status"),
|
||||
]
|
||||
|
||||
@@ -1,78 +1,38 @@
|
||||
"""
|
||||
Irrigation Recommendation API views.
|
||||
No database. All responses are static mock data.
|
||||
Response format: {"status": "success", "data": <payload>}. HTTP 200 only.
|
||||
No processing, validation, or use of input parameters in responses.
|
||||
"""
|
||||
|
||||
from rest_framework import serializers, status
|
||||
from rest_framework.response import Response
|
||||
from rest_framework.views import APIView
|
||||
from drf_spectacular.types import OpenApiTypes
|
||||
from drf_spectacular.utils import extend_schema
|
||||
from drf_spectacular.utils import OpenApiParameter, extend_schema
|
||||
|
||||
from config.swagger import status_response
|
||||
from external_api_adapter import request as external_api_request
|
||||
from .mock_data import CONFIG_RESPONSE_DATA
|
||||
from .serializers import (
|
||||
IrrigationRecommendRequestSerializer,
|
||||
IrrigationRecommendResponseDataSerializer,
|
||||
IrrigationTaskStatusDataSerializer,
|
||||
IrrigationTaskSubmitDataSerializer,
|
||||
)
|
||||
|
||||
|
||||
class ConfigView(APIView):
|
||||
"""
|
||||
GET endpoint for irrigation config (farm info and crop options).
|
||||
|
||||
Purpose:
|
||||
Returns static farm info (soilType, waterQuality, climateZone) and
|
||||
crop options list for the irrigation recommendation form. Used when
|
||||
loading the irrigation recommendation page.
|
||||
|
||||
Input parameters:
|
||||
None. Query parameters, if sent, are not read or used.
|
||||
|
||||
Response structure:
|
||||
- status: string, always "success".
|
||||
- data: object with keys farmInfo (object), cropOptions (array of
|
||||
{ id, labelKey, icon }).
|
||||
|
||||
No processing or validation is performed on inputs.
|
||||
"""
|
||||
|
||||
@extend_schema(
|
||||
tags=["Irrigation Recommendation"],
|
||||
responses={200: status_response("IrrigationConfigResponse", data=serializers.JSONField())},
|
||||
)
|
||||
def get(self, request):
|
||||
return Response(
|
||||
{"status": "success", "data": CONFIG_RESPONSE_DATA},
|
||||
status=status.HTTP_200_OK,
|
||||
)
|
||||
return Response({"status": "success", "data": CONFIG_RESPONSE_DATA}, status=status.HTTP_200_OK)
|
||||
|
||||
|
||||
class RecommendView(APIView):
|
||||
"""
|
||||
POST endpoint for irrigation recommendation.
|
||||
|
||||
Purpose:
|
||||
Returns a static irrigation plan (frequencyPerWeek, durationMinutes,
|
||||
bestTimeOfDay, moistureLevel, warning). Body may contain crop_id
|
||||
and farm info; not read or used in response.
|
||||
|
||||
Input parameters:
|
||||
- body (optional): JSON. May contain "crop_id", "soilType", "waterQuality",
|
||||
"climateZone". Data type: object. Location: body. Not read or validated;
|
||||
not used in response.
|
||||
|
||||
Response structure:
|
||||
- status: string, always "success".
|
||||
- data: object with key "plan" (object with frequencyPerWeek,
|
||||
durationMinutes, bestTimeOfDay, moistureLevel, warning).
|
||||
|
||||
No processing or validation is performed on inputs.
|
||||
"""
|
||||
|
||||
@extend_schema(
|
||||
tags=["Irrigation Recommendation"],
|
||||
request=OpenApiTypes.OBJECT,
|
||||
responses={200: status_response("IrrigationRecommendResponse", data=serializers.JSONField())},
|
||||
request=IrrigationRecommendRequestSerializer,
|
||||
responses={200: status_response("IrrigationRecommendResponse", data=IrrigationRecommendResponseDataSerializer())},
|
||||
)
|
||||
def post(self, request):
|
||||
adapter_response = external_api_request(
|
||||
@@ -82,3 +42,36 @@ class RecommendView(APIView):
|
||||
payload=request.data,
|
||||
)
|
||||
return Response(adapter_response.data, status=adapter_response.status_code)
|
||||
|
||||
|
||||
class RecommendTaskCreateView(APIView):
|
||||
@extend_schema(
|
||||
tags=["Irrigation Recommendation"],
|
||||
request=IrrigationRecommendRequestSerializer,
|
||||
responses={200: status_response("IrrigationRecommendTaskCreateResponse", data=IrrigationTaskSubmitDataSerializer())},
|
||||
)
|
||||
def post(self, request):
|
||||
adapter_response = external_api_request(
|
||||
"ai",
|
||||
"/irrigation/recommend",
|
||||
method="POST",
|
||||
payload=request.data,
|
||||
)
|
||||
return Response(adapter_response.data, status=adapter_response.status_code)
|
||||
|
||||
|
||||
class RecommendTaskStatusView(APIView):
|
||||
@extend_schema(
|
||||
tags=["Irrigation Recommendation"],
|
||||
parameters=[
|
||||
OpenApiParameter(name="task_id", type=OpenApiTypes.STR, location=OpenApiParameter.PATH),
|
||||
],
|
||||
responses={200: status_response("IrrigationRecommendTaskStatusResponse", data=IrrigationTaskStatusDataSerializer())},
|
||||
)
|
||||
def get(self, request, task_id):
|
||||
adapter_response = external_api_request(
|
||||
"ai",
|
||||
f"/irrigation/recommend/status/{task_id}",
|
||||
method="GET",
|
||||
)
|
||||
return Response(adapter_response.data, status=adapter_response.status_code)
|
||||
|
||||
Reference in New Issue
Block a user