Rework the "examples" sections

Question

Rework the "examples" sections

Closed this issue 4 months ago · 6 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?

Answer 1 · 2023-03-21T17:20:56.000Z

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

Answer 2 · 2023-04-04T11:51:55.000Z

@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

Answer 3 · 2024-04-20T01:05:11.000Z

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

Answer 4 · 2024-05-14T17:40:19.000Z

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

Answer 5 · 2024-05-14T17:46:46.000Z

Figure 46 needs a sub_id

Answer 6 · 2024-05-24T14:43:18.000Z

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