darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-13 08:42:21 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
a95269f9a1bf31a3db52f6e7d80fb1fc910d13f2
notifications-api/app/template/template_schemas.py

43 lines
1.5 KiB
Python
Raw Normal View History

Cleaning up with black, isort, flake8. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov>
2024-01-16 07:37:21 -05:00
from app.enums import TemplateProcessType, TemplateType
Add JSON schema for updating template We did not have a JSON schema for updating a template. Since we will remove the postage constraint from the templates table, this adds a JSON schema for updating a template so that we can use it to check that the postage is one of the allowed values.
2020-06-09 17:44:09 +01:00
from app.schema_validation.definitions import nullable_uuid, uuid
Using jsonschema for create_template. Updated jsonschema to Draft7, this allowed a conditional validation on subject, if template_type == 'email' or 'letter' then subject is required. This version is backward compatible with Draft4. When creating TempalteRedacted, I've built the dict depending on if the created_by or created_by_id exists.
2018-11-02 16:00:22 +00:00
post_create_template_schema = {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "POST create new template",
"type": "object",
"title": "payload for POST /service/<uuid:service_id>/template",
"properties": {
"name": {"type": "string"},
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov>
2024-02-21 12:35:18 -05:00
"template_type": {"enum": list(TemplateType)},
Using jsonschema for create_template. Updated jsonschema to Draft7, this allowed a conditional validation on subject, if template_type == 'email' or 'letter' then subject is required. This version is backward compatible with Draft4. When creating TempalteRedacted, I've built the dict depending on if the created_by or created_by_id exists.
2018-11-02 16:00:22 +00:00
"service": uuid,
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov>
2024-02-21 12:35:18 -05:00
"process_type": {"enum": list(TemplateProcessType)},
Using jsonschema for create_template. Updated jsonschema to Draft7, this allowed a conditional validation on subject, if template_type == 'email' or 'letter' then subject is required. This version is backward compatible with Draft4. When creating TempalteRedacted, I've built the dict depending on if the created_by or created_by_id exists.
2018-11-02 16:00:22 +00:00
"content": {"type": "string"},
"subject": {"type": "string"},
Update the template_schema to include a parent_folder_id. When creating the Tempalte from_json, the folder is passed in. Since some validation should done, as in the folder exists and is for the same service, the folder is passed through to the Tempalte.from_json method. When the template is persisted so is the relationship to folders. TODO: If the folder is invalid a specific message should be returned.
2018-11-05 10:54:42 +00:00
"created_by": uuid,
Don't allow to set postage per template if no service permission
2018-12-17 10:03:54 +00:00
"parent_folder_id": uuid,
Using jsonschema for create_template. Updated jsonschema to Draft7, this allowed a conditional validation on subject, if template_type == 'email' or 'letter' then subject is required. This version is backward compatible with Draft4. When creating TempalteRedacted, I've built the dict depending on if the created_by or created_by_id exists.
2018-11-02 16:00:22 +00:00
},
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov>
2024-02-21 12:35:18 -05:00
"if": {"properties": {"template_type": {"enum": [TemplateType.EMAIL]}}},
Using jsonschema for create_template. Updated jsonschema to Draft7, this allowed a conditional validation on subject, if template_type == 'email' or 'letter' then subject is required. This version is backward compatible with Draft4. When creating TempalteRedacted, I've built the dict depending on if the created_by or created_by_id exists.
2018-11-02 16:00:22 +00:00
"then": {"required": ["subject"]},
reformat
2023-08-29 14:54:30 -07:00
"required": ["name", "template_type", "content", "service", "created_by"],
Using jsonschema for create_template. Updated jsonschema to Draft7, this allowed a conditional validation on subject, if template_type == 'email' or 'letter' then subject is required. This version is backward compatible with Draft4. When creating TempalteRedacted, I've built the dict depending on if the created_by or created_by_id exists.
2018-11-02 16:00:22 +00:00
}
Add JSON schema for updating template We did not have a JSON schema for updating a template. Since we will remove the postage constraint from the templates table, this adds a JSON schema for updating a template so that we can use it to check that the postage is one of the allowed values.
2020-06-09 17:44:09 +01:00
post_update_template_schema = {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "POST update existing template",
"type": "object",
"title": "payload for POST /service/<uuid:service_id>/template/<uuid:template_id>",
"properties": {
"id": uuid,
"name": {"type": "string"},
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov>
2024-02-21 12:35:18 -05:00
"template_type": {"enum": list(TemplateType)},
Add JSON schema for updating template We did not have a JSON schema for updating a template. Since we will remove the postage constraint from the templates table, this adds a JSON schema for updating a template so that we can use it to check that the postage is one of the allowed values.
2020-06-09 17:44:09 +01:00
"service": uuid,
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov>
2024-02-21 12:35:18 -05:00
"process_type": {"enum": list(TemplateProcessType)},
Add JSON schema for updating template We did not have a JSON schema for updating a template. Since we will remove the postage constraint from the templates table, this adds a JSON schema for updating a template so that we can use it to check that the postage is one of the allowed values.
2020-06-09 17:44:09 +01:00
"content": {"type": "string"},
"subject": {"type": "string"},
"reply_to": nullable_uuid,
"created_by": uuid,
"archived": {"type": "boolean"},
reformat
2023-08-29 14:54:30 -07:00
"current_user": uuid,
Add JSON schema for updating template We did not have a JSON schema for updating a template. Since we will remove the postage constraint from the templates table, this adds a JSON schema for updating a template so that we can use it to check that the postage is one of the allowed values.
2020-06-09 17:44:09 +01:00
},
}
Reference in New Issue Copy Permalink