rest/property - Revision history

Brian: Reverted edits by DommoNdomm (Talk) to last version by MarcPortier

2008-12-20T22:03:28Z

Reverted edits by DommoNdomm (Talk) to last version by MarcPortier

← Older revision		Revision as of 22:03, 20 December 2008
Line 1:		Line 1:
	~~getacdomouri~~
	= The Problem =		= The Problem =

DommoNdomm: coloelr

2008-12-20T02:00:53Z

coloelr

← Older revision		Revision as of 02:00, 20 December 2008
Line 1:		Line 1:
			getacdomouri
	= The Problem =		= The Problem =

MarcPortier at 14:31, 13 November 2007

2007-11-13T14:31:44Z

← Older revision		Revision as of 14:31, 13 November 2007
Line 55:		Line 55:

	* Is ".;prop1" the right 'href' syntax for a relative property?		* Is ".;prop1" the right 'href' syntax for a relative property?
			** Using the ; notation sounds like it should concur with the notion of "MatriX URI's". See http://www.w3.org/DesignIssues/MatrixURIs.html (Not that any browser currently supports such to my knowledge).
	* Are those the right rules for chaining? Do we even need to worry about namespace/hierarchy?		* Are those the right rules for chaining? Do we even need to worry about namespace/hierarchy?
	* Should we not allow multiple updates? If we do, should we just make "&" the separator instead of ';', for clarity		* Should we not allow multiple updates? If we do, should we just make "&" the separator instead of ';', for clarity

DrErnie: /* Open Issues */

2006-05-06T16:49:04Z

Open Issues

