darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-04 10:21:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Return template name in public API

Browse Source 
The use for the public template API is for building caseworking systems
or similar, where you might need a list of templates to pick from (ie
instead of using the Notify web interface to pick from and send a
message).

Right now our API isn’t returning the template name as part of the
response. The name is a useful, human-friendly way of identifying a
template.

This commit changes the response to include the name.

Some clients will need updating before this can be useful.
This commit is contained in:
Chris Hill-Scott
2017-08-15 14:34:02 +01:00
parent 7879bc0e7e
commit 04e41e3147
5 changed files with 57 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
tests/app/v2/template/test_get_template.py
View File

@@ -10,13 +10,13 @@ from tests.app.db import create_template
valid_version_params = [None, 1]
@pytest.mark.parametrize("tmp_type, expected_subject", [
(SMS_TYPE, None),
(EMAIL_TYPE, 'Template subject'),
(LETTER_TYPE, 'Template subject')
@pytest.mark.parametrize("tmp_type, expected_name, expected_subject", [
(SMS_TYPE, 'sms Template Name', None),
(EMAIL_TYPE, 'email Template Name', 'Template subject'),
(LETTER_TYPE, 'letter Template Name', 'Template subject')
])
@pytest.mark.parametrize("version", valid_version_params)
def test_get_template_by_id_returns_200(client, sample_service, tmp_type, expected_subject, version):
def test_get_template_by_id_returns_200(client, sample_service, tmp_type, expected_name, expected_subject, version):
template = create_template(sample_service, template_type=tmp_type)
auth_header = create_authorization_header(service_id=sample_service.id)
@@ -38,7 +38,8 @@ def test_get_template_by_id_returns_200(client, sample_service, tmp_type, expect
'version': template.version,
'created_by': template.created_by.email_address,
'body': template.content,
"subject": expected_subject
"subject": expected_subject,
'name': expected_name,
}
assert json_response == expected_response

6
tests/app/v2/template/test_template_schemas.py
View File

@@ -21,7 +21,8 @@ valid_json_get_response = {
'updated_at': None,
'version': 1,
'created_by': 'someone@test.com',
'body': 'some body'
'body': 'some body',
'name': 'some name',
}
valid_json_get_response_with_optionals = {
@@ -32,7 +33,8 @@ valid_json_get_response_with_optionals = {
'version': 1,
'created_by': 'someone',
'body': 'some body',
'subject': "some subject"
'subject': "some subject",
'name': 'some name',
}
valid_request_args = [{"id": str(uuid.uuid4()), "version": 1}, {"id": str(uuid.uuid4())}]