Uploaded image for project: 'Ed-Fi ODS/API'
  1. Ed-Fi ODS/API
  2. ODS-785

Domain metadata extensions enhancements for schema handling

    XMLWordPrintable

    Details

    • Sprint:
      ODS/API v2.2 - Sprint 1

      Description

      Currently, the guidance for extending the ODS domain metadata requires that the "extension" schema be explicitly defined on each Entity, as follows:

      <?xml version="1.0" encoding="utf-8" ?>
      <AggregateExtensions>
        <Aggregate root="InstitutionControlType">
          <Entity table="InstitutionControlType" schema="extension" />
        </Aggregate>
        <Aggregate root="InstitutionLevelType">
          <Entity table="InstitutionLevelType" schema="extension" />
        </Aggregate>
        <Aggregate root="SpecialEducationGraduationStatusType">
          <Entity table="SpecialEducationGraduationStatusType" schema="extension" />
        </Aggregate>
        <Aggregate root="SubmissionCertificationType">
          <Entity table="SubmissionCertificationType" schema="extension" />
        </Aggregate>
        <Aggregate root="PostSecondaryOrganization">
          <Entity table="PostSecondaryOrganization" schema="extension" />
        </Aggregate>
      </AggregateExtensions>
      

      This is a rather tedious approach. Support for the "schema" attribute should be added to the AggregateExtensions root element, but the processing should default the value to "extension" if not provided. The individual Entity elements then should not require the "schema" attribute (defaulting to the one defined or defaulted for the AggregateExtensions root element), but one can still be provided to override the top-level setting if necessary.

      The net result of this behavior is that unless there is a need to specify schema anywhere, "extension" will be assumed during processing.

      The associated Pull Request implements this behavior, and was implemented as part of the TNTP work.

        Attachments

          Activity

            People

            Assignee:
            Unassigned
            Reporter:
            gmcelhanon Geoff McElhanon
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: