[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] (ODATA-978) New annotation for availability/advertisement of bound actions/functions
[ https://issues.oasis-open.org/browse/ODATA-978?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Ralf Handl updated ODATA-978: ----------------------------- Description: Actions and functions that are not available on all instances can be advertised in responses, see http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752309. Problem with current approach: does absence of an advertisement mean that an action/function is not available, or does it mean that the service doesn't advertise its availability? was: Actions and functions that are not available on all instances can be advertised in responses, see http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752309. What's missing is an indicator in $metadata which actions/functions will fall into this category because absence of action/function advertisement in a response payload is ambiguous, clients can't decide whether the service does not advertise a certain action/function at all, or whether the action/function is not applicable on the received instances. Proposal: Advertise non-availability by providing null as the advertisement value: "#Model.FirstAction": {} --> available "#Model.SecondAction": null --> not available was: New Core or Capabilities annotation on actions/functions: AvailableOnAllInstances: <Term Name="AvailableOnAllInstances" Type="Core.Tag" DefaultValue="true" AppliesTo="Action Function"> <Annotation Term="Core.Description" String="Bound action/function is available on all instances of the binding parameter type" /> <Annotation Term="Core.LongDescription" String="If annotated with value of 'false', clients should check instance representations for action/function advertisements" /> </Term> Alternative proposal: <Term Name="AdvertisedOnInstances" Type="Core.Tag" DefaultValue="true" AppliesTo="Action Function"> <Annotation Term="Core.Description" String="Instance representations of the binding parameter type will contain advertisement if action/function is available on that instance" /> </Term> > New annotation for availability/advertisement of bound actions/functions > ------------------------------------------------------------------------ > > Key: ODATA-978 > URL: https://issues.oasis-open.org/browse/ODATA-978 > Project: OASIS Open Data Protocol (OData) TC > Issue Type: Bug > Components: Vocabularies > Affects Versions: V4.0_ERRATA03 > Reporter: Ralf Handl > Fix For: V4.01_WD01 > > > Actions and functions that are not available on all instances can be advertised in responses, see http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752309. > Problem with current approach: does absence of an advertisement mean that an action/function is not available, or does it mean that the service doesn't advertise its availability? -- This message was sent by Atlassian JIRA (v6.2.2#6258)
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]