Prepare clients to deal with type annotations without the leading "#"

XMLWordPrintable

    • Type: Sub-task
    • Resolution: Duplicate
    • Priority: Major
    • V4.0_ERRATA01
    • Affects Version/s: V4.0_OS
    • Component/s: ATOM Format, JSON Format
    • None
    • Environment:

      [Proposed]

    • Hide

      In 4.5.3, Annotation odata.type, of the OData JSON format document, change the existing line:
      "For built-in primitive types the value is the unqualified name of the primitive type, specified as a URI fragment."
      to:
      "For built-in primitive types the value is the unqualified name of the primitive type. In OData 4.0 this is specified as a URI fragment, but clients should be aware that future versions of OData are expected to make the leading "#" optional."

      Show
      In 4.5.3, Annotation odata.type, of the OData JSON format document, change the existing line: "For built-in primitive types the value is the unqualified name of the primitive type, specified as a URI fragment." to: "For built-in primitive types the value is the unqualified name of the primitive type. In OData 4.0 this is specified as a URI fragment, but clients should be aware that future versions of OData are expected to make the leading "#" optional."

      ODATA-561 calls out the fact that the leading "#" is not really required (and doesn't really make sense) for primitive types (because they are not really a fragment located within the metadata document) and suggests (for backward compatibility) allowing, but not requiring, services to omit the "#" for primitive types.

      We should make clients aware that this change is expected, so that they can write their code appropriately.

      Ideally we would say: "Services should not include a leading # for primitive types but clients should be prepared to handle primitive types with or without a leading"

            Assignee:
            Unassigned
            Reporter:
            Michael Pizzo (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: