UserPreferences

PaceFixModel


Abstract

Simplify and clarify sections 3 and 4

Status

in play

Rationale

Between drafts protocol-09 and protocol-10, sections 3 and 4 were changed in a way which may not be accurate and seems unlikely to be helpful to implementors.

Section 3 used to define Member as "Member - A resource whose IRI is listed in a Collection"; with -10 this became 'A resource whose IRI is listed in a Collection by a link element with a relation of "edit" or "edit-media".'

The -09 version is unhelpful and the second version is wrong. A Member should be an Entry which is a member of a collection. In a collection which has <accept>entry</accept>, the members will be the Atom Entry documents created via POST that represent the entries. In a collection which accepts non-entries, the members will be the Media Link entries (per section 9.5) that describe the Resource entries. Thus, Resource entries (per section 9.5) are not in fact Member Entries because they don't actually appear in a collection.

On this basis, the definition in section 3 and the 2nd half of section 4 are confusing and arguably incorrect.

Proposal

1. Replace the definition of Member in section 3 with:

Member - A resource whose representation as an Atom Entry appears as one of the entries in the feed representing a collection.

2. Remove the word "Member" from the first paragraph of section 4, because (via the edit-media URI), APP can edit Media Resources, which are not members of any collection.

3. rewrite Section 4, replacing the text starting at the beginning of the 3rd para "There are two kinds of Member Resources...", to the end of the section, as follows:

Since not all resources can satisfactorily be represented as Atom Entries (for example, pictures or videos), they do not appear directly in collections and hence are not Member entries. In the APP context, these are referred to as Resource entries; they may be created, updated, and deleted as described in section 9.5.

4. Change all instances of "Member Entry IRI" to "Member IRI" (er, sometimes URI I note)

Impacts

The spec will be shorter, and the definition of "member" will correspond more closely with its normal usage.

Notes


CategoryProposals