Merge pull request #505 from Police-Data-Accessibility-Project/mc_504_forbid_extra_params_in_requests

Have Request Models forbid extra parameters

Author: maxachis

src/api/endpoints/agencies/by_id/delete/request.py

@@ -1,9 +1,8 @@
-from pydantic import BaseModel
-
+from src.api.shared.models.request_base import RequestBase
 from src.db.models.impl.agency.enums import AgencyType, JurisdictionType
 
 
-class AgencyPutRequest(BaseModel):
+class AgencyPutRequest(RequestBase):
     name: str | None = None
     type: AgencyType | None = None
     jurisdiction_type: JurisdictionType | None = None

src/api/endpoints/agencies/by_id/put/request.py

@@ -1,9 +1,8 @@
-from pydantic import BaseModel
-
+from src.api.shared.models.request_base import RequestBase
 from src.db.models.impl.agency.enums import AgencyType, JurisdictionType
 
 
-class AgencyPostRequest(BaseModel):
+class AgencyPostRequest(RequestBase):
     name: str
     type: AgencyType
     jurisdiction_type: JurisdictionType

src/api/endpoints/agencies/root/post/request.py

@@ -2,7 +2,9 @@
 
 from pydantic import BaseModel
 
+from src.api.shared.models.request_base import RequestBase
 
-class URLAgencyAnnotationPostInfo(BaseModel):
+
+class URLAgencyAnnotationPostInfo(RequestBase):
     is_new: bool = False
     suggested_agency: int | None = None

src/api/endpoints/annotate/agency/post/dto.py

@@ -1,15 +1,15 @@
-from pydantic import BaseModel, model_validator, ConfigDict
+from pydantic import model_validator
 
 from src.api.endpoints.annotate.all.post.models.agency import AnnotationPostAgencyInfo
 from src.api.endpoints.annotate.all.post.models.location import AnnotationPostLocationInfo
 from src.api.endpoints.annotate.all.post.models.name import AnnotationPostNameInfo
+from src.api.shared.models.request_base import RequestBase
 from src.core.enums import RecordType
 from src.core.exceptions import FailedValidationException
 from src.db.models.impl.flag.url_validated.enums import URLType
 
 
-class AllAnnotationPostInfo(BaseModel):
-    model_config = ConfigDict(extra='forbid')
+class AllAnnotationPostInfo(RequestBase):
 
     suggested_status: URLType
     record_type: RecordType | None = None

src/api/endpoints/annotate/all/post/models/request.py

@@ -2,6 +2,7 @@
 
 from pydantic import BaseModel, Field
 
+from src.api.shared.models.request_base import RequestBase
 from src.core.enums import RecordType
 
 
@@ -16,7 +17,7 @@ class ManualBatchInnerInputDTO(BaseModel):
     supplying_entity: str | None = None
 
 
-class ManualBatchInputDTO(BaseModel):
+class ManualBatchInputDTO(RequestBase):
     name: str
     entries: list[ManualBatchInnerInputDTO] = Field(
         min_length=1,

src/api/endpoints/collector/dtos/manual_batch/post.py

@@ -1,13 +1,12 @@
 from datetime import date
 
-from pydantic import BaseModel
-
+from src.api.shared.models.request_base import RequestBase
 from src.core.enums import RecordType
 from src.db.models.impl.url.optional_ds_metadata.enums import AgencyAggregationEnum, UpdateMethodEnum, \
     RetentionScheduleEnum, AccessTypeEnum
 
 
-class DataSourceSubmissionRequest(BaseModel):
+class DataSourceSubmissionRequest(RequestBase):
     # Required
     name: str
     record_type: RecordType

src/api/endpoints/submit/data_source/request.py

@@ -1,9 +1,10 @@
 from pydantic import BaseModel
 
+from src.api.shared.models.request_base import RequestBase
 from src.core.enums import RecordType
 
 
-class URLSubmissionRequest(BaseModel):
+class URLSubmissionRequest(RequestBase):
     url: str
     record_type: RecordType | None = None
     name: str | None = None