transport icon indicating copy to clipboard operation
transport copied to clipboard

[RCP-36] Data Dictionary 2.2

Open darnjo opened this issue 8 months ago • 0 comments

1. Support for OData Complex Types

  • Adds custom data type support, which is called a "Shape" in the updated DD specifications.
  • Two new standard shapes added in DD 2.1: I18nString for internationalization, and DisplayRule for single feeds.

2. Metadata Resource Validation (RCP-42, RCP-44, RCP-47)

  • DD 2.1 contains four metadata resources: Model, Field, Lookup, and RelatedLookup.
    • These items will be tested, when present, to ensure that the Model and Field Resource definitions match those in the XML Metadata and that their attributes, such as precision, length, and scale match what's in the Field Resource.
  • There is also a new ComplexType called I18nString which allows for a DisplayNames collection to be available in the Model, Field, and Lookup resources.
  • RelatedLookup adds the ability to link enumerations together so they can be filtered. For example, cities in states or provinces, or states or provinces in a country. The relationships are bidirectional and any kind of values can be related, not just geographic ones.

3. Testing Rules for Add/Edit with Media (RCP-48)

  • New fields have been added for Add/Edit with Media. Providers will be able to adopt these fields with 2.1, and may do so now as they're not non-breaking changes.
  • This feature requires a separate endorsement in addition to the underlying fields being available. Please contact RESO if you have an implementation to verify.

4. Testing Rules for Single Feeds (RCP-35)

  • RCP-35 adds the ability to convey multiple feeds at once in a single feed. These could be IDX or VOW feeds, or others. FeedType has been added as open with enumerations, containing IDX, BBO, PDAP, and VOW. Providers may extend these values.
  • There is no formal testing for Single Feeds in DD 2.1 beyond schema validation. If this functionality is used, any required fields MUST be present and populated with data. If the DisplayRules field is used, its schema MUST match the DisplayRule schema.

5. Previously-Excluded Schema Validation Items

  • Some items were previously excluded from schema validation with the goal of enforcing them in the next version (2.1). Is this still the plan?
  • See RESO SDK.
  • Currently, these generate warnings.
    • Most are related to schools. There are potential enumerations for them. This will work in the U.S., so the enumeration could be closed in that case, with other countries TBD.
    • ImageSizeDescription is currently an enumeration in the Data Dictionary. Should this be a string instead since it's a description?

darnjo avatar May 15 '25 21:05 darnjo