openid / openid/sharedsignals

Clarifying uniqueness of stream_id

Open
#272 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

vFuture
Dominant language
Makefile
Stars
78
Forks
18
PR merge metrics
No merged PRs in 30d

Description

In the description of stream_id we say that it's:

A string that uniquely identifies the stream. A Transmitter MUST generate a unique ID for each of its non-deleted streams ...

It would be good to clarify that:

  1. The stream_id must be globally unique - up to a reasonable standard (like the various UUID versions), since guaranteeing global uniqueness is impossible.

    As opposed to the implication that being unique within that particular Transmitter's domain is enough.

  2. Uniqueness should persist across deletions - basically the stream_id should not be reused.

    The phrase "unique ID for each of its non-deleted streams" seems to imply that uniqueness only holds for the set of non-deleted streams, so a deleted stream's id could be reused.

If this is the general understanding of the Working Group, I'm happy to send a pull request.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked section 8.1.1 description of stream_id and review the existing wording about unique IDs for non-deleted streams. Done means the text clearly states reasonable global uniqueness and that IDs remain unique after deletion; confirm the Working Group’s interpretation before editing.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.