[oslc-core] Proposed change to JSON formatting rules for Query responses

[Patrick Streule]

I am in favor of Steve's suggestion, too, but this would mean that the same
change is necessary elsewhere:

Looking at the example in
http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixB?sortcol=table;up=#Query_Resource

There is a resource oslc:BlogQuery with oslc_blog:comment properties that
hold the query results.

These elements are defined by the Query Resource Shape.

Some concerns that I have:

1) Wouldn't these resources/properties also have to be spec'd by the
domains? I.e. the CM spec would have to define e.g. a
'oslc_cm:ChangeRequestQueryResult' resource. Currently, I don't see
anything about query results e.g. in the CM, QM and RM specs.

2) Does a domain specific query result resource provide added value over a
generic 'oslc:QueryResult' resource with 'oslc:results' properties? I see
that we get "Type Safety" by the domain specific resources/properties, but
the convenience of a common format for query results seems to outweigh
that, IMO.

Thanks,
Patrick



                                                                                                                                                   
  From:       Steve K Speicher <sspeiche at us.ibm.com>                                                                                               
                                                                                                                                                   
  To:         oslc-core at open-services.net                                                                                                          
                                                                                                                                                   
  Date:       07/27/2010 10:57 PM                                                                                                                  
                                                                                                                                                   
  Subject:    [oslc-core] Proposed change to JSON formatting rules for Query    responses                                                          
                                                                                                                                                   





Current JSON guidance [1] doesn't address what the result array name
should be.

I recommend that we use "oslc:results" array, like for delegated UIs [2]

See also example at [3], how does a consumer know to look for array named
"oslc_blog:comment" in this example.  I think it would be best to use a
general OSLC property.
So this example would become:
 "oslc:results" : [{
       "oslc:qname" : "oslc_blog:BlogComment",
       "rdf:resource" : "http://example.com/blogs/comment/346",
    },

[1]
http://open-services.net/bin/view/Main/OSLCCoreRepresentationsGuidance#Guidelines_for_JSON

[2]
http://open-services.net/bin/view/Main/OslcCoreSpecification#Delegated_User_Interface_Dialogs

[3]
http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixD#Query_Resource

Thanks,
Steve Speicher | IBM Rational Software | (919) 254-0645


_______________________________________________
Oslc-Core mailing list
Oslc-Core at open-services.net
http://open-services.net/mailman/listinfo/oslc-core_open-services.net