@@ -865,6 +865,12 @@ min_verification_interval
865865 MAY respond with a 429 status code. An Event Transmitter SHOULD NOT respond
866866 with a 429 status code if an Event Receiver is not exceeding this frequency.
867867
868+ description
869+
870+ > **Receiver-Supplied**, An optinal string to describe the properties of the stream.
871+ This is useful in multi stream systems to identify the stream for human actors. The
872+ transmitter may truncate the string beyond allowed max length.
873+
868874TODO : consider adding a IANA Registry for stream configuration metadata, similar
869875to Section 7.1.1 of {{RFC8414}}. This would allow other specs to add to
870876the stream configuration.
@@ -912,7 +918,8 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
912918 " urn:example:secevent:events:type_2" ,
913919 " urn:example:secevent:events:type_3" ,
914920 " urn:example:secevent:events:type_4"
915- ]
921+ ],
922+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
916923}
917924~~~
918925{: # figcreatestreamreq title="Example: Create Event Stream Request"}
@@ -947,7 +954,8 @@ Content-Type: application/json
947954 " events_delivered " : [
948955 " urn:example:secevent:events:type_2" ,
949956 " urn:example:secevent:events:type_3"
950- ]
957+ ],
958+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
951959}
952960~~~
953961{: # figcreatestreamresp title="Example: Create Stream Response"}
@@ -1017,7 +1025,8 @@ Cache-Control: no-store
10171025 " events_delivered " : [
10181026 " urn:example:secevent:events:type_2" ,
10191027 " urn:example:secevent:events:type_3"
1020- ]
1028+ ],
1029+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
10211030}
10221031~~~
10231032{: title="Example: Read Stream Configuration Response" # figreadconfigresp}
@@ -1090,7 +1099,8 @@ Cache-Control: no-store
10901099 " events_delivered " : [
10911100 " urn:example:secevent:events:type_2" ,
10921101 " urn:example:secevent:events:type_3"
1093- ]
1102+ ],
1103+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
10941104 }
10951105]
10961106~~~
@@ -1192,6 +1202,7 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
11921202 " urn:example:secevent:events:type_3" ,
11931203 " urn:example:secevent:events:type_4"
11941204 ],
1205+ " description" : "Stream for Receiver B using events type_2, type_3, type_4"
11951206}
11961207~~~
11971208{: title="Example: Update Stream Configuration Request" # figupdateconfigreq}
@@ -1227,7 +1238,8 @@ Cache-Control: no-store
12271238 " events_delivered " : [
12281239 " urn:example:secevent:events:type_2" ,
12291240 " urn:example:secevent:events:type_3"
1230- ]
1241+ ],
1242+ " description" : "Stream for Receiver B using events type_2, type_3, type_4"
12311243}
12321244~~~
12331245{: title="Example: Update Stream Configuration Response" # figupdateconfigresp}
@@ -1286,7 +1298,8 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
12861298 " urn:example:secevent:events:type_2" ,
12871299 " urn:example:secevent:events:type_3" ,
12881300 " urn:example:secevent:events:type_4"
1289- ]
1301+ ],
1302+ " description" : "Stream for Receiver C"
12901303}
12911304~~~
12921305{: title="Example: Replace Stream Configuration Request" # figreplaceconfigreq}
@@ -1322,7 +1335,8 @@ Cache-Control: no-store
13221335 " events_delivered " : [
13231336 " urn:example:secevent:events:type_2" ,
13241337 " urn:example:secevent:events:type_3"
1325- ]
1338+ ],
1339+ " description" : "Stream for Receiver C"
13261340}
13271341~~~
13281342{: title="Example: Replace Stream Configuration Response" # figreplaceconfigresp}
0 commit comments