← Older revision		Revision as of 16:49, 6 May 2006
Line 54:		Line 54:
	= Open Issues =		= Open Issues =

	* ~~Can properties be hierarchical? If so, is~~ ";prop1~~/subprop1~~" the ~~proper~~ syntax?		* Is ".;prop1" the right 'href' syntax for a relative property?
	* ~~Is that~~ the right ~~href syntax~~ for ~~a relative property~~?		* Are those the right rules for chaining? Do we even need to worry about namespace/hierarchy?
	* ~~Can properties be chained together~~? If so, ~~are they retrieved in parallel~~, ~~or would those be subproperties?~~		* Should we not allow multiple updates? If we do, should we just make "&" the separator instead of ';', for clarity
	* Would we need to worry about [http://lists.evolt.org/archive/Week-of-Mon-20020114/065707.html semicolon exploits]?		* Would we need to worry about [http://lists.evolt.org/archive/Week-of-Mon-20020114/065707.html semicolon exploits]?
	: Probably not in general, but any implementation which uses a database-style back end (vs. flat files) would need to guard against injection attacks. The ";" itself isn't the problem at all, expect for the fact that it was used as a "escape sequence" by some applications, with the terminal string fed directly into a database (bad!).		: Probably not in general, but any implementation which uses a database-style back end (vs. flat files) would need to guard against injection attacks. The ";" itself isn't the problem at all, expect for the fact that it was used as a "escape sequence" by some applications, with the terminal string fed directly into a database (bad!).
	* Are there other conventions we should follow/avoid?		* Are there other conventions we should follow/avoid?
	* Should the "Link:" tag itself be declared in HTTP "OPTIONS"?		* Should the "Link:" tag itself be declared in HTTP "OPTIONS"?
	* How does ~~thi~~ relate to RDF? Could a normative RDF schema be mapped into relProperty? Or just vice versa?		* How does this relate to RDF? Could a normative RDF schema be mapped into relProperty? Or just vice versa?

DrErnie: /* Examples */

2006-05-06T16:47:22Z

Examples

← Older revision		Revision as of 16:47, 6 May 2006
Line 45:		Line 45:
	* GET http://example.org/branch/README.html		* GET http://example.org/branch/README.html
	:primary document, returns HTML		:primary document, returns HTML
	* GET http://example.org/branch/README.html;lastAccessed		* GET http://example.org/branch/README.html;time.lastAccessed
	:get property, returns "<nowiki><ol><li>2006T...</li></ol></nowiki>"		:get property, returns "<nowiki><ol><li>2006T...</li></ol></nowiki>"
	* POST http://example.org/branch/README.html;~~ownedBy~~?John%20Doe		* POST http://example.org/branch/README.html;owner?John%20Doe
	: set property ";~~ownedBy~~" to the value "John Doe"		: set property "; owner" to the value "John Doe"
			* POST http://example.org/branch/README.html?;status=green&;lastTested=today
			: set two properties, ";status" and ";lastTested"

	= Open Issues =		= Open Issues =

DrErnie: /* <link> */

2006-05-06T16:45:30Z

<link>

← Older revision		Revision as of 16:45, 6 May 2006
Line 28:		Line 28:
	<link rel="property" href=".;prop1">		<link rel="property" href=".;prop1">

	This syntax assumes precisely one property per link statement, though it may be possible/desireable to ~~define~~ "chain" multiple property declarations into a single statement.		This syntax assumes precisely one property per link statement, though it may be possible/desireable to "chain" multiple property declarations into a single statement.

	== ;property ==		== ;property ==

DrErnie: /* Examples */

2006-05-06T16:44:01Z

Examples

← Older revision		Revision as of 16:44, 6 May 2006
Line 46:		Line 46:
	:primary document, returns HTML		:primary document, returns HTML
	* GET http://example.org/branch/README.html;lastAccessed		* GET http://example.org/branch/README.html;lastAccessed
	:get property, returns "<ol><li>2006T...</li></ol>"		:get property, returns "<nowiki><ol><li>2006T...</li></ol></nowiki>"
	* POST http://example.org/branch/README.html;ownedBy?John%20Doe		* POST http://example.org/branch/README.html;ownedBy?John%20Doe
	: set property ";ownedBy" to the value "John Doe"		: set property ";ownedBy" to the value "John Doe"

DrErnie: /* Examples */

2006-05-06T16:39:20Z

Examples

← Older revision		Revision as of 16:39, 6 May 2006
Line 40:		Line 40:
	# Within a given property, the user is free to define their own namespace. To avoid confusion with HTTP hierarchies, we recommned the use of '.' as an internal separator. However, due to the above rule, this does mean that the full namespace must be explicitly spelled out for every property		# Within a given property, the user is free to define their own namespace. To avoid confusion with HTTP hierarchies, we recommned the use of '.' as an internal separator. However, due to the above rule, this does mean that the full namespace must be explicitly spelled out for every property

			= Response format =
			Unless otherwise specified, we recommend that property queries be returned as type "html", using XOXO encoding to return multiple or composite values.
	= Examples =		= Examples =
	* ~~TBD~~		* GET http://example.org/branch/README.html
			:primary document, returns HTML
			* GET http://example.org/branch/README.html;lastAccessed
			:get property, returns "<ol><li>2006T...</li></ol>"
			* POST http://example.org/branch/README.html;ownedBy?John%20Doe
			: set property ";ownedBy" to the value "John Doe"

	= Open Issues =		= Open Issues =

DrErnie: /* ;property */

2006-05-06T15:42:54Z

;property

← Older revision		Revision as of 15:42, 6 May 2006
Line 32:		Line 32:
	== ;property ==		== ;property ==

	~~It is conventional~~, ~~but not mandatory~~, to ~~use a semicolon~~ (";") as the first character of each property. This follows the convention used in, e.g. [http://www.macromedia.com/cfusion/knowledgebase/index.cfm?id=1c6b723 ColdFusion], and eases human-readability.		Since individual properties must each be explicitly specified by a link, they can in principle be expressed using any notation whatsoever. However, we here propose a convention for how to describe, chain, and hierarchicalize properties by using thesemicolon (";") as the first character of each property. This follows the convention used in, e.g. [http://www.macromedia.com/cfusion/knowledgebase/index.cfm?id=1c6b723 ColdFusion], and eases human-readability.

			The proposed convention is as follows are:

			# Each and every ';' in the URL indicates the beginning of a property
			# Thus, multiple properties can be unambiguously chained into a single URL, though this SHOULD NOT be done unless the properties in question are very closely coupled (e.g. ";month=10;day=2")
			# Within a given property, the user is free to define their own namespace. To avoid confusion with HTTP hierarchies, we recommned the use of '.' as an internal separator. However, due to the above rule, this does mean that the full namespace must be explicitly spelled out for every property

	= Examples =		= Examples =

DrErnie: /* relProperty */

2006-05-06T15:31:27Z

relProperty

← Older revision		Revision as of 15:31, 6 May 2006
Line 10:		Line 10:
	Our proposal, currentlly called "relProperty", is motivated by the following principles:		Our proposal, currentlly called "relProperty", is motivated by the following principles:

	# Every property must have at least one well-defined URL ~~which can~~ be ~~retrieved~~ and ~~updated.~~		# Every property must have at least one well-defined URL that points to it
			# That URL must be useable to both retrieve and update that property
	# There must be an easy way to discover all the properties associated with a given document.		# There must be an easy way to discover all the properties associated with a given document.
	# It must be simple to implement on existing web servers without requiring non-trivial modifications		# It must be simple to implement on existing web servers without requiring non-trivial modifications