Backend/irrigation_recommendation/views.py

"""
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 config.swagger import status_response
from .mock_data import CONFIG_RESPONSE_DATA, RECOMMEND_RESPONSE_DATA


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,
        )


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())},
    )
    def post(self, request):
        return Response(
            {"status": "success", "data": RECOMMEND_RESPONSE_DATA},
            status=status.HTTP_200_OK,
        )