Skip to content

Commit 02306ef

Browse files
authored
Added description as receiver supplied (#121)
Added description as receiver supplied 1. Stream's description will help the admins of a multi stream transmitters distinguish between streams created for multiple receivers
1 parent 75b0033 commit 02306ef

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

openid-sharedsignals-framework-1_0.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -926,6 +926,12 @@ min_verification_interval
926926
MAY respond with a 429 status code. An Event Transmitter SHOULD NOT respond
927927
with a 429 status code if an Event Receiver is not exceeding this frequency.
928928

929+
description
930+
931+
> **Receiver-Supplied**, An optinal string to describe the properties of the stream.
932+
This is useful in multi stream systems to identify the stream for human actors. The
933+
transmitter may truncate the string beyond allowed max length.
934+
929935
TODO: consider adding a IANA Registry for stream configuration metadata, similar
930936
to Section 7.1.1 of {{RFC8414}}. This would allow other specs to add to
931937
the stream configuration.
@@ -973,7 +979,8 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
973979
"urn:example:secevent:events:type_2",
974980
"urn:example:secevent:events:type_3",
975981
"urn:example:secevent:events:type_4"
976-
]
982+
],
983+
"description" : "Stream for Receiver A using events type_2, type_3, type_4"
977984
}
978985
~~~
979986
{: #figcreatestreamreq title="Example: Create Event Stream Request"}
@@ -1008,7 +1015,8 @@ Content-Type: application/json
10081015
"events_delivered": [
10091016
"urn:example:secevent:events:type_2",
10101017
"urn:example:secevent:events:type_3"
1011-
]
1018+
],
1019+
"description" : "Stream for Receiver A using events type_2, type_3, type_4"
10121020
}
10131021
~~~
10141022
{: #figcreatestreamresp title="Example: Create Stream Response"}
@@ -1078,7 +1086,8 @@ Cache-Control: no-store
10781086
"events_delivered": [
10791087
"urn:example:secevent:events:type_2",
10801088
"urn:example:secevent:events:type_3"
1081-
]
1089+
],
1090+
"description" : "Stream for Receiver A using events type_2, type_3, type_4"
10821091
}
10831092
~~~
10841093
{: title="Example: Read Stream Configuration Response" #figreadconfigresp}
@@ -1151,7 +1160,8 @@ Cache-Control: no-store
11511160
"events_delivered": [
11521161
"urn:example:secevent:events:type_2",
11531162
"urn:example:secevent:events:type_3"
1154-
]
1163+
],
1164+
"description" : "Stream for Receiver A using events type_2, type_3, type_4"
11551165
}
11561166
]
11571167
~~~
@@ -1253,6 +1263,7 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
12531263
"urn:example:secevent:events:type_3",
12541264
"urn:example:secevent:events:type_4"
12551265
],
1266+
"description" : "Stream for Receiver B using events type_2, type_3, type_4"
12561267
}
12571268
~~~
12581269
{: title="Example: Update Stream Configuration Request" #figupdateconfigreq}
@@ -1288,7 +1299,8 @@ Cache-Control: no-store
12881299
"events_delivered": [
12891300
"urn:example:secevent:events:type_2",
12901301
"urn:example:secevent:events:type_3"
1291-
]
1302+
],
1303+
"description" : "Stream for Receiver B using events type_2, type_3, type_4"
12921304
}
12931305
~~~
12941306
{: title="Example: Update Stream Configuration Response" #figupdateconfigresp}
@@ -1347,7 +1359,8 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
13471359
"urn:example:secevent:events:type_2",
13481360
"urn:example:secevent:events:type_3",
13491361
"urn:example:secevent:events:type_4"
1350-
]
1362+
],
1363+
"description" : "Stream for Receiver C"
13511364
}
13521365
~~~
13531366
{: title="Example: Replace Stream Configuration Request" #figreplaceconfigreq}
@@ -1383,7 +1396,8 @@ Cache-Control: no-store
13831396
"events_delivered": [
13841397
"urn:example:secevent:events:type_2",
13851398
"urn:example:secevent:events:type_3"
1386-
]
1399+
],
1400+
"description" : "Stream for Receiver C"
13871401
}
13881402
~~~
13891403
{: title="Example: Replace Stream Configuration Response" #figreplaceconfigresp}

0 commit comments

Comments
 (0)