app/email_branding/email_branding_schema.py

from app.enums import BrandType

post_create_email_branding_schema = {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "description": "POST schema for getting email_branding",
    "type": "object",
    "properties": {
        "colour": {"type": ["string", "null"]},
        "name": {"type": "string"},
        "text": {"type": ["string", "null"]},
        "logo": {"type": ["string", "null"]},
        "brand_type": {"enum": list(BrandType)},
    },
    "required": ["name"],
}

post_update_email_branding_schema = {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "description": "POST schema for getting email_branding",
    "type": "object",
    "properties": {
        "colour": {"type": ["string", "null"]},
        "name": {"type": ["string", "null"]},
        "text": {"type": ["string", "null"]},
        "logo": {"type": ["string", "null"]},
        "brand_type": {"enum": list(BrandType)},
    },
    "required": [],
}
Cleaning things up, trying to get tests to work. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov> 2024-01-17 17:28:46 -05:00			`from app.enums import BrandType`
Add brand_type to EmailBranding. It makes more sense to put the brand_type with EmailBranding rather than in Service. Next step is to add the new type to the form in admin app. 2018-08-23 13:53:05 +01:00
create, edit and use email branding instead of organisation notable things that have been kept until migration is complete: * passing in `organisation` to update_service will update email branding * both `/email-branding` and `/organisation` hit the same code * service endpoints still return organisation as well as email branding 2018-02-05 12:02:35 +00:00			`post_create_email_branding_schema = {`
Use Draft-07 and Draft7Validator everywhere We were using the Draft4Validator in one place, so this updates it to the Draft7Validator instead. The schemas were mostly using draft 4 of the JSON schema, though there were a couple of schemas that were already of version 7. This updates them all to version 7, which is the latest version fully supported by the jsonschema Python package. There are some breaking changes in the newer version of the schema, but I could not see anywhere would these affect us. Some of these schemas were not valid in version 4, but are now valid in version 7 because `"required": []` was not valid in earlier versions. 2022-04-08 17:05:59 +01:00			`"$schema": "http://json-schema.org/draft-07/schema#",`
create, edit and use email branding instead of organisation notable things that have been kept until migration is complete: * passing in `organisation` to update_service will update email branding * both `/email-branding` and `/organisation` hit the same code * service endpoints still return organisation as well as email branding 2018-02-05 12:02:35 +00:00			`"description": "POST schema for getting email_branding",`
Refactor organisation rest to remove marshmallow 2017-07-07 10:00:38 +01:00			`"type": "object",`
			`"properties": {`
Refactor tests to use admin_request 2017-07-10 13:45:48 +01:00			`"colour": {"type": ["string", "null"]},`
Update EmailBranding.name to be not null and unique. Needed to update old migration scripts so that the email_branding name is not null when creating the test dbs. This should no affect the migrations elsewhere. 2019-04-09 14:33:38 +01:00			`"name": {"type": "string"},`
Instead of deleting the data in the name field just copy it to the text field. The admin app still needs to use the name column. Add the text field to the post data schemas. If the text is not in the post data, then populate it with the data in the name field. This should make the migration to text easier, and will work until we are able to update the admin app. 2018-08-02 15:55:45 +01:00			`"text": {"type": ["string", "null"]},`
Add banner_colour, single_id_colour, and domain to email_branding_schema. The Admin app can now be updated to send the new columns to update/create email_branding 2018-08-20 10:57:42 +01:00			`"logo": {"type": ["string", "null"]},`
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov> 2024-02-21 12:35:18 -05:00			`"brand_type": {"enum": list(BrandType)},`
Refactor organisation rest to remove marshmallow 2017-07-07 10:00:38 +01:00			`},`
reformat 2023-08-29 14:54:30 -07:00			`"required": ["name"],`
Refactor organisation rest to remove marshmallow 2017-07-07 10:00:38 +01:00			`}`
Refactor tests to use admin_request 2017-07-10 13:45:48 +01:00
create, edit and use email branding instead of organisation notable things that have been kept until migration is complete: * passing in `organisation` to update_service will update email branding * both `/email-branding` and `/organisation` hit the same code * service endpoints still return organisation as well as email branding 2018-02-05 12:02:35 +00:00			`post_update_email_branding_schema = {`
Use Draft-07 and Draft7Validator everywhere We were using the Draft4Validator in one place, so this updates it to the Draft7Validator instead. The schemas were mostly using draft 4 of the JSON schema, though there were a couple of schemas that were already of version 7. This updates them all to version 7, which is the latest version fully supported by the jsonschema Python package. There are some breaking changes in the newer version of the schema, but I could not see anywhere would these affect us. Some of these schemas were not valid in version 4, but are now valid in version 7 because `"required": []` was not valid in earlier versions. 2022-04-08 17:05:59 +01:00			`"$schema": "http://json-schema.org/draft-07/schema#",`
create, edit and use email branding instead of organisation notable things that have been kept until migration is complete: * passing in `organisation` to update_service will update email branding * both `/email-branding` and `/organisation` hit the same code * service endpoints still return organisation as well as email branding 2018-02-05 12:02:35 +00:00			`"description": "POST schema for getting email_branding",`
Refactor tests to use admin_request 2017-07-10 13:45:48 +01:00			`"type": "object",`
			`"properties": {`
			`"colour": {"type": ["string", "null"]},`
			`"name": {"type": ["string", "null"]},`
Instead of deleting the data in the name field just copy it to the text field. The admin app still needs to use the name column. Add the text field to the post data schemas. If the text is not in the post data, then populate it with the data in the name field. This should make the migration to text easier, and will work until we are able to update the admin app. 2018-08-02 15:55:45 +01:00			`"text": {"type": ["string", "null"]},`
Add banner_colour, single_id_colour, and domain to email_branding_schema. The Admin app can now be updated to send the new columns to update/create email_branding 2018-08-20 10:57:42 +01:00			`"logo": {"type": ["string", "null"]},`
Even more cleanup. Signed-off-by: Cliff Hill <Clifford.hill@gsa.gov> 2024-02-21 12:35:18 -05:00			`"brand_type": {"enum": list(BrandType)},`
Refactor tests to use admin_request 2017-07-10 13:45:48 +01:00			`},`
reformat 2023-08-29 14:54:30 -07:00			`"required": [],`
Refactor tests to use admin_request 2017-07-10 13:45:48 +01:00			`}`