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

Add QueryRestrictions to the Capabilities Vocabulary

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Vocabularies
    • Labels:
    • Proposal:
      Hide

      Here is an initial version which we can add too/adjust:

      <Term Name="QueryRestrictions" Type="Capabilities.QueryRestrictionsType" AppliesTo="EntitySet">

          <Annotation Term="Core.Description" String="Restrictions on queries" />

      </Term>

      <ComplexType Name="QueryRestrictionsType">

          <Property Name="DirectlyAccessible" Type="Edm.Boolean" Nullable="false" DefaultValue="true">

              <Annotation Term="Core.Description" String="Whether entities in this entity set can be accessed directly or must be accessed through a navigation property." />

          </Property>

      </ComplexType>

      Show
      Here is an initial version which we can add too/adjust: <Term Name="QueryRestrictions" Type="Capabilities.QueryRestrictionsType" AppliesTo="EntitySet">     <Annotation Term="Core.Description" String="Restrictions on queries" /> </Term> <ComplexType Name="QueryRestrictionsType">     <Property Name="DirectlyAccessible" Type="Edm.Boolean" Nullable="false" DefaultValue="true">         <Annotation Term="Core.Description" String="Whether entities in this entity set can be accessed directly or must be accessed through a navigation property." />     </Property> </ComplexType>
    • Resolution:
      Hide

      As per 2019-1-17 meeting, closing with no action. Desired behavior for this scenario can be achieved more intuitively by not exposing an entity set (and not defining navigation property bindings).

      Separately, we have past and concurent discussions around ReadRestrictions, RetrieveRestrictions, and QueryRestrictions. We will almost definitely need some way to expose restrictions on reading.  We will address that requirement in a separate issue, based on those scenarios.

      Show
      As per 2019-1-17 meeting, closing with no action. Desired behavior for this scenario can be achieved more intuitively by not exposing an entity set (and not defining navigation property bindings). Separately, we have past and concurent discussions around ReadRestrictions, RetrieveRestrictions, and QueryRestrictions. We will almost definitely need some way to expose restrictions on reading.  We will address that requirement in a separate issue, based on those scenarios.

      Description

      We have cases where we want to have an entity set which is only accessible by navigation from another entity but it is not a containment relationship.  We currently have InsertRestrictions and UpdateRestrictions in the capabilities vocabulary but no corresponding QueryRestrictions.  We should add QueryRestrictions to the capabilities vocabulary.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              matt.borges Matthew Borges
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: