Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Registration of Well-known URI, DNS-SD and DID Service Names, CoRE Resource Type #187

Closed
k-toumura opened this issue May 31, 2021 · 19 comments
Assignees

Comments

@k-toumura
Copy link
Contributor

k-toumura commented May 31, 2021

We need to register the following names required for the Introduction mechanism. Is there anyone familiar with the registration process and can help to get these registered?

NOTES:

  1. Before sending these off, make sure they are consistent with the spec as written. I (@mmccool) have been making edits to the description here as I go. For example, the section numbers had to be bumped up since we inserted a new section above them.
  2. We need to also register the DID service names, and that section needs work as well. See below, but after discussing this with Manu Sporny, we need to make a PR into a DID registry repo with the proposed service names. Following Manu's suggestion, I think now we should use WotThing and WotDirectory, with the same meanings as wot.thing and wot.directory used for CoRE. I have created another issue to update the spec itself: Update DID Service Names #393

Section 5.2 Well-Known URIs

Send a following registration requests to wellknown-uri-review@ietf.org. see RFC8615 section 3.1

Section 5.3 DNS-Based Service Discovery

Register to IANA Service Name and Transport Protocol Port Number Registry
(from this form?). See RFC8552 section 4.1, RFC6335, RFC8126.

  • Service Name: wot
  • Transport Protocol: TCP, UDP
  • Assignee: (the organization, company or individual person responsible for the initial assignment. W3C or WoT WG?)
  • Contact: ( Name and email address of the Contact person for the assignment. One of Chairs or Editors?)
  • Description: Service name to search a Thing or a Thing Description Directory of W3C Web of Things.
  • Reference: Web of Things (WoT) Discovery (https://www.w3.org/TR/wot-discovery/ ) Section 6.3
  • Port Number: N/A
  • Assignment Notes:
    • RR Type: PTR, SRV, TXT
    • We also want to register subtype "_directory" for selectively search WoT directory service.

Section 5.4 CoRE Link Format and CoRE Resource Directory

Registration requests should be sent to the core-parameters@ietf.org mailing list, marked clearly in the subject line (e.g., "NEW RESOURCE TYPE - wot.thing and wot.directory"). See RFC6690 section 7.4

  • Attribute Value: wot.thing, wot.directory
  • Description:
    • wot.thing: link to WoT Thing Description of a Thing
    • wot.directory: link to WoT Thing Description of a Thing Description Directory
  • Reference: Web of Things (WoT) Discovery (https://www.w3.org/TR/wot-discovery/ ) Section 6.4
@k-toumura
Copy link
Contributor Author

#193 (comment)
Should we change a suffix of Well-known URI to wot-td?

@mmccool
Copy link
Contributor

mmccool commented Aug 30, 2021

Note: there is text in the spec, but this issue will only be closed once actual IANA registration has been done.

@mmccool
Copy link
Contributor

mmccool commented Aug 22, 2022

Discussion in Discovery 22.8:

  • Ideally these are pre-CR but pre-PR ok
  • Separate procedure than W3C
  • If takes longer than expected will have to negotiate with PLH, etc.

Consensus:

  • No changes expected, let's proceed with registrations.
  • Add Ed note to document that these are in progress (mmccool to do PR).

@mmccool
Copy link
Contributor

mmccool commented Aug 22, 2022

McCool will do immediately, will put Kaz's name and email as contact.

@mmccool mmccool self-assigned this Aug 22, 2022
@mmccool mmccool added Resolve by CR Issues that need to be resolved by CR and removed resolve by PR labels Aug 22, 2022
@mmccool
Copy link
Contributor

mmccool commented Aug 22, 2022

We may also need to register the service names for DID documents. See #65. I will ping the DID group to ask if there is a process. We should also decide on the service name. The spec currently links to issue 65, but uses a long service name in the example (WoTThingDescription) that is (now) inconsistent with the name used elsewhere, and does not mention a separate service name for Directories.

Will follow up in issue 65, but I think we should use service names consistent with DNS-SD, i.e. wot.thing and wot.directory, if we can.

Update: names WotThing and WotDirectory are preferred. See below.

@mmccool mmccool changed the title Registration of Well-known URI, Service Name and CoRE Resource Type Registration of Well-known URI, DNS-SD and DID Service Names, CoRE Resource Type Aug 23, 2022
@mmccool
Copy link
Contributor

mmccool commented Aug 23, 2022

Have communicated with Manu Sporny from DID, here is the response. May be best to use the names he suggests. Note that apparently the service names also need to be defined in the JSON-LD context used by the DID Document? Not sure if this can be done in a "central" place (e.g. the DID repo), since we don't control the "DID Resolvers". I'm also wondering if for consistency we should add a "DID Considerations" section to the WoT Discovery spec.


Registration isn't required, but is encouraged. There is a "Service Types" section in the DID Specification Registries:

https://w3c.github.io/did-spec-registries/#service-types

You can name a service type anything you'd like (as long as it doesn't
clash with anything else in the document)... though they typically
take the following form:

WotThing
WotDirectory

Also, ensure that the JSON-LD Context you include in the DID Document
defines both of those class names above.

You can raise a PR to add those service types in this section:

https://github.com/w3c/did-spec-registries/blob/main/index.html#L1527

on this repo:

https://github.com/w3c/did-spec-registries/pulls

@mmccool
Copy link
Contributor

mmccool commented Aug 23, 2022

IETF Well-Known URI registration request sent. Based on the RFC I included some additional information on the media type of the resource, and I also provided (updated) section numbers. Here is the actual content of the email; probably should update the matching Considerations section to match.


The W3C Web of Things (WoT) WG would like to register a well-known URI to support WoT Discovery. Here is the requested information; please contact me (Michael McCool, [...](...)) if you need to discuss or need additional information.

These specs are under final review and are expected to enter W3C Candidate Recommendation status this September.

@mmccool
Copy link
Contributor

mmccool commented Aug 23, 2022

DNS-SD registration request has been made. The form did not reflect my submission and I provided Kaz's email, so I did not get a copy. I will ask Kaz to provide a copy of the request when he (I assume) gets an acknowledgement via email.

@mmccool
Copy link
Contributor

mmccool commented Aug 23, 2022

Hmmm... the WoT Discovery doc says registration should be to "Underscored and Globally Scoped DNS Node Names" but I sent registration to "Service Name and Transport Protocol Port Number Registry" as specified above.

Which one is correct? Or is the first supposed to be provided as the "type" of the second? Also not sure what specific values (RR Types) we need to request, i.e. is _wot an SRV or TXT here? Both? (PTR does not seem to appear in this table, BTW). Do we also have to request _directory._sub._wot? I don't see any other subtypes in this table...

Anyway, unfortunately it seems my prior submission was messed up and there is no way to access, recall, or edit it. Going to hold off trying to fix my previous (broken) submission until we can discuss and try to get it right.

@mmccool
Copy link
Contributor

mmccool commented Aug 23, 2022

The CoRE parameters request has been sent, with the following text. Note: "WoT Directory Description of a Thing Description Directory" updated to "WoT Thing Description of a Thing Description Directory" and "wot.description" updated to "wot.directory", consistent with the WoT Discovery spec.


The W3C Web of Things (WoT) WG is requesting two new resource types for the CoRE Links and Resource Directories:

@mmccool
Copy link
Contributor

mmccool commented Aug 23, 2022

Ugh. For DID service names WotThing and WotDirectory, it seems these are actually RDF terms, which mean they should actually be URLs defined... somewhere. In a DID Document (which is a JSON-LD document) it occurs to me we could define the terms in the @context directly, but we need to define the terms using a URL. So... we should actually define the URLs in the WoT Discovery document (I think). I have created issue #393 and will update it with these requirements. I think the easiest thing to do is define these as part of the wot-discovery ontology and under the context URL defined for that.

@mmccool
Copy link
Contributor

mmccool commented Sep 5, 2022

This can wait until PR, still in progress.

@mmccool mmccool added resolve by PR Resolve by CR Issues that need to be resolved by CR and removed Resolve by CR Issues that need to be resolved by CR resolve by PR labels Sep 5, 2022
@mmccool
Copy link
Contributor

mmccool commented Sep 5, 2022

No, it seems we do need to get the names nailed down by CR transition. So we will just have to work over the next two weeks to get it done... or at least started.

@mmccool
Copy link
Contributor

mmccool commented Jan 23, 2023

According to the above the well-known URI and Core-RD registration requests were sent, I need to confirm that they were approved.

@mmccool
Copy link
Contributor

mmccool commented Jan 23, 2023

Here is the link for well-known URIs. I checked that the email was indeed sent (on 8-23) but wot does not yet appear: https://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml. Apparently though there was an issue created with a few questions, see protocol-registries/well-known-uris#24; I have updated the text to:

URI suffix: wot
Change controller: [team-wot@w3.org](mailto:team-wot@w3.org)
Specification document(s): See the WoT Discovery specification (https://www.w3.org/TR/wot-discovery/#introduction-well-known)

@mmccool
Copy link
Contributor

mmccool commented Jan 23, 2023

I have not seen any response to the CoRE registration. The registry is also maintained by IANA and is located here; wot does not (yet) appear: https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#rt-link-target-att-value
I have pinged the core-parameters email again but will also check with Carsten Bormann.

@mmccool
Copy link
Contributor

mmccool commented Feb 20, 2023

Confirmation: both IANA and CoRE-RD registrations have now been completed.

@mmccool
Copy link
Contributor

mmccool commented Feb 20, 2023

DID is still not done, need to clean up URLs. See w3c/did-spec-registries#486 and #463

@mmccool mmccool removed the Resolve by CR Issues that need to be resolved by CR label Mar 20, 2023
@mmccool
Copy link
Contributor

mmccool commented May 22, 2023

All done, and now consistent. Can close.

@mmccool mmccool closed this as completed May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants