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

Visualize high level EDM overview through means of small diagrams to aid the reader on understanding base terms

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: Protocol
    • Labels:
      None
    • Environment:

      [Closed]

      Description

      This is based on my review of the latest revision [OData Core Part 1: Protocol, Version 4.0](https://www.oasis-open.org/committees/download.php/48762/odata-core-v4.0-wd01-part1-protocol-current-2013-4-5MP.docx).
      The section on entity data model must be hard to read, as it tries to describe a survival guide for a generic model, where it comes to the nitty-gritty.
      That's ok. I am fine with that. First we really need the nitty-gritty details and second we are not writing children books.
      But maybe we can do better.

      A) One problem for the astute reader seems to lie in the details of adjectives/attributes to the main terms.
      B) Another are related terms we introduce.
      C) Third the topological complexity, that cries for a parallel depict through a picture or some pictures.

      To A)
      Differentiating between an Entity and a Named Entity is one example

      To B)
      The wrapper in specific where to segragate from the Entity Container ...

      To C)
      I may volunteer to paint some maybe during the prep phase of the face to face in Walldorf as to receive early feedback and converge fast.
      Assume one for entity -> entities
      Another for relationships external and derived
      Yet another for containers and their objects (entities, actions, functions) showing also wrappers maybe as top-level hull for other "things"?

        Attachments

          Activity

          sdrees Stefan Drees (Inactive) created issue -
          Hide
          sdrees Stefan Drees (Inactive) added a comment -

          Typos, typos ... a preview function might cut down mail traffic by half

          Show
          sdrees Stefan Drees (Inactive) added a comment - Typos, typos ... a preview function might cut down mail traffic by half
          sdrees Stefan Drees (Inactive) made changes -
          Field Original Value New Value
          Description This is based on my review of the latest revision [OData Core Part 1: Protocol, Version 4.0](https://www.oasis-open.org/committees/download.php/48762/odata-core-v4.0-wd01-part1-protocol-current-2013-4-5MP.docx).
          The section on entity data model must be hard to read, as it tries to describe a survival guide for a generic model, where it comes to the nitty-gritty.
          That's ok. I am fine with that. First we really need the nitty-gritty details and second we are not writing children books.
          But maybe we can do better.

          A) One problem for the astute reader seems to lie in the details of adjectives/attributes to the main terms.
          B) Another are related terms we introduce.
          C) Third the topological complexity, that cries for a parallel depict through a picture or some pictures.

          To A)
          Differentiating between an Entity and a Named Entity is one example

          To B)
          The wrapper in specific where to segragate from the Entity Container ...

          To C)
          I may volunteer to paint some :-) maybe during the prep phase of the face to face in Walldorf as to receive early feedback and converge fast.
          Assume one for entity -> entities
          Another for relationships external and derived
          Yet another for containers and their objects (entities, actions, functions) showing also wrappers may as top-level hull for other "things"?
          This is based on my review of the latest revision [OData Core Part 1: Protocol, Version 4.0](https://www.oasis-open.org/committees/download.php/48762/odata-core-v4.0-wd01-part1-protocol-current-2013-4-5MP.docx).
          The section on entity data model must be hard to read, as it tries to describe a survival guide for a generic model, where it comes to the nitty-gritty.
          That's ok. I am fine with that. First we really need the nitty-gritty details and second we are not writing children books.
          But maybe we can do better.

          A) One problem for the astute reader seems to lie in the details of adjectives/attributes to the main terms.
          B) Another are related terms we introduce.
          C) Third the topological complexity, that cries for a parallel depict through a picture or some pictures.

          To A)
          Differentiating between an Entity and a Named Entity is one example

          To B)
          The wrapper in specific where to segragate from the Entity Container ...

          To C)
          I may volunteer to paint some :-) maybe during the prep phase of the face to face in Walldorf as to receive early feedback and converge fast.
          Assume one for entity -> entities
          Another for relationships external and derived
          Yet another for containers and their objects (entities, actions, functions) showing also wrappers maybe as top-level hull for other "things"?
          Hide
          ralfhandl Ralf Handl added a comment -

          To C: wouldn't the ER diagram of the Metadata Service (ODATA-126) be that picture?

          Show
          ralfhandl Ralf Handl added a comment - To C: wouldn't the ER diagram of the Metadata Service ( ODATA-126 ) be that picture?
          ralfhandl Ralf Handl made changes -
          Proposal Visualize high level EDM overview through means of small diagrams to aid the reader on understanding base terms Close without further action as the Metadata Service chapter contains small diagrams that explain the relationship of CSDL elements.
          Environment [Proposed]
          Hide
          sdrees Stefan Drees (Inactive) added a comment - - edited

          inserted a now in above proposal to make clear, that this change has been introduced after the creation of tis issue and thus the issue has already been resolved (by providing adequate info in a different place).

          If we already did resolve the sub issues A and B I am in favor of closing the issue as proposed, but would kindly suggest that we document this (point to a different issue probably one reported by Patrick relevant to the edm "intro" where the resolution took place.

          If A and B have not been resolved, ... I might also be willing to second closure, as Mike once stated, that this short edm term "listing" was never meant to replace the explanations in the CSDL etc. This should only be clear to everyone when we close this issue.

          Show
          sdrees Stefan Drees (Inactive) added a comment - - edited inserted a now in above proposal to make clear, that this change has been introduced after the creation of tis issue and thus the issue has already been resolved (by providing adequate info in a different place). If we already did resolve the sub issues A and B I am in favor of closing the issue as proposed, but would kindly suggest that we document this (point to a different issue probably one reported by Patrick relevant to the edm "intro" where the resolution took place. If A and B have not been resolved, ... I might also be willing to second closure, as Mike once stated, that this short edm term "listing" was never meant to replace the explanations in the CSDL etc. This should only be clear to everyone when we close this issue.
          sdrees Stefan Drees (Inactive) made changes -
          Proposal Close without further action as the Metadata Service chapter contains small diagrams that explain the relationship of CSDL elements. Close without further action as the Metadata Service chapter now contains small diagrams that explain the relationship of CSDL elements.
          ralfhandl Ralf Handl made changes -
          Resolution Accepted in F2F 2013-06-13
          Status New [ 10000 ] Open [ 1 ]
          ralfhandl Ralf Handl made changes -
          Status Open [ 1 ] Closed [ 6 ]
          ralfhandl Ralf Handl made changes -
          Environment [Proposed] [Closed]
          Status Closed [ 6 ] Open [ 1 ]
          ralfhandl Ralf Handl made changes -
          Resolution Fixed [ 1 ]
          Status Open [ 1 ] Resolved [ 5 ]
          ralfhandl Ralf Handl made changes -
          Status Resolved [ 5 ] Applied [ 10002 ]
          ralfhandl Ralf Handl made changes -
          Status Applied [ 10002 ] Closed [ 6 ]
          sdrees Stefan Drees (Inactive) made changes -
          Resolution Accepted in F2F 2013-06-13 Accepted in F2F 2013-06-13

          Accepted: https://www.oasis-open.org/committees/download.php/49557/odata-meeting-41_on-20130613_14-F2F-minutes.html#odata-333

          Hide
          sdrees Stefan Drees (Inactive) added a comment -

          Reference to meeting #41 minute link fragment documenting the approval of application has been added.

          Show
          sdrees Stefan Drees (Inactive) added a comment - Reference to meeting #41 minute link fragment documenting the approval of application has been added.

            People

            • Assignee:
              Unassigned
              Reporter:
              sdrees Stefan Drees (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: