construction pattern for property identifiers in the REST spec

[Robin Cover <robin@oasis-open.org>]

Hi Toby.

WRT the draft spec for the REST spec

"WS-Calendar Calendar Update and Synchronization with REST-based Services Version 1.0"

I was a bit surprised to see the creation of property

identifiers using the domain "docs.oasis-open.org/"

where the identifiers don't follow the expected pattern.

Maybe this was was discussed in connection with other

WS-Calendar TC spec approvals, but I don't recall it...

I say "surprised" because we do indeed authorize the

creation of identifiers for properties based upon

URNs or HTTP-scheme URIs, but when the Internet domain

"docs.oasis-open.org" is used, there's a restriction

on construction of the identifier string for any

"properties" (namespace), per details cited at [3]

below.

WD text was:

  3.  Properties and link relations

  3.1 Property and relation-type URIs

  "Certain of these property URIs correspond to CalDAV

   preconditions. Each URL is prefixed by the CalWS

   relations and properties namespace:

   http://docs.oasis-open.org/ns/wscal/calws

(attested strings)

http://docs.oasis-open.org/ns/wscal/calws

http://docs.oasis-open.org/ns/wscal/calws/caldav/supported-calendar-data

http://docs.oasis-open.org/ns/wscal/calws/calendar-collection

http://docs.oasis-open.org/ns/wscal/calws/calws/timezone-service

http://docs.oasis-open.org/ns/wscal/calws/child-collection

http://docs.oasis-open.org/ns/wscal/calws/collection

http://docs.oasis-open.org/ns/wscal/calws/created

http://docs.oasis-open.org/ns/wscal/calws/current-principal-freebusy

http://docs.oasis-open.org/ns/wscal/calws/description

http://docs.oasis-open.org/ns/wscal/calws/displayname

http://docs.oasis-open.org/ns/wscal/calws/last-modified

http://docs.oasis-open.org/ns/wscal/calws/max-attendees-per-instance

http://docs.oasis-open.org/ns/wscal/calws/max-date-time

http://docs.oasis-open.org/ns/wscal/calws/max-instances

http://docs.oasis-open.org/ns/wscal/calws/max-resource-size

http://docs.oasis-open.org/ns/wscal/calws/min-date-time

http://docs.oasis-open.org/ns/wscal/calws/owner

http://docs.oasis-open.org/ns/wscal/calws/principal-freebusy

http://docs.oasis-open.org/ns/wscal/calws/principal-home

http://docs.oasis-open.org/ns/wscal/calws/supported-features

http://docs.oasis-open.org/ns/wscal/calws/timezone

http://docs.oasis-open.org/ns/wscal/calws/timezone-service

http://docs.oasis-open.org/ns/wscal/calws:privilege-set

Please let me know if there are any issues.  For properties,

we would expect something like this in the initial identifier

substring:

a) http://docs.oasis-open.org/ns/ws-calendar/

b) http://docs.oasis-open.org/ws-calendar/ns/

   [newer model]

In both patterns, the TC name (tc-shortname) is required,

because identifiers are allocated/managed on a TC-by-TC

basis.  The TC "owns" that space of names/identifiers.

Following the initial substring, per above, you could use

anything else (reasonable) like:

wscal/calws/caldav/

wscal/calws/calws/

wscal/calws/

wscal/[xxxx]/

calws/[xxxx]/

in the pattern to construct identifiers that terminate with

(e.g.,) these substring elements/compnents

- supported-calendar-data

- calendar-collection

- timezone-service

- child-collection

- collection

- created

- current-principal-freebusy

- description

- displayname

- last-modified

- max-attendees-per-instance

- max-date-time

etc

- Robin

[1] XML Namespace Identifiers and Namespace Documents

http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html#xml-namespaces

[2] URI pattern: http://docs.oasis-open.org/[tc-shortname]/ns/xxxx

http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html#ns-URI-string-rules

[3] Non-information resources

    http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html#nonInformationResources

    "Non-information resources using identifiers associated with XML

    namespaces may be based upon any HTTP scheme URI XML namespace

    declared by the TC (i.e., identifiers for named properties,

    functions, dialects, faults, actions, or any named message types).

    Example: see the Link Relations URIs in one of the CMIS v1.0 XML

    namespace documents (e.g.,

    http://docs.oasis-open.org/ns/cmis/link/200908/allowableactions

    http://docs.oasis-open.org/ns/cmis/link/200908/policies ).

-- 
Robin Cover
OASIS, Director of Information Services
Editor, Cover Pages and XML Daily Newslink
Email: robin@oasis-open.org
Staff bio: http://www.oasis-open.org/people/staff/robin-cover
Cover Pages: http://xml.coverpages.org/
Newsletter: http://xml.coverpages.org/newsletterArchive.html
Tel: +1 972-296-1783