mirror of
https://github.com/GSA/notifications-api.git
synced 2026-08-24 00:06:16 -04:00
Remove unused excluded fields from Marshmallow schemas
We have a lot of cases in the schemas where we're excluding a field that doesn't actually exist on the schema anyway. This is often because a model has been deleted, and the schema has not been updated. These excluded fields have no effect at the moment, but Marshmallow 3 does raise an error if you try and exclude non-existent fields. There should be no change to what gets (de)serialized after this change.
This commit is contained in:
@@ -105,8 +105,6 @@ class UserSchema(BaseSchema):
|
|||||||
"created_at",
|
"created_at",
|
||||||
"email_access_validated_at",
|
"email_access_validated_at",
|
||||||
"updated_at",
|
"updated_at",
|
||||||
"user_to_organisation",
|
|
||||||
"user_to_service",
|
|
||||||
"verify_codes",
|
"verify_codes",
|
||||||
)
|
)
|
||||||
strict = True
|
strict = True
|
||||||
@@ -147,7 +145,6 @@ class UserUpdateAttributeSchema(BaseSchema):
|
|||||||
'platform_admin',
|
'platform_admin',
|
||||||
'state',
|
'state',
|
||||||
'updated_at',
|
'updated_at',
|
||||||
'user_to_service',
|
|
||||||
'verify_codes',
|
'verify_codes',
|
||||||
)
|
)
|
||||||
strict = True
|
strict = True
|
||||||
@@ -198,7 +195,6 @@ class ProviderDetailsSchema(BaseSchema):
|
|||||||
|
|
||||||
class Meta(BaseSchema.Meta):
|
class Meta(BaseSchema.Meta):
|
||||||
model = models.ProviderDetails
|
model = models.ProviderDetails
|
||||||
exclude = ("provider_stats",)
|
|
||||||
strict = True
|
strict = True
|
||||||
|
|
||||||
|
|
||||||
@@ -207,7 +203,6 @@ class ProviderDetailsHistorySchema(BaseSchema):
|
|||||||
|
|
||||||
class Meta(BaseSchema.Meta):
|
class Meta(BaseSchema.Meta):
|
||||||
model = models.ProviderDetailsHistory
|
model = models.ProviderDetailsHistory
|
||||||
exclude = ("provider_stats",)
|
|
||||||
strict = True
|
strict = True
|
||||||
|
|
||||||
|
|
||||||
@@ -257,15 +252,11 @@ class ServiceSchema(BaseSchema, UUIDsAsStringsMixin):
|
|||||||
'jobs',
|
'jobs',
|
||||||
'letter_contacts',
|
'letter_contacts',
|
||||||
'letter_logo_filename',
|
'letter_logo_filename',
|
||||||
'old_id',
|
|
||||||
'reply_to_email_addresses',
|
'reply_to_email_addresses',
|
||||||
'returned_letters',
|
'returned_letters',
|
||||||
'service_broadcast_provider_restriction',
|
'service_broadcast_provider_restriction',
|
||||||
'service_broadcast_settings',
|
'service_broadcast_settings',
|
||||||
'service_notification_stats',
|
|
||||||
'service_provider_stats',
|
|
||||||
'service_sms_senders',
|
'service_sms_senders',
|
||||||
'template_statistics',
|
|
||||||
'templates',
|
'templates',
|
||||||
'updated_at',
|
'updated_at',
|
||||||
'users',
|
'users',
|
||||||
@@ -317,20 +308,12 @@ class DetailedServiceSchema(BaseSchema):
|
|||||||
'inbound_number',
|
'inbound_number',
|
||||||
'inbound_sms',
|
'inbound_sms',
|
||||||
'jobs',
|
'jobs',
|
||||||
'letter_contact_block',
|
|
||||||
'letter_logo_filename',
|
|
||||||
'message_limit',
|
'message_limit',
|
||||||
'monthly_billing',
|
|
||||||
'permissions',
|
'permissions',
|
||||||
'rate_limit',
|
'rate_limit',
|
||||||
'reply_to_email_address',
|
|
||||||
'reply_to_email_addresses',
|
'reply_to_email_addresses',
|
||||||
'returned_letters',
|
'returned_letters',
|
||||||
'service_notification_stats',
|
|
||||||
'service_provider_stats',
|
|
||||||
'service_sms_senders',
|
'service_sms_senders',
|
||||||
'sms_sender',
|
|
||||||
'template_statistics',
|
|
||||||
'templates',
|
'templates',
|
||||||
'users',
|
'users',
|
||||||
'version',
|
'version',
|
||||||
@@ -358,7 +341,7 @@ class BaseTemplateSchema(BaseSchema):
|
|||||||
|
|
||||||
class Meta(BaseSchema.Meta):
|
class Meta(BaseSchema.Meta):
|
||||||
model = models.Template
|
model = models.Template
|
||||||
exclude = ("service_id", "jobs", "service_letter_contact_id", "broadcast_messages")
|
exclude = ("service_id", "jobs", "service_letter_contact_id")
|
||||||
strict = True
|
strict = True
|
||||||
|
|
||||||
|
|
||||||
@@ -520,7 +503,7 @@ class NotificationWithTemplateSchema(BaseSchema):
|
|||||||
class Meta(BaseSchema.Meta):
|
class Meta(BaseSchema.Meta):
|
||||||
model = models.Notification
|
model = models.Notification
|
||||||
strict = True
|
strict = True
|
||||||
exclude = ('_personalisation', 'scheduled_notification')
|
exclude = ('_personalisation',)
|
||||||
|
|
||||||
template = fields.Nested(
|
template = fields.Nested(
|
||||||
TemplateSchema,
|
TemplateSchema,
|
||||||
@@ -583,6 +566,9 @@ class NotificationWithPersonalisationSchema(NotificationWithTemplateSchema):
|
|||||||
'service',
|
'service',
|
||||||
'template_history',
|
'template_history',
|
||||||
)
|
)
|
||||||
|
# Overwrite the `NotificationWithTemplateSchema` base class to not exclude `_personalisation`, which
|
||||||
|
# isn't a defined field for this class
|
||||||
|
exclude = ()
|
||||||
|
|
||||||
@pre_dump
|
@pre_dump
|
||||||
def handle_personalisation_property(self, in_data):
|
def handle_personalisation_property(self, in_data):
|
||||||
|
|||||||
Reference in New Issue
Block a user