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

Consider defining structure of bound actions/functions

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: No Action
    • Affects Version/s: None
    • Fix Version/s: V4.0_CSD02
    • Component/s: CSDL JSON
    • Labels:
      None
    • Proposal:
      Hide

      1) Define the structure of a function or action advertisement
      2) Define an bindableStructuredType that includes property patterns for:functions/actions (that uses the structure above)
      3) Define an annotatableStructuredType that includes property patterns for annotations

      Show
      1) Define the structure of a function or action advertisement 2) Define an bindableStructuredType that includes property patterns for:functions/actions (that uses the structure above) 3) Define an annotatableStructuredType that includes property patterns for annotations

      Description

      Bound functions and actions appear in json payloads as properties that start with "#" and may contain target, url, etc. These are not advertised as properties in JSON Schema, because such bound actions/functions can be "externally defined". This is okay because we specify additonalproperties=true, but we lack validation that the contents of a bound function or action is valid. Also, we prevent a service that knows it will never return additional properties from publishing that fact.

      We could use patternproperties to enforce that the value of a property that starts with "#" is a valid payload for a function or action.

      There is concern that adding this pattern property everywhere a bound function/action could appear might be heavy weight.

      I would like to at least define the shape for an action/function, so that services that want to advertise actions/functions (either through pattern properties or by explicitly advertising actions/functions) can do so.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mikep Michael Pizzo
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: