openid / sharedsignals

OpenID Shared Signals Working Group Repository
45 stars 11 forks source link

Rework the "examples" sections #37

Closed FragLegs closed 1 month ago

FragLegs commented 1 year ago

Some of our endpoints don't have examples. Others do. At least one of them (just below Table 6: Read Stream Status Errors) has a few examples that are general to all endpoints. Let's rework how we do examples. Maybe provide an examples section for the general ones and then make sure every endpoint has endpoint-specific examples and link to them from the examples section?

timcappalli commented 1 year ago

call on 2023-03-21: We need an inventory of the sections that lack examples. Peter and Tim to compile list.

Tim: Core Peter: CAEP/RISC

ptravers commented 1 year ago

@FragLegs @timcappalli what is the threshold for requiring an example? from rereading the description we may want to agree to how exhaustive we want the examples to be

so far sections without examples in openid-sharedsignals-framework-1_0.txt: 6.1 7.1.5

tulshi commented 2 months ago

@timcappalli please provide an update as it looks like you had an action item related to this.

FragLegs commented 2 months ago

We also need to remove subject from the events payloads in the examples.

FragLegs commented 2 months ago

Figure 46 needs a sub_id

FragLegs commented 1 month ago

The following examples either need subject removed from the event, sub_id added to the base SET, or both: