sharedsignals icon indicating copy to clipboard operation
sharedsignals copied to clipboard

Rework the "examples" sections

Open FragLegs opened this issue 3 years ago • 3 comments

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?

FragLegs avatar Nov 29 '22 18:11 FragLegs

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

timcappalli avatar Mar 21 '23 17:03 timcappalli

@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

ptravers avatar Apr 04 '23 11:04 ptravers

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

tulshi avatar Apr 20 '24 01:04 tulshi

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

FragLegs avatar May 14 '24 17:05 FragLegs

Figure 46 needs a sub_id

FragLegs avatar May 14 '24 17:05 FragLegs

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

  • subject-ids-ex-simple
  • subject-ids-ex-complex
  • subject-properties-ex
  • subject-custom-type-ex
  • risc-event-subject-example
  • caep-event-properties-example
  • figarrayaud

FragLegs avatar May 24 '24 14:05 FragLegs