Skip to content

Commit afc710f

Browse files
committed
Initial stab at issue #116.
1 parent 4e1f42e commit afc710f

File tree

1 file changed

+52
-8
lines changed

1 file changed

+52
-8
lines changed

openid-sharedsignals-framework-1_0.md

Lines changed: 52 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -837,17 +837,42 @@ delivery
837837

838838
> method
839839

840-
> > **Receiver-Supplied**, the specific delivery method to be used. This can be
841-
any one of "urn:ietf:rfc:8935" (push) or "urn:ietf:rfc:8936" (poll), but
842-
not both.
840+
> > **Requestor-Supplied**, the specific delivery method to be used. This can be
841+
any one of "urn:ietf:rfc:8935" (push transmitter), "urn:ietf:rfc:8936" (poll
842+
transmitter), "urn:ietf:rfc:8935:receive" (push receiver), or
843+
"urn:ietf:rfc:8936:receive" (poll receiver) but not more than one.0
843844

844845
> endpoint_url
845846

846847
> > The location at which the push or poll delivery will take place. If the
847848
`method` value is "urn:ietf:rfc:8935" (push), then this value MUST
848-
be supplied by the Receiver. If the `method` value is
849-
"urn:ietf:rfc:8936" (poll), then this value MUST be supplied by the
850-
Transmitter.
849+
be supplied by the requestor (from the receiver). If the `method` value is
850+
"urn:ietf:rfc:8936" (poll), then this value is supplied in the response
851+
by the transmitting server. If the `method` value is "urn:ietf:rfc:8935:receive"
852+
than the receiver server SHALL respond with a supplied value. And, if the
853+
`method` value is "urn:ietf:rfc:8936:receive", than the value is supplied
854+
by the requestor based on the value issued by the transmitter.
855+
856+
> authorization_header
857+
858+
> > The HTTP Authorization header to be used, if any, when delivering events.
859+
* Method `urn:ietf:rfc:8935` - provided by the requestor to the trasmitter to
860+
use with the receiver supplied `endpoint_url`.
861+
* Method `urn:ietf:rfc:8936` - asserted in the stream creation response
862+
by the transmitter for use by the receiver.
863+
* Method `urn:ietf:rfc8935:receive` - asserted in the stream creation
864+
response by the receiver for use by the transmitter.
865+
* Method `urn:ietf:rfc8936:receive` - provided by the requestor to the
866+
receiver with the transmitter supplied `endpoint_url`.
867+
868+
> poll_config
869+
870+
> > An object containing a set of RFC8936 polling parameters requested to be
871+
used by a polling receiver when polling a transmitter. The parameters specified
872+
MAY include `maxEvnets`, `returnImmediately` and `timeoutSecs`. The receiver
873+
MAY choose to override these values and assert the final settings in its
874+
response. When omitted, the default behavior described by RFC8936 SHALL be
875+
used.
851876

852877
min_verification_interval
853878

@@ -870,7 +895,7 @@ the Event Transmitter responds with a "201 Created" response containing a
870895
[JSON][RFC7159] representation of the stream’s configuration in the body.
871896

872897
The HTTP POST request MAY contain the Receiver-Supplied values of the Stream
873-
Configuration ({{stream-config}}) object:
898+
Configuration ({{stream-config}}) object, for example:
874899

875900
* `events_requested`
876901
* `delivery` : Note that in the case of the POLL method, the `endpoint_url` value is
@@ -881,7 +906,26 @@ MUST assume that the `method` is "urn:ietf:rfc:8936" (poll). The
881906
Transmitter MUST include a `delivery` property in the response with this
882907
`method` property and a `endpoint_url` property.
883908

884-
The following is a non-normative example request to create an Event Stream:
909+
The following table describes each method, the attributes, their mutability, and
910+
whether transmitter or receiver asserts the values relative to the stream creation requestor.
911+
912+
| Method | Attribute | Generated By | Mutability |
913+
| :-------------------------| :--------------------| :-----------| :----------|
914+
| Push Receiver | | | |
915+
| urn:ietf:rfc:8935:receive | endpoint_url | receiver | generated |
916+
| urn:ietf:rfc:8935:receive | authorization_header | receiver | generated |
917+
| Push Transmitter | | | |
918+
| urn:ietf:rfc:8935 | endpoint_url | receiver | modifiable |
919+
| urn:ietf:rfc:8935 | authorization_header | receiver | modifiable |
920+
| Poll Receiver | | | |
921+
| urn:ietf:rfc:8936:receive | endpoint_url | transmitter | modfiable |
922+
| urn:ietf:rfc:8936:receive | authorization_header | transmitter | modifiable |
923+
| urn:ietf:rfc:8936:receive | poll_config | | modifiable |
924+
| Poll Transmitter | | | |
925+
| urn:ietf:rfc:8936 | endpoint_url | transmitter | generated |
926+
| urn:ietf:rfc:8936 | authorization_header | transmitter | generated |
927+
928+
The following is a non-normative example request to create a Push Transmitter Event Stream:
885929

886930
~~~ http
887931
POST /ssf/stream HTTP/1.1

0 commit comments

Comments
 (0)