This wiki is locked. Future workgroup activity and specification development must take place at
our new wiki
. For more information, see
this blog post about the new governance model
and
this post about changes to the website
.
TWiki
>
Main Web
>
CmHome
>
CmTechnicalPrioritiesV2
>
CmComments
(21 Apr 2010,
RobertElves
)
(raw view)
---+++ DRAFT Comment Specification ---+++ Additional property on <font color="#630000">ChangeRequest</font> resource shape: * *Name*: discussion * *Description*: The discussion property holds a reference to the set of all comments on a ChangeRequest * *Occurs*: at-most-one * *Value-type:* Resource Comments * *Version*: 2.0 ---+++ Resource: Discussion * *Name*: Discussion * *Type URI*: http://open-services.net/xmlns/cm/2.0#Discussion * *Version*: 2.0 * *Description*: Contains zero-or-many *comment* properties * Properties of Comments resource shape: * comment (Resource Comment, zero-or-more) ---+++ Resource: Comment * *Name*: Comment * *Type URI*: http://open-services.net/xmlns/cm/2.0#Comment * *Version*: 2.0 * *Description*: Data necessary to represent a comment * Properties: * dc:identifier (exactly-one) * dc:creator (exactly-one) * dc:created (exactly-one) * oslc_cm:body (XMLLiteral xhtml, exactly-one) * oslc_cm:changeRequest (exactly-one) reference to associated change request * dc:title (XMLLiteral xhtml, zero-or-one) * oslc_cm:inReply-to (URI, zero-or-one) reference to comment this comment is in reply to ---+++ Sample ---++++ ChangeRequest with discussion inlined (RDF/XML) [[http://www.w3.org/RDF/Validator/ARPServlet?URI=http%3A%2F%2Fopen-services.net%2Fpub%2FMain%2FCmComments%2Fcr_v2.xml&PARSE=Parse+URI%3A+&TRIPLES_AND_GRAPH=PRINT_BOTH&FORMAT=PNG_EMBED&EMBEDDED_RDF=on&NODE_COLOR=Black&NODE_TEXT_COLOR=Blue&EDGE_COLOR=Darkgreen&EDGE_TEXT_COLOR=Red&FONT_SIZE=10&ORIENTATION=LR][Click HERE to see RDF/XML validation results]] <verbatim> <?xml version="1.0" encoding="UTF-8"?> <oslc_cm:ChangeRequest xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:dc="http://purl.org/dc/terms/" xmlns:oslc_cm="http://open-services.net/xmlns/cm/2.0#" rdf:about="http://example.com/bugs/2314"> <oslc_cm:discussion> <oslc_cm:Discussion rdf:about= [[http://myserver/mycmapp/bugs/2314/discussion][http://myserver/mycmapp/bugs/2314/discussion]]> <oslc_cm:comment> <oslc_cm:Comment rdf:about="http://myserver/mycmapp/bugs/2314/discussion/1"> <dc:identifier>comment1</dc:identifier> <dc:creator rdf:resource="http://myserver/mycmapp/users/joe" /> <dc:title>comment title 1</dc:title> <dc:created>2008-07-04T11:00:00.000Z</dc:created> <oslc_cm:body rdf:parseType="Literal"> This is my comment </oslc_cm:body> <oslc_cm:changeRequest rdf:resource="http://example.com/bugs/2314" /> <oslc_cm:inReplyTo rdf:resource="" /> </oslc_cm:Comment> </oslc_cm:comment> <oslc_cm:comment> <oslc_cm:Comment rdf:about="http://myserver/mycmapp/bugs/2314/discussion/2"> <dc:identifier>Comment 2</dc:identifier> <dc:creator rdf:resource="http://myserver/mycmapp/users/joe" /> <dc:title>comment title 2</dc:title> <dc:created>2008-07-05T11:00:00.000Z</dc:created> <oslc_cm:body rdf:parseType="Literal"> This is my 2nd comment </oslc_cm:body> <oslc_cm:changeRequest rdf:resource="http://example.com/bugs/2314" /> <oslc_cm:inReplyTo rdf:resource="http://myserver/mycmapp/bugs/2314/discussion/1" /> </oslc_cm:Comment> </oslc_cm:comment> </oslc_cm:Discussion> </oslc_cm:discussion> </oslc_cm:ChangeRequest> </verbatim> ---+++ Retrieving all Discussion <literal>Get {CR URI}/discussion</literal> <table cellspacing="0" cellpadding="0" id="table8" border="1"><thead><tr><th valign="top">Code </th><th valign="top">Content </th><th valign="top">Description </th></tr></thead><tbody><tr><td bgcolor="#ffffff" valign="top">200 OK </td><td bgcolor="#ffffff" valign="top">Comments resource </td><td bgcolor="#ffffff" valign="top">Comments resource with a number of comment resources</td></tr><tr><td bgcolor="#edf4f9" valign="top">404 Not Found </td><td bgcolor="#edf4f9" valign="top">Error message </td><td bgcolor="#edf4f9" valign="top">Either the root URI is invalid or the service can't locate the specified change request resource </td></tr><tr><td bgcolor="#ffffff" valign="top">405 Not Acceptable </td><td bgcolor="#ffffff" valign="top">Error message </td><td bgcolor="#ffffff" valign="top">Server can not fulfill the request due to it's Accept headers </td></tr></tbody></table> ---+++ Comment Creation <pre>POST {CR URI}/discussion</pre>Posting a well formed comment shape results in creation of a comment resource resource. A service provider MUST support at least the following HTTP response status codes: <table cellspacing="0" style="margin-top: 2px; margin-right: 0px; margin-bottom: 2px; margin-left: 0px; border-collapse: collapse; border-width: 1px; border-color: #e2e2e2; border-style: solid" cellpadding="0" id="table7" border="1"><thead><tr><th valign="top">Status Code</th><th valign="top">Response Content<br /></th><th valign="top">Description<br /></th></tr></thead><tbody><tr><td bgcolor="#ffffff" valign="top" style="border-bottom-style: solid; padding-bottom: 3px; padding-left: 6px; padding-right: 6px; border-top-style: solid; padding-top: 3px; border-width: 1px; border-color: #e2e2e2">201 Created</td><td bgcolor="#ffffff" valign="top" style="border-bottom-style: solid; padding-bottom: 3px; padding-left: 6px; padding-right: 6px; border-top-style: solid; padding-top: 3px; border-width: 1px; border-color: #e2e2e2">HTTP-Header > Location: {New Comment URI}</td><td bgcolor="#ffffff" valign="top" style="border-bottom-style: solid; padding-bottom: 3px; padding-left: 6px; padding-right: 6px; border-top-style: solid; padding-top: 3px; border-width: 1px; border-color: #e2e2e2">A new comment resource has been created at the URI returned</td></tr><tr><td>400 Bad Request<br /></td><td>Error message<br /></td><td>Malformed content (comment xml invalid)<br /></td></tr><tr><td>404 Not Found<br /></td><td>Error message</td><td>The request URL does not represent a URL on the serve</td></tr><tr style="background-color: #ffffff"><td>409 Conflict<br /></td><td>Error message<br /></td><td> Possible reasons: * inReplyTo not supported * referencd comment uri invalid </td></tr></tbody></table> ---+++ Comment Deletion <literal> DELETE {Comment URI} <span style='color: #000000; font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small' class='Apple-style-span'> </span> <span style='color: #000000; font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small' class='Apple-style-span'> Response: 501 Not Implemented</span> </literal> ---+++ Comment Update <literal> PUT {Comment URI}</literal> Response: 501 Not Implemented
Attachments
Attachments
Topic attachments
I
Attachment
Action
Size
Date
Who
Comment
xml
cr_v2.xml
manage
1.7 K
13 Apr 2010 - 19:38
SteveSpeicher
E
dit
|
A
ttach
|
P
rint version
|
H
istory
: r7
<
r6
<
r5
<
r4
<
r3
|
B
acklinks
|
V
iew topic
|
Ra
w
edit
|
M
ore topic actions
Topic revision: r7 - 21 Apr 2010 - 16:53:01 -
RobertElves
Main
Main Web
Create New Topic
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
Webs
Main
Sandbox
TWiki
Български
Cesky
Dansk
Deutsch
English
Español
Français
Italiano
日本語
Nederlands
Polski
Português
Русский
Svenska
简体中文
簡體中文
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our
Terms of Use
Ideas, requests, problems regarding this site?
Send feedback