[Registry-dev] Registry URLs and meanings

[Jonathan Marsh]

Just thinking about the data formats a little more.

 


/users/{username};tags

Collection of tags used by {username}

POST to rename tag

 

Just a text/plain payload for simple strings like this?

 


/{r1};properties

Collection of metadata properties

POST to add new property

 

Does it make sense for the POST format to be regular url-form-encoded
name-value pairs instead of an XML package?

 

If not, do I often have to make two calls to set a property with a
media-typed value?

  POST  (text/plain?) /r1;properties  foo

  PUT  (bar media-type)   /r1;properties:foo  bar 

 

Jonathan Marsh -  <http://www.wso2.com> http://www.wso2.com -
<http://auburnmarshes.spaces.live.com> http://auburnmarshes.spaces.live.com

 

From: registry-dev-bounces at wso2.org [mailto:registry-dev-bounces at wso2.org]
On Behalf Of Jonathan Marsh
Sent: Wednesday, November 07, 2007 6:54 PM
To: registry-dev at wso2.org
Subject: [Registry-dev] Registry URLs and meanings

 

Here is a sketch of the URI space and rough semantics of the registry we
came up with.

 


/users 

Collection of users

POST creates new user

n/a


/users/{username}

User resource

PUT to change data

DELETE


/users/{username};tags

Collection of tags used by {username}

POST to rename tag

no


/users/{username};tags:{tag}

Collection of resources tagged with {tag} by {username}

n/a

no


/users/{username};comments

 

Collection of comments writing by {username}

n/a

no


/tags

Collection of all tags used in the system

n/a

no


/tags/{tag}

Collection of all resources tagged {tag}

n/a

no


/{r1}

Resource {r1}

POST creates new child resource (if it's a directory), PUT to change data

DELETE (including children, comments, tags)


/{r1};tags

Collection of tags on {r1}

POST creates new tag

(? Also deletes a tag Glen says yes, Jon says no)

n/a


/{r1};tags:{tag+username}

{? Jon says yes, Glen says no)

Collection of tags 

n/a

(? Exception to PUT because the tag name and value are the same thing.)

DELETE 


/{r1};tags:{username}

Collection of tags on {r1} applied by {username}

n/a

no


/{r1};comments

Collection of comments on {r1}

POST creates new comment

no


/{r1};comments:{username}

Collection of comments on {r1} by {username}

n/a

no


/comments:{id}

Comment {id} resource

PUT to change content

DELETE


/{r1};properties

Collection of metadata properties

POST to add new property

no


/{r1};properties:{prop}

Value of {prop} property for {r1}

PUT to change value

DELETE


/{r1};ratings

Collection of ratings of {r1} (includes average)

POST to rate

no


/{r1};ratings:{username}

Rating of {r1} given by {username}

n/a

DELETE


/{r1}/{r2}

Resource {r2}

See /{r1}

See /{r1}


/d1/d2/{q1}?{p1=v1}

Collection of results of query {q1} with parameters p1,=v1, etc.

PUT to change query

DELETE to remove query

 

 

Jonathan Marsh -  <http://www.wso2.com> http://www.wso2.com -
<http://auburnmarshes.spaces.live.com> http://auburnmarshes.spaces.live.com

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://wso2.org/pipermail/registry-dev/attachments/20071108/905a8c3e/attachment-0001.htm