|
| 1 | +"""Milestone API.""" |
| 2 | + |
| 3 | +from datetime import datetime |
| 4 | +from http import HTTPStatus |
| 5 | +from typing import Literal |
| 6 | + |
| 7 | +from django.http import HttpRequest |
| 8 | +from ninja import Field, FilterSchema, Path, Query, Schema |
| 9 | +from ninja.decorators import decorate_view |
| 10 | +from ninja.pagination import RouterPaginated |
| 11 | +from ninja.responses import Response |
| 12 | + |
| 13 | +from apps.api.decorators.cache import cache_response |
| 14 | +from apps.github.models.generic_issue_model import GenericIssueModel |
| 15 | +from apps.github.models.milestone import Milestone as MilestoneModel |
| 16 | + |
| 17 | +router = RouterPaginated(tags=["Milestones"]) |
| 18 | + |
| 19 | + |
| 20 | +class MilestoneBase(Schema): |
| 21 | + """Base schema for Milestone (used in list endpoints).""" |
| 22 | + |
| 23 | + created_at: datetime |
| 24 | + number: int |
| 25 | + state: GenericIssueModel.State |
| 26 | + title: str |
| 27 | + updated_at: datetime |
| 28 | + url: str |
| 29 | + |
| 30 | + |
| 31 | +class Milestone(MilestoneBase): |
| 32 | + """Schema for Milestone (minimal fields for list display).""" |
| 33 | + |
| 34 | + |
| 35 | +class MilestoneDetail(MilestoneBase): |
| 36 | + """Detail schema for Milestone (used in single item endpoints).""" |
| 37 | + |
| 38 | + body: str |
| 39 | + closed_issues_count: int |
| 40 | + due_on: datetime | None |
| 41 | + open_issues_count: int |
| 42 | + |
| 43 | + |
| 44 | +class MilestoneError(Schema): |
| 45 | + """Milestone error schema.""" |
| 46 | + |
| 47 | + message: str |
| 48 | + |
| 49 | + |
| 50 | +class MilestoneFilter(FilterSchema): |
| 51 | + """Filter for Milestone.""" |
| 52 | + |
| 53 | + organization: str | None = Field( |
| 54 | + None, |
| 55 | + description="Organization that milestones belong to (filtered by repository owner)", |
| 56 | + example="OWASP", |
| 57 | + ) |
| 58 | + repository: str | None = Field( |
| 59 | + None, |
| 60 | + description="Repository that milestones belong to", |
| 61 | + example="Nest", |
| 62 | + ) |
| 63 | + state: GenericIssueModel.State | None = Field( |
| 64 | + None, |
| 65 | + description="Milestone state", |
| 66 | + ) |
| 67 | + |
| 68 | + |
| 69 | +@router.get( |
| 70 | + "/", |
| 71 | + description="Retrieve a paginated list of GitHub milestones.", |
| 72 | + operation_id="list_milestones", |
| 73 | + response=list[Milestone], |
| 74 | + summary="List milestones", |
| 75 | +) |
| 76 | +@decorate_view(cache_response()) |
| 77 | +def list_milestones( |
| 78 | + request: HttpRequest, |
| 79 | + filters: MilestoneFilter = Query(...), |
| 80 | + ordering: Literal["created_at", "-created_at", "updated_at", "-updated_at"] | None = None, |
| 81 | +) -> list[Milestone]: |
| 82 | + """Get all milestones.""" |
| 83 | + milestones = MilestoneModel.objects.select_related("repository", "repository__organization") |
| 84 | + |
| 85 | + if filters.organization: |
| 86 | + milestones = milestones.filter( |
| 87 | + repository__organization__login__iexact=filters.organization |
| 88 | + ) |
| 89 | + if filters.repository: |
| 90 | + milestones = milestones.filter(repository__name__iexact=filters.repository) |
| 91 | + if filters.state: |
| 92 | + milestones = milestones.filter(state=filters.state) |
| 93 | + |
| 94 | + return milestones.order_by(ordering or "-created_at", "-updated_at") |
| 95 | + |
| 96 | + |
| 97 | +@router.get( |
| 98 | + "/{str:organization_id}/{str:repository_id}/{int:milestone_id}", |
| 99 | + description=( |
| 100 | + "Retrieve a specific GitHub milestone by organization, repository, and milestone number." |
| 101 | + ), |
| 102 | + operation_id="get_milestone", |
| 103 | + response={ |
| 104 | + HTTPStatus.NOT_FOUND: MilestoneError, |
| 105 | + HTTPStatus.OK: MilestoneDetail, |
| 106 | + }, |
| 107 | + summary="Get milestone", |
| 108 | +) |
| 109 | +@decorate_view(cache_response()) |
| 110 | +def get_milestone( |
| 111 | + request: HttpRequest, |
| 112 | + organization_id: str = Path(example="OWASP"), |
| 113 | + repository_id: str = Path(example="Nest"), |
| 114 | + milestone_id: int = Path(example=1), |
| 115 | +) -> MilestoneDetail | MilestoneError: |
| 116 | + """Get milestone.""" |
| 117 | + try: |
| 118 | + return MilestoneModel.objects.get( |
| 119 | + repository__organization__login__iexact=organization_id, |
| 120 | + repository__name__iexact=repository_id, |
| 121 | + number=milestone_id, |
| 122 | + ) |
| 123 | + except MilestoneModel.DoesNotExist: |
| 124 | + return Response({"message": "Milestone not found"}, status=HTTPStatus.NOT_FOUND) |
0 commit comments