Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-1453

Capabilities.SearchRestrictions/UnsupportedExpressions: description of default value "none" is misleading

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: New
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Vocabularies
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Options:

      1. Change description of none to "no restrictions, all search terms are supported" - somewhat counter-intuitive in the context of the enum type, but understandable in its single use
      2. Make UnsupportedExpressions nullable and its default value null - what would the value none then mean? No simple search, but more complicated expressions are allowed?
      Show
      Options: Change description of none to "no restrictions, all search terms are supported" - somewhat counter-intuitive in the context of the enum type, but understandable in its single use Make UnsupportedExpressions nullable and its default value null - what would the value none then mean? No simple search, but more complicated expressions are allowed?
    • Resolution:
      Hide

      https://github.com/oasis-tcs/odata-vocabularies/pull/133

      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/133

      Description

      The enum type SearchExpressions has no description, suggesting it simply is a set of flags allowing to turn on an arbitrary combination of search features. This suggests that the value none with a numeric value of 0 means "no features are on".

      The description of none however is "Single search term", suggesting that this is the minimum feature set, and other features can be added on top.

      The single use of type SearchExpressions is in the negatively named property UnsupportedExpressions, with a default value of none. Does this mean that:

      1. "Single search term" is not supported, i.e. even the most basic search will not work?
      2. "None of the features are not supported", i.e. everything is supported?

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              handl Ralf Handl
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: