From adc2ce82838ba9a138f9b7cc6725573ea7e9af13 Mon Sep 17 00:00:00 2001 From: Toby Lorne Date: Thu, 22 Oct 2020 12:19:25 +0100 Subject: [PATCH] clients: cbc_proxy has clarifying comments Signed-off-by: Toby Lorne --- app/clients/cbc_proxy.py | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/app/clients/cbc_proxy.py b/app/clients/cbc_proxy.py index 05acadeea..9f990cc38 100644 --- a/app/clients/cbc_proxy.py +++ b/app/clients/cbc_proxy.py @@ -2,6 +2,19 @@ import json import boto3 +# The variable names in this file have specific meaning in a CAP message +# +# identifier is a unique field for each CAP message +# +# headline is a field which we are not sure if we will use +# +# description is the body of the message +# +# references is a whitespace separated list of message identifiers +# where each identifier is a previous sent message +# ie a Cancel message would have a unique identifier but have the identifier of +# the preceeding Alert message in the references field + # Noop = no operation class CBCProxyNoopClient: @@ -13,9 +26,6 @@ class CBCProxyNoopClient: self, identifier, headline, description, ): - # identifier=broadcast_message.identifier, - # headline="GOV.UK Notify Broadcast", - # description=broadcast_message.description, pass # We have not implementated updating a broadcast