quality(apidocs): document shortid lookup using drf spectacular (#94962)

Part of
https://www.notion.so/sentry/Remove-legacy-API-docs-JSON-21d8b10e4b5d80958c87ee7d603853ff?source=copy_link

(reverted because of a small typing issue found during the PR, fixed
here #94829)

Note that we update the type of `count` in the group serializer, as it
is currently wrong (we return a string, for whatever reason lol).

Author: JoshFerge

api-docs/openapi.json

@@ -100,9 +100,6 @@
     "/api/0/organizations/{organization_id_or_slug}/repos/{repo_id}/commits/": {
       "$ref": "paths/organizations/repo-commits.json"
     },
-    "/api/0/organizations/{organization_id_or_slug}/shortids/{issue_id}/": {
-      "$ref": "paths/organizations/shortid.json"
-    },
     "/api/0/projects/": {
       "$ref": "paths/projects/index.json"
     },

api-docs/paths/organizations/shortid.json

@@ -106,10 +106,10 @@ class GroupProjectResponse(TypedDict):
 
 class BaseGroupResponseOptional(TypedDict, total=False):
     isUnhandled: bool
-    count: int
+    count: str
     userCount: int
-    firstSeen: datetime
-    lastSeen: datetime
+    firstSeen: datetime | None
+    lastSeen: datetime | None
 
 
 class BaseGroupSerializerResponse(BaseGroupResponseOptional):
@@ -151,6 +151,13 @@ class SeenStats(TypedDict):
     user_count: int
 
 
+class SeenStatsResponse(TypedDict):
+    count: str
+    userCount: int
+    firstSeen: datetime | None
+    lastSeen: datetime | None
+
+
 def is_seen_stats(o: object) -> TypeGuard[SeenStats]:
     # not a perfect check, but simulates what was being validated before
     return isinstance(o, dict) and "times_seen" in o
@@ -749,7 +756,7 @@ def _get_permalink(attrs, obj: Group):
             return None
 
     @staticmethod
-    def _convert_seen_stats(attrs: SeenStats):
+    def _convert_seen_stats(attrs: SeenStats) -> SeenStatsResponse:
         return {
             "count": str(attrs["times_seen"]),
             "userCount": attrs["user_count"],

src/sentry/api/serializers/models/group.py

@@ -294,10 +294,10 @@ class StreamGroupSerializerSnubaResponse(TypedDict):
     annotations: NotRequired[list[GroupAnnotation]]
     # from base response optional
     isUnhandled: NotRequired[bool]
-    count: NotRequired[int]
+    count: NotRequired[str]
     userCount: NotRequired[int]
-    firstSeen: NotRequired[datetime]
-    lastSeen: NotRequired[datetime]
+    firstSeen: NotRequired[datetime | None]
+    lastSeen: NotRequired[datetime | None]
 
     # from the serializer itself
     stats: NotRequired[dict[str, Any]]
@@ -505,14 +505,26 @@ def serialize(  # type: ignore[override]  # intentionally different shape
                 result["stats"] = {self.stats_period: attrs["stats"]}
 
             if not self._collapse("lifetime"):
-                result["lifetime"] = self._convert_seen_stats(attrs["lifetime"])
+                seen_stats = self._convert_seen_stats(attrs["lifetime"])
+                result["lifetime"] = {
+                    "count": seen_stats["count"],
+                    "userCount": seen_stats["userCount"],
+                    "firstSeen": seen_stats["firstSeen"],
+                    "lastSeen": seen_stats["lastSeen"],
+                }
                 if self.stats_period:
                     # Not needed in current implementation
                     result["lifetime"]["stats"] = None
 
             if not self._collapse("filtered"):
                 if self.conditions:
-                    filtered = self._convert_seen_stats(attrs["filtered"])
+                    seen_stats = self._convert_seen_stats(attrs["filtered"])
+                    filtered = {
+                        "count": seen_stats["count"],
+                        "userCount": seen_stats["userCount"],
+                        "firstSeen": seen_stats["firstSeen"],
+                        "lastSeen": seen_stats["lastSeen"],
+                    }
                     if self.stats_period:
                         filtered["stats"] = {self.stats_period: attrs["filtered_stats"]}
                     result["filtered"] = filtered

src/sentry/api/serializers/models/group_stream.py

@@ -25,7 +25,7 @@
         "experiments": {},
         "emails": [],
     },
-    "count": 150,
+    "count": "150",
     "culprit": "raven.scripts.runner in main",
     "firstSeen": datetime.fromisoformat("2018-11-06T21:19:55Z"),
     "filtered": None,
@@ -85,7 +85,7 @@
     },
     "platform": "python",
     "lifetime": {
-        "count": 150,
+        "count": "150",
         "userCount": 0,
         "firstSeen": datetime.fromisoformat("2018-11-06T21:19:55Z"),
         "lastSeen": datetime.fromisoformat("2018-12-06T21:19:55Z"),