feat: format+has_errata, drop see_also for red API (#10392)

* fix: has_errata field for red API

* chore: explanatory comment

* feat: accurate format list for red API

* refactor: specify blob names in API

* chore: remove see_also field

* fix: finish removing see_also field

Author: jennifer-richards

ietf/doc/api.py

@@ -1,7 +1,17 @@
 # Copyright The IETF Trust 2024-2026, All Rights Reserved
 """Doc API implementations"""
 
-from django.db.models import OuterRef, Subquery, Prefetch, Value, JSONField, QuerySet
+from django.db.models import (
+    BooleanField,
+    Count,
+    JSONField,
+    OuterRef,
+    Prefetch,
+    Q,
+    QuerySet,
+    Subquery,
+    Value,
+)
 from django.db.models.functions import TruncDate
 from django_filters import rest_framework as filters
 from rest_framework import filters as drf_filters
@@ -133,11 +143,18 @@ def augment_rfc_queryset(queryset: QuerySet[Document]):
         )
         .annotate(published=TruncDate("published_datetime", tzinfo=RPC_TZINFO))
         .annotate(
-            # TODO implement these fake fields for real
-            see_also=Value([], output_field=JSONField()),
-            formats=Value(["txt", "xml"], output_field=JSONField()),
+            # Count of "verified-errata" tags will be 1 or 0, convert to Boolean
+            has_errata=Count(
+                "tags",
+                filter=Q(
+                    tags__slug="verified-errata",
+                ),
+                output_field=BooleanField(),
+            )
+        )
+        .annotate(
+            # TODO implement this fake field for real
             keywords=Value(["keyword"], output_field=JSONField()),
-            errata=Value([], output_field=JSONField()),
         )
     )
 

ietf/doc/models.py

@@ -1284,6 +1284,24 @@ def action_holders_enabled(self):
         iesg_state = self.get_state('draft-iesg')
         return iesg_state and iesg_state.slug != 'idexists'
 
+    def formats(self):
+        """List of file formats available
+        
+        Only implemented for RFCs. Relies on StoredObject.
+        """
+        if self.type_id != "rfc":
+            raise RuntimeError("Only allowed for type=rfc")
+        return [
+            {
+                "fmt": Path(object_name).parts[0],
+                "name": object_name,
+            }
+            for object_name in StoredObject.objects.filter(
+                store="rfc", doc_name=self.name, doc_rev=self.rev
+            ).values_list("name", flat=True)
+        ]
+
+
 class DocumentURL(models.Model):
     doc  = ForeignKey(Document)
     tag  = ForeignKey(DocUrlTagName)

ietf/doc/serializers.py

@@ -16,6 +16,7 @@
 
 class RfcAuthorSerializer(serializers.ModelSerializer):
     """Serializer for an RfcAuthor / DocumentAuthor in a response"""
+
     datatracker_person_path = serializers.URLField(
         source="person.get_absolute_url",
         required=False,
@@ -36,7 +37,7 @@ class Meta:
 
     def to_representation(self, instance):
         """instance -> primitive data types
-        
+
         Translates a DocumentAuthor into an equivalent RfcAuthor we can use the same
         serializer for either type.
         """
@@ -87,7 +88,15 @@ class DocIdentifierSerializer(serializers.Serializer):
 
 
 type RfcStatusSlugT = Literal[
-    "std", "ps", "ds", "bcp", "inf", "exp", "hist", "unkn", "not-issued",
+    "std",
+    "ps",
+    "ds",
+    "bcp",
+    "inf",
+    "exp",
+    "hist",
+    "unkn",
+    "not-issued",
 ]
 
 
@@ -188,11 +197,16 @@ class ContainingSubseriesSerializer(serializers.Serializer):
     type = serializers.CharField(source="source.type_id")
 
 
+class RfcFormatSerializer(serializers.Serializer):
+    RFC_FORMATS = ("xml", "txt", "html", "pdf", "ps", "json", "notprepped")
+
+    fmt = serializers.ChoiceField(choices=RFC_FORMATS)
+    name = serializers.CharField(help_text="Name of blob in the blob store")
+
+
 class RfcMetadataSerializer(serializers.ModelSerializer):
     """Serialize metadata of an RFC"""
 
-    RFC_FORMATS = ("xml", "txt", "html", "htmlized", "pdf", "ps")
-
     number = serializers.IntegerField(source="rfc_number")
     published = serializers.DateField()
     status = RfcStatusSerializer(source="*")
@@ -207,10 +221,11 @@ class RfcMetadataSerializer(serializers.ModelSerializer):
     updates = RelatedRfcSerializer(many=True, read_only=True)
     updated_by = ReverseRelatedRfcSerializer(many=True, read_only=True)
     subseries = ContainingSubseriesSerializer(many=True, read_only=True)
-    see_also = serializers.ListField(child=serializers.CharField(), read_only=True)
-    formats = serializers.MultipleChoiceField(choices=RFC_FORMATS)
+    formats = RfcFormatSerializer(
+        many=True, read_only=True, help_text="Available formats"
+    )
     keywords = serializers.ListField(child=serializers.CharField(), read_only=True)
-    errata = serializers.ListField(child=serializers.CharField(), read_only=True)
+    has_errata = serializers.BooleanField(read_only=True)
 
     class Meta:
         model = Document
@@ -230,15 +245,13 @@ class Meta:
             "updates",
             "updated_by",
             "subseries",
-            "see_also",
             "draft",
             "abstract",
             "formats",
             "keywords",
-            "errata",
+            "has_errata",
         ]
 
-
     @extend_schema_field(RfcAuthorSerializer(many=True))
     def get_authors(self, doc: Document):
         # If doc has any RfcAuthors, use those, otherwise fall back to DocumentAuthors