WIP: Common constraints - identifiers #271

mlagally · 2022-09-02T12:31:32Z

benfrancis

I don't particularly object to this section, but the mutable/immutable stuff is already covered in the TD spec and I'm not convinced that a URN is necessarily better than other URIs, like an HTTP URL with a fully qualified domain name for example.

benfrancis · 2022-09-07T10:18:10Z

index.html

+      <h2>Identifiers</h2>
+      <p>
+        Web resources are identified by uniform resource identifiers (URIs).
+        The Thing Description defines the field <code>id</code> for that purpose, which is in the format "anyURI".


Reference needed for "anyURI" (or the id member in TD which in turn has a reference for "anyURI")

reference was added.

benfrancis · 2022-09-07T10:20:51Z

index.html

+          <span class="rfc2119-assertion" id="common-constraints-identifiers-uuid">
+            It is RECOMMENDED to use Universally Unique IDentifier (UUID) [[RFC4122]] as common format for identifers.
+          </span>


I'm pleased to see that this is only a recommendation, however:

A UUID is not a URI. Do you perhaps mean a URN?

Can you explain why a URN is a better globally unique identifier than an HTTP URL with a fully qualified domain name and therefore a URN should be recommended over that?

In WebThings we still use the URL of the Thing Description as its ID, which has many benefits.

The URL is not stable in scenarios where things may transition between different networks. Think of roaming scenarios in fleet management, IP reassignment cases etc.

benfrancis · 2022-09-07T10:22:04Z

index.html

+      </p>
+      </section>
+      <section id="sec-identifiers-mutability">
+        <h3>Unique Identifiers</h3>


Should this title be "Mutable Identifiers", or "Immutable Identifiers"?

Both are valid titles, I combined them.

benfrancis · 2022-09-07T10:27:39Z

index.html

+      <p>
+        Many use cases require that identifiers do not change during the lifecycle of the thing in the application context.
+        However there are cases, where the IDs must change due to legal or privacy obligations. 
+        IDs should be changed when a device is offboarded and onboarded on a new system (e.g. for change
+        of ownership).
+        In these cases, or when a device is moved to a new usage context, identifiers usually must change. 
+      </p>
+
+      <p><span class="rfc2119-assertion" id="common-constraints-identifiers-mutable">
+        In certain use cases where privacy is a factor or legal obligations mandate changing identifiers, 
+        the use of a <em>mutable UUID</em> is RECOMMENDED.</span>
+      </p>
+
+      <p><span class="rfc2119-assertion" id="common-constraints-identifiers-immutable-ids">
+        If possible and allowed by law, required immutable IDs SHOULD be made available through a
+        property rather than used as the id for the TD itself.
+      </span></p>
+      </section>


This is already covered in section 11.2 Immutable Identifiers of TD 1.1. I don't think this text really adds anything to that text.

This goes beyond what the TD describes in section 11.2.

The proposed text talks specifically about UUIDs, i.e. a format this is well-defined, whereas the TD does not have any format description for identifiers.

mlagally · 2023-02-16T18:03:52Z

I revised the draft taking the feedback from @benfrancis into account. @benfrancis all, please review again.

benfrancis · 2023-02-17T11:02:28Z

A UUID is not a valid URI
The HTML in this PR doesn't render correctly
The proposed text is very verbose and a lot of it is redundant
I think best practice recommendations like this really belong in the Thing Description specification since they apply to all Thing Descriptions, not just those which conform with a profile

I don't have a problem with recommending URNs (containing UUIDs) as IDs, as long as any URI is allowed.

If you really feel that it's important for this recommendation to be made in the Profile specification, I suggest reducing this section down to a single assertion which says something along the lines of:

"It is RECOMMENDED that a Web Thing's Thing Description uses a URN [[URN]] containing a UUID [[rfc4122]] as the value of its id member, so that the Thing has a globally unique identifier."

egekorkan · 2023-02-20T23:47:09Z

I agree with @benfrancis but the most important thing here is to remove the last assertion since the TD spec says:

Ideally, any required immutable identifiers SHOULD only be made available via affordances, such as a property, whose value can only be obtained after appropriate authentication and authorization, and managed separately from the TD identifier.

…paragraph Update Explainer.md: remove duplicate text.

Security http sections

See #369

Co-authored-by: Ben Francis <[email protected]>

benfrancis

Please see my comments above.

Async action clarifications

…3c/wot-profile into common-constraints-identifiers

1st draft

4cea12f

mlagally requested review from benfrancis, egekorkan, chachamimm, mmccool, mryuichi and sebastiankb September 5, 2022 10:46

mlagally changed the title ~~WIP: common constraints - identifiers~~ Common constraints - identifiers Sep 5, 2022

mlagally mentioned this pull request Sep 7, 2022

unique id #139

Open

benfrancis reviewed Sep 7, 2022

View reviewed changes

