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>OslcCore>OslcCoreV2Issues (revision 193)

OSLC Core Spec V2 Issues

This document captures the issues raised against the OSLC Core Spec v2.

To see the list of issues that occurred during the convergence phase see OslcCoreV2ConvergenceIssues

Finalization issues

This section tracks finalization issues, some of which have been or will be reflected in changes above.

These are the issues raised during the development of the OSLC Core spec up to finalization time.

Note: dates below use US format (mm/dd/yyyy)

Here's what the states mean:

  • OPEN - indicates that we have no response for the issue yet
  • RESOLVED - indicates that we have a response that we believe resolves the issue
  • CLOSED - issue has been resolved and the resolution has been reviewed by the WG
  • DEFERRED - indicates that issue will be addressed in Core Guidance v1.0 during the month after the Core Specification is final.
  • TABLED - indicates that issue will be reconsidered at some later but unspecified date

Issues:

  1. CLOSED We should reconsider requiring clients to ask for paging
    • No, things work well as is
  2. CLOSED On requests for too large resources, OSLC Services should be able to redirect to URL that specifies paging
  3. CLOSED We need to make it clear that the oslc:ResponseInfo properties' subject resource is the page URL and not the base resource URL
    • This is already clear because paging is always indicated in the URL
  4. CLOSED What does oslc:totalSize mean, is it total number of triples or what?
  5. DEFER oslc:ResponseInfo should be renamed to oslc:Page
    • Consensus: Too late for such a change
  6. DEFER oslc:paging should be renamed to oslc:pagination
    • Consensus: Too late for such a change
  7. DEFER use rdf:next instead of oslc:nextPage
    • Consensus: Too late for such a change
  8. CLOSED In section Graph Patterns. re: "defines a starting subject resource, namely the base URI itself" - First paragraph: Which base URI, specified how? I think you mean the “starting subject resource” but cannot be sure. “Base URI” is particularly troublesome since a given URI can have many potential base URIs. (JA, Dec. 9, 2010)
    • Added clarification, pointing to Service Provider - Creation Factory (Dave Johnson, Dec 9, 2010)
  9. CLOSED Definition of oslc:totalCount is not clear.
    • Resolution is to say something like this: if resource is from a Query Syntax URL, then this is number of RDF nodes, if not then it is a relative measure of the size of the resulting resource across all pages.
    • Resolution: Changes have been applied (DaveJohnson, Dec. 17, 2010)
  10. CLOSED In section "Property tree patterns" - I'd be careful with how this is stated. I think you want to allow implementations to support wider query scopes. If a client understands some RTC-specific property, I think you want to allow it just not require it. Unclear if this is intended to be a MUST NOT, informative, or what. (JA, Dec. 9, 2010)
    • Resolution: we want to allow wider scope but not require it, so now we say "MAY be limited" (DaveJohnson, Dec. 17, 2010)
  11. CLOSED re: "scope of the query is limited to the boundaries of the service". Need definition for "nested properties" Should I read this to imply that the “initial resource”, which may or may not be the same as the “starting subject resource”, must not have any nested properties (whatever those are)? (JA, Dec. 9, 2010)
    • Resolution: added definition for Nested Property (DaveJohnson, Dec. 17, 2010)
  12. CLOSED In section "Prefixed Names" - Don’t recall [Prefixed Names] being defined anywhere in Core. Obvious enough for XML weenies, but probably not for json weenies. What is hear frankly comes across as a circular definition. (JA, Dec. 9, 2010)
    • Resolution: added definition for Prefixed Name and referred to SPARQL spec for precision (DaveJohnson, Dec. 17, 2010)
  13. DEFERRED Query parameters, re: "syntax is formally defined using a common extended form of BNF" (JA, Dec. 9, 2010)
    • Resolution: added reference to wikipedia definition of EBNF. We do need a better grammar and prefer to use ANTLR since it is machine readable and supported by tools, but we will defer until a later version of the Core spec (DaveJohnson, Dec. 17, 2010)
  14. CLOSED Syntax for 'space' - I notice your grammar precludes >1 consecutive space. That seems rather unforgiving. Would be tempted to make it 0:* and then in the text here state that implementations MUST support the single space and MAY support >1, if there is really a good reason to distinguish. (JA, Dec. 9, 2010)
    • Resolution: we are OK with being unforgiving here. The syntax is intended for use in URLs and not written directly by end-users and we'd like to make things easier for those implementing parsers (DaveJohnson, Dec. 17, 2010)
  15. CLOSED Syntax for 'comparison_op' - I don’t think the comparison ops are close to fully specified. I have no idea what it means to compare a Boolean to a string in your language, but I don’t think you prevented that. Let alone boolean1 > boolean2 and similar. String comparisons have all sorts of collating sequence issues that need to be handled if you really want interoperability. (JA, Dec. 9, 2010)
    • Resolution: added note that datatypes and operator semantics MUST work as defined in SPARQL query language (DaveJohnson, Dec. 17, 2010)
  16. CLOSED Syntax for 'in_op' - Nitty I know, but according to the BNF the spaces are not part of the operator. So either you imply that the values being tested cannot contain a comma, or there is some escaping mechanism left unspoken here. (JA, Dec. 9, 2010)
    • Resolution: No change because there is no chance of ambiguity about commas, things without quotes true, false, numbers. Only strings are contained in quotes. (DaveJohnson, Dec. 17, 2010)
  17. CLOSED Syntax for 'literal_value' - re: "datatype URI" - If there is a formal OSLC-defined name for this, encourage you to use it here. As an XML schema weenie, this construction leads me to xs:anyURI at first glance. (JA, Dec. 9, 2010)
    • Resolution: No change because we already refer to the Refer to SPARQL spec for syntax of URIs (DaveJohnson, Dec. 17, 2010)
  18. CLOSED Section 'oslc.searchTerms' re: "Each resource that is returned in the response is annotated with a special property, oslc:score, that gives its match score." Do you mean to say MUST be? (JA, Dec. 9, 2010)
    • Resolution: Yes, this is now a MUST (DaveJohnson, Dec. 17, 2010)
  19. CLOSED Section 'oslc.searchTerms' Integer? Not actually sure why you bother to constrain this at all, but given that you feel the need and given that your example appears to use only integers, worth asking.
    • Resolution: No change. Number is correct because we want to allow floats here (DaveJohnson, Dec. 17, 2010)
  20. CLOSED Section 'oslc.orderBy' - definition needed for Nested Properties (JA, Dec. 9, 2010)
    • Resolution: Fixed by #11 above (DaveJohnson, Dec. 17, 2010)
  21. CLOSED Section 'oslc.select' - "then the matching process does NOT match" - This could easily be read to mean that no members would match (you’d always get 0 members back), which is clearly not the intent. Don’t you just want something like “…then this (absent) criterion does not affect the list of members returned.”? It’s quite hard to clearly define a negative.
    • Resolution: accepted suggested clarification (DaveJohnson, Dec. 17, 2010)
  22. CLOSED oslc:discussion is listed as a common property (in CmSpecificationV2 ) but it is not listed as such in OSLCCoreSpecAppendixA Also suggested is a better name like oslc:discussedBy (WikiName? , 01/07/2011)
    • Response Adding to Appendix A and renaming to oslc:discussedBy. (SteveSpeicher 1/21/2011)
  23. CLOSED oslc:discussion is also listed as a property of oslc:Comment in OSLCCoreSpecAppendixA though with a different meaning (WikiName? , 01/07/2011)
    • Response From oslc:Comment renamed oslc:discussion to oslc:partOfDiscussion. (SteveSpeicher 1/21/2011)
  24. DEFER How to create oslc:Comment resources? Appears to be no guidance, perhaps a Core issue? (WikiName? , 01/07/2011)
    • Response Possible ways to handle: add informative section saying to use creation factories or simply use resource update, adding a new comment entry. There once was a statement about POSTing to the Discussion URL to create comments, not sure why it was removed.. (SteveSpeicher mm/dd/2011)
  25. CLOSED Encoding of UI preview label (SamPadgett, 08/15/2011)
  26. CLOSED JSON formatting rules ambiguities (JohnArwe, 08/15/2011)
  27. CLOSED dialog prefilling awkward statement (JohnArwe, 09/01/2011)
    • Response Clarification on wording suggested in email and made changed in [[http://open-services.net/bin/view/Main/OslcCoreSpecification?rev=68][revision (SteveSpeicher 9/21/2011)
  28. CLOSED mail thread resource selection section the first table under that heading contains the string "occurs" in each row of its "Occurs" column instead of zero-or-one etc (JohnArwe, 09/01/2011)
  29. CLOSED mail thread oslc:shortTitle differences (JacobYackenovich, 09/01/2011)
  30. RESOLVED anchor duplication (JohnArwe 11/09/2011)
    • Response Fix by using Wiki override option to add unique anchors (SteveSpeicher 11/16/2011)
  31. OPEN Format encoding/charset defaults (FrankBudinsky 11/22/2011)
    • Response TBD
  32. CLOSED How to expose a non-OSLC domain using oslc:domain (JohnArwe 10/21/2011)
  33. OPEN XHTML vs simple text in OSLC Core's common properties (JohnArwe 11/15/2011)
    • Response TBD
  34. OPEN Representing the order of triples in a query response that uses oslc.orderBy (ArthurRyman 12/08/2011)
    • Response Arthur included a proposal in the same note
  35. OPEN Buglet in Core 2.0 - non-exemplary(?) use of Change Request (JohnArwe 12/30/2011)
    • Response TBD
  36. OPEN Ambiguity in Resource Shape definition + consequent questions (JohnArwe 12/30/2011)
  37. CLOSED Icon alt/title text (Bill Andreas 2/15/2012)
  38. OPENSuggested improvements to representations samples - (John Arwe 2/15/2012)
    • Response TBD, looking for contributor.
  39. CLOSED oslc.properties questions - (IanGreen 3/14/2012)
  40. RESOLVEDoslc:modifiedBy proposal - (ArthurRyman 3/14/2012)
    • Response Agree with adding - need to propose text, ask DCMI and clarify dcterms:contributor guidance
  41. OPENMulti-typed resource scenarios and rdf:type/dcterms:type - (MichaelFiedler 3/14/2012)
    • Response TBD
  42. OPEN unknown or unsupported property handling - (SamPadgett 3/21/2012)
    • Response TBD
  43. OPEN Read-only and friends - (JohnArwe 4/13/2012)
  44. OPEN correct all occurrences of open-service.net/ns (missing final s on serviceS) on the website - (JohnArwe 2012-05-30)
    • Response SteveSpeicher has done a search/replace through wiki pages, need to do attached examples
  45. OPEN the usage of QName in this context is not valid. It should really state that we use hash URIs and this is the fragment segment of the URI. Need to promote/clarify OSLCCoreURINamingGuidance - (ArthurRyman 2012-06-13)
    • Response TBD
  46. OPEN Resource shapes provide no way to represent an RDF Plain Literal, only typed literals - (JohnArwe for ArthurRyman, 2012-07-11)
    • Response TBD

After finalization changes

These are the corrections and clarifications made to the spec since it exited finalization, became final.

See CLOSED items above with FIXED subheadings.

Finalization changes

These are the corrections and clarifications made to the spec since it entered finalization.

  1. Changed #oslc-postMessage-1.0 to #oslc-core-postMessage-1.0 in the Delegated UI section.
  2. Changed width/height hints and iframe considerations to use relative length units as defined in the W3C? Cascading Style Sheets Specification (CSS 2.1) Em and ex units are interpreted relative to the default system font (at 100% size).
  3. Changed oslc:usage value-type from String to Resource with representation Reference.
  4. Appendix A: clarified property oslc:isMemberPropertiy with "For the purposes of the OSLC Query Syntax, indicates that the property is used to state membership of a resource in a collection. It is used when you filter a collection resource with a query."
  5. Appendix A: changed dcterms:contributor to allow resource value-type of Either and representation of Either.
  6. Appendix A: changed dcterms:creator to allow resource value-type of Either and representation of Either.
  7. Appendix A: clarified property dcterms:title with "Title of the resource shape. SHOULD include only content that is valid and suitable inside an XHTML element."
  8. Appendix A: clarified property dcterms:description with "Title of the resource shape. SHOULD include only content that is valid and suitable inside an XHTML element."
  9. Appendix D: corrected many Resource/Reference properties that were incorrectly represented as string values.
  10. Appendix B: corrected many RDF/XML examples so that they validate and attached new versions of the examples, linked to the RDF Validator.
  11. Appendix A: corrections to be consistent about showing Namespace URI for each resource and associated properties.
  12. Appendix B: changed xmlns:foaf="http://http://xmlns.com/foaf/0.1/" to xmlns:foaf="http://xmlns.com/foaf/0.1/".
  13. Appendix A: clarified description of oslc:instanceShape to explain its purpose
  14. Appendix A: clarified description of oslc:serviceProvider to explain what it means to have more than one
  15. In Defining OSLC Resources section, added reference to OSLC Link Guidance in description of Range
  16. Appendix A: Clarified introduction to explain that common properties available for use in domain specs, not required
  17. Glossary of Terms: Changed definition of OSLC Resource to read "a resource that is either defined by an OSLC specification, see OSLC Defined Resources below"
  18. Resource Paging: Added clarification and fixed terminology regarding usage of oslc:ResponseInfo
  19. Appendix A: Common properties - added rdfs:member
  20. Moved OSLC Core Representations Guidance into the Core Spec as Appendix B. What were previously appendices B, C and D have become example pages that are linked to from the new Appendix B.
  21. Moved OSLC Core Links Guidance into the Core spec as Appendix C.
  22. Added Query Specification errors sub-section to Query Syntax section, to clarify behavior when query specified incorrectly.
  23. oslc:details (Service Provider section) changed from 'one-or-many' to 'zero-or-more'
  24. Added section Provider response size limitations to the Core spec to clarify behavior when sever cannot return full response
  25. Expanded description of the Response Info oslc:totalCount property.
  26. Query Syntax spec: added definition for Nested Properties
  27. Query Syntax spec: added definition for Prefixed Names
  28. Query Syntax spec: changed "scope of the query is limited to the boundaries of the service" to "scope of the query MAY be limited to the boundaries of the service"
  29. Query Syntax spec: added requirement that datatypes and operators work as specified by SPARQL
  30. Query Syntax spec: changed ""Each resource that is returned in the response is annotated with a special property, oslc:score, that gives its match score" to "Each resource that is returned in the response MUST be annotated with a special property, oslc:score, that gives its match score"
  31. Appendix A: Common properties - added oslc:discussedBy, in oslc:Comment renamed oslc:discussion to oslc:partOfDiscussion and fixed some column for Read-only.
  32. Appendix A: oslc:Property property oslc:allowedValue had wrong occurs of zero-or-one, should be zero-or-many. This was an authoring error, as clearly this was to be a multi-valued property.
  33. Removed reference to incomplete Partial Update Guidance
  34. Corrected last example in Appendix C Link guidance to show full resource, and put rdf:about on correct element
  35. Clarified description of the OSLC Service Provider Catalog
  36. Removed text that said "domain specifications MAY specify other query syntaxes"
  37. Removed the "Occurs" columns from all common property tables in Appenix A
Edit | Attach | Print version | History: r194 < r193 < r192 < r191 < r190 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r193 - 03 Aug 2012 - 19:05:12 - SteveSpeicher
Main.OslcCoreV2Issues moved from Main.OslcCoreV1Issues on 23 Aug 2011 - 13:36 by SteveSpeicher - put it back
 
This site is powered by the TWiki collaboration platform 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