mlagally changed the title ~~Common constraints - identifiers~~ WIP: Common constraints - identifiers Sep 21, 2022

mlagally self-assigned this Feb 8, 2023

lu-zero and others added 3 commits February 13, 2023 20:52

Fix the Errors heading level

3da07f2

Update Explainer.md

63566cd

Update index.html

a96e5b7

mlagally changed the title ~~WIP: Common constraints - identifiers~~ Common constraints - identifiers Feb 16, 2023

Merge branch 'main' into common-constraints-identifiers

2178fa8

mlagally requested a review from benfrancis February 16, 2023 18:03

mlagally and others added 6 commits February 22, 2023 13:15

Merge pull request #365 from w3c/mlagally-explainer-remove-duplicate-…

168ea37

…paragraph Update Explainer.md: remove duplicate text.

Clarify the security constraints for HTTP

5bbd014

Merge pull request #364 from luminem/security-http-sections

439d590

Security http sections

Add 503 as suggested error code

01775c4

Clarify the default behaviour for async actions

6d78636

See #369

Further clarifications

2b3f6eb

Co-authored-by: Ben Francis <[email protected]>

benfrancis suggested changes Mar 8, 2023

View reviewed changes

mlagally and others added 2 commits March 8, 2023 14:00

Merge pull request #371 from luminem/async-action-clarifications

d1f6d5c

Async action clarifications

1st draft

468504f

mlagally and others added 24 commits March 22, 2023 10:22

Update index.html

dff873c

update after Day 1 of testfest

f9a8466

add categories

4722758

update after Day 2 of testfest

80cdc18

fixed (impl->pass) node-wot results

85fabaa

add clarification on the server behavior of the Consumer

6ec32e7

revert commit

546c207

remove atrisk markup from WD

6f364c2

add clarification on server behavior of webhook consumer

918b63b

update static.html and Overview.html

ddc0431

update static.html and Overview with HTML reference

5b0fb49

update static.html and Overview.html again

79e501a

update static.html and Overview.html with https

92c7ff8

Update Explainer.md

b997349

Update Explainer.md

46beaf3

Update Explainer.md

557aa5e

Update Explainer.md

b00a59f

Update Explainer.md

9dce595

Remove trailing whitespaces

7ece752

Merge branch 'common-constraints-identifiers' of https://github.com/w…

65e2524

…3c/wot-profile into common-constraints-identifiers

fixing rebase problems

90cbf97

intermediate rebase w/o identifier section

29283c3

fixing rebase problem

4b1b5fb

fixing rebase problem

4d3e683

mlagally changed the title ~~Common constraints - identifiers~~ WIP: Common constraints - identifiers Mar 22, 2023

rebase problem

c61cf48

mlagally added the Profile-1.0 label Mar 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Common constraints - identifiers #271

WIP: Common constraints - identifiers #271

mlagally commented Sep 2, 2022 •

edited by pr-preview bot

Loading

benfrancis left a comment

benfrancis Sep 7, 2022

mlagally Feb 16, 2023

benfrancis Sep 7, 2022

mlagally Nov 9, 2022

benfrancis Sep 7, 2022 •

edited

Loading

mlagally Feb 16, 2023 •

edited

Loading

benfrancis Sep 7, 2022

mlagally Nov 9, 2022

mlagally commented Feb 16, 2023

benfrancis commented Feb 17, 2023 •

edited

Loading

egekorkan commented Feb 20, 2023

benfrancis left a comment •

edited

Loading

WIP: Common constraints - identifiers #271

Are you sure you want to change the base?

WIP: Common constraints - identifiers #271

Conversation

mlagally commented Sep 2, 2022 • edited by pr-preview bot Loading

benfrancis left a comment

Choose a reason for hiding this comment

benfrancis Sep 7, 2022

Choose a reason for hiding this comment

mlagally Feb 16, 2023

Choose a reason for hiding this comment

benfrancis Sep 7, 2022

Choose a reason for hiding this comment

mlagally Nov 9, 2022

Choose a reason for hiding this comment

benfrancis Sep 7, 2022 • edited Loading

Choose a reason for hiding this comment

mlagally Feb 16, 2023 • edited Loading

Choose a reason for hiding this comment

benfrancis Sep 7, 2022

Choose a reason for hiding this comment

mlagally Nov 9, 2022

Choose a reason for hiding this comment

mlagally commented Feb 16, 2023

benfrancis commented Feb 17, 2023 • edited Loading

egekorkan commented Feb 20, 2023

benfrancis left a comment • edited Loading

Choose a reason for hiding this comment

mlagally commented Sep 2, 2022 •

edited by pr-preview bot

Loading

benfrancis Sep 7, 2022 •

edited

Loading

mlagally Feb 16, 2023 •

edited

Loading

benfrancis commented Feb 17, 2023 •

edited

Loading

benfrancis left a comment •

edited

Loading