amending bundle tool to add inherited schema titles to parent (and as…

…cendant) schema discriminator; removing x-cg-discriminator as is not needed anymore (relates to #99)
openEHR · Nov 24, 2023 · b2ac046 · b2ac046
1 parent d2cdafc
commit b2ac046
Show file tree

Hide file tree

Showing 28 changed files with 28 additions and 190 deletions.
diff --git a/development/src/Writer/AbstractWriter.php b/development/src/Writer/AbstractWriter.php
@@ -136,6 +136,11 @@ public function writeJsonFile(): void {
      */
     public static function getSchemaRef(string $schemaTitle): string {
         $schemaName = ucfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', strtolower($schemaTitle)))));
+        $schemaName = match ($schemaName) {
+            'Entry' => 'AbstractEntry',
+            'Cluster' => 'Clstr',
+            default => $schemaName
+        };
         return '#/components/schemas/' . $schemaName;
     }
 

diff --git a/development/src/Writer/Codegen.php b/development/src/Writer/Codegen.php
@@ -17,7 +17,6 @@ class Codegen extends AbstractWriter {
      */
     protected function prepareInput(): void {
         echo "prepareInput() ...";
-        $this->input = str_replace(["x-cg-discriminator"], ["discriminator"], $this->input);
         $this->input = preg_replace('#\\/schemas\\/U((?:Dv|Party|Version|Object|Uid|Content|Item|DataValue)[a-zA-Z]*)#', '\\/schemas\\/$1', $this->input);
         $this->input = preg_replace('#\\/schemas\\/UM(DvDateTime)#', '\\/schemas\\/$1', $this->input);
     }
@@ -34,6 +33,10 @@ protected function cleaning(Schema $schema): void {
                 }
             }
         }
+        $this->populateDiscriminator($schema->title, $schema);
+    }
+
+    protected function populateDiscriminator(string $mappingKey, Schema $schema): void {
         if ($schema->allOf) {
             /** @var Schema $parentSchema */
             $parentSchema = $schema->allOf[0]->resolve();
@@ -43,15 +46,30 @@ protected function cleaning(Schema $schema): void {
             if (!isset($parentSchema->discriminator)) {
                 $parentSchema->discriminator = new Discriminator(['propertyName' => '_type']);
             }
-            if (!isset($parentSchema->discriminator->mapping[$schema->title])) {
+            if (!isset($parentSchema->discriminator->mapping[$mappingKey])) {
                 $mapping = $parentSchema->discriminator->mapping ?? [];
-                $mapping[$schema->title] = static::getSchemaRef($schema->title);
-                echo "(added $schema->title mapping in $parentSchema->title) ";
+                $mapping[$mappingKey] = static::getSchemaRef($mappingKey);
+                ksort($mapping);
+                echo "(added $mappingKey mapping in $parentSchema->title) ";
                 $parentSchema->discriminator->mapping = $mapping;
             }
+            // add it also to all ancestors, not only to first parent
+            // this is needed to solve some issues with json-parsers and from() factories in generated code
+            $this->populateDiscriminator($mappingKey, $parentSchema);
         }
     }
 
+    /**
+     * AuditDetails
+     * PartyIdentified
+     * UpdateAudit
+     * DvUri
+     * DvText
+     * DvInterval
+     * **ObjectRef
+     **/
+
+
     /**
      * @return void
      */

diff --git a/development/src/Writer/Validation.php b/development/src/Writer/Validation.php
@@ -42,9 +42,6 @@ protected function cleaning(Schema $schema): void {
         if (isset($schema->{'x-cg-allOf'})) {
             unset($schema->{'x-cg-allOf'});
         }
-        if (isset($schema->{'x-cg-discriminator'})) {
-            unset($schema->{'x-cg-discriminator'});
-        }
     }
 
     /**

diff --git a/specifications/schemas/base_types/ObjectId.yaml b/specifications/schemas/base_types/ObjectId.yaml
@@ -7,12 +7,3 @@ properties:
     type: string
   value:
     type: string
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    ARCHETYPE_ID: '#/components/schemas/ArchetypeId'
-    TEMPLATE_ID: '#/components/schemas/TemplateId'
-    TERMINOLOGY_ID: '#/components/schemas/TerminologyId'
-    GENERIC_ID: '#/components/schemas/GenericId'
-    HIER_OBJECT_ID: '#/components/schemas/HierObjectId'
-    OBJECT_VERSION_ID: '#/components/schemas/ObjectVersionId'
diff --git a/specifications/schemas/base_types/UidBasedId.yaml b/specifications/schemas/base_types/UidBasedId.yaml
@@ -7,8 +7,3 @@ properties:
     type: string
     default: UID_BASED_ID
 x-discriminator-value: UID_BASED_ID
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    HIER_OBJECT_ID: '#/components/schemas/HierObjectId'
-    OBJECT_VERSION_ID: '#/components/schemas/ObjectVersionId'
diff --git a/specifications/schemas/common/AuditDetails.yaml b/specifications/schemas/common/AuditDetails.yaml
@@ -21,11 +21,6 @@ properties:
   committer:
     $ref: ../common/UPartyProxy.yaml
 x-discriminator-value: AUDIT_DETAILS
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    AUDIT_DETAILS: '#/components/schemas/AuditDetails'
-    ATTESTATION: '#/components/schemas/Attestation'
 example:
   system_id: 9624982A-9F42-41A5-9318-AE13D5F5031F
   committer:

diff --git a/specifications/schemas/common/Locatable.yaml b/specifications/schemas/common/Locatable.yaml
@@ -22,9 +22,3 @@ properties:
     $ref: ../common/Archetyped.yaml
   feeder_audit:
     $ref: ../common/FeederAudit.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    COMPOSITION: '#/components/schemas/Composition'
-    EHR_STATUS: '#/components/schemas/EhrStatus'
-    FOLDER: '#/components/schemas/Folder'
diff --git a/specifications/schemas/common/PartyIdentified.yaml b/specifications/schemas/common/PartyIdentified.yaml
@@ -13,11 +13,6 @@ properties:
     items:
       $ref: ../data_types/DvIdentifier.yaml
 x-discriminator-value: PARTY_IDENTIFIED
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    PARTY_IDENTIFIED: '#/components/schemas/PartyIdentified'
-    PARTY_RELATED: '#/components/schemas/PartyRelated'
 example:
   _type: PARTY_IDENTIFIED
   external_ref:

diff --git a/specifications/schemas/common/PartyProxy.yaml b/specifications/schemas/common/PartyProxy.yaml
@@ -8,8 +8,3 @@ properties:
     default: PARTY_PROXY
   external_ref:
     $ref: ../base_types/PartyRef.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    PARTY_SELF: '#/components/schemas/PartySelf'
-    PARTY_IDENTIFIED: '#/components/schemas/PartyIdentified'
diff --git a/specifications/schemas/common/Pathable.yaml b/specifications/schemas/common/Pathable.yaml
@@ -3,5 +3,3 @@ type: object
 properties:
   _type:
     type: string
-x-cg-discriminator:
-  propertyName: _type
diff --git a/specifications/schemas/common/UpdateAudit.yaml b/specifications/schemas/common/UpdateAudit.yaml
@@ -15,11 +15,6 @@ properties:
   committer:
     $ref: ../common/UPartyProxy.yaml
 x-discriminator-value: UPDATE_AUDIT
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    UPDATE_AUDIT: '#/components/schemas/UpdateAudit'
-    UPDATE_ATTESTATION: '#/components/schemas/UpdateAttestation'
 example:
   change_type:
     value: creation

diff --git a/specifications/schemas/common/Version.yaml b/specifications/schemas/common/Version.yaml
@@ -16,8 +16,3 @@ properties:
     $ref: ../common/AuditDetails.yaml
   data:
     $ref: ../common/UVersionable.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    ORIGINAL_VERSION: '#/components/schemas/OriginalVersion'
-    IMPORTED_VERSION: '#/components/schemas/ImportedVersion'
diff --git a/specifications/schemas/common/Versionable.yaml b/specifications/schemas/common/Versionable.yaml
@@ -3,8 +3,3 @@ description: A Versionable resource
 type: object
 allOf:
   - $ref: ../common/Locatable.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    COMPOSITION: '#/components/schemas/Composition'
-    EHR_STATUS: '#/components/schemas/EhrStatus'
diff --git a/specifications/schemas/common/VersionedObject.yaml b/specifications/schemas/common/VersionedObject.yaml
@@ -13,8 +13,3 @@ properties:
     $ref: ../base_types/ObjectRef.yaml
   time_created:
     $ref: ../data_types/DvDateTime.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    VERSIONED_COMPOSITION: '#/components/schemas/VersionedComposition'
-    VERSIONED_EHR_STATUS: '#/components/schemas/VersionedEhrStatus'
diff --git a/specifications/schemas/data_structures/Item.yaml b/specifications/schemas/data_structures/Item.yaml
@@ -6,8 +6,4 @@ properties:
   _type:
     type: string
 x-discriminator-value: ITEM
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    ELEMENT: '#/components/schemas/Element'
-    CLUSTER: '#/components/schemas/Clstr'
+
diff --git a/specifications/schemas/data_structures/ItemStructure.yaml b/specifications/schemas/data_structures/ItemStructure.yaml
@@ -6,10 +6,3 @@ properties:
   _type:
     type: string
 x-discriminator-value: ITEM_STRUCTURE
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    ITEM_SINGLE: '#/components/schemas/ItemSingle'
-    ITEM_LIST: '#/components/schemas/ItemList'
-    ITEM_TABLE: '#/components/schemas/ItemTable'
-    ITEM_TREE: '#/components/schemas/ItemTree'
diff --git a/specifications/schemas/data_types/DataValue.yaml b/specifications/schemas/data_types/DataValue.yaml
@@ -3,31 +3,3 @@ type: object
 properties:
   _type:
     type: string
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_AMOUNT: '#/components/schemas/DvAmount'
-    DV_BOOLEAN: '#/components/schemas/DvBoolean'
-    DV_CODED_TEXT: '#/components/schemas/DvCodedText'
-    DV_COUNT: '#/components/schemas/DvCount'
-    DV_DATE: '#/components/schemas/DvDate'
-    DV_DATE_TIME: '#/components/schemas/DvDateTime'
-    DV_DURATION: '#/components/schemas/DvDuration'
-    DV_EHR_URI: '#/components/schemas/DvEhrUri'
-    DV_ENCAPSULATED: '#/components/schemas/DvEncapsulated'
-    DV_IDENTIFIER: '#/components/schemas/DvIdentifier'
-    DV_INTERVAL: '#/components/schemas/DvInterval'
-    DV_INTERVAL_of_DATE_TIME: '#/components/schemas/DvIntervalOfDateTime'
-    DV_MULTIMEDIA: '#/components/schemas/DvMultimedia'
-    DV_ORDERED: '#/components/schemas/DvOrdered'
-    DV_ORDINAL: '#/components/schemas/DvOrdinal'
-    DV_PARSABLE: '#/components/schemas/DvParsable'
-    DV_PROPORTION: '#/components/schemas/DvProportion'
-    DV_QUANTIFIED: '#/components/schemas/DvQuantified'
-    DV_QUANTITY: '#/components/schemas/DvQuantity'
-    DV_SCALE: '#/components/schemas/DvScale'
-    DV_STATE: '#/components/schemas/DvState'
-    DV_TEMPORAL: '#/components/schemas/DvTemporal'
-    DV_TEXT: '#/components/schemas/DvText'
-    DV_TIME: '#/components/schemas/DvTime'
-    DV_URI: '#/components/schemas/DvUri'
diff --git a/specifications/schemas/data_types/DvAmount.yaml b/specifications/schemas/data_types/DvAmount.yaml
@@ -11,10 +11,3 @@ properties:
   accuracy:
     type: number
 x-discriminator-value: DV_AMOUNT
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_COUNT: '#/components/schemas/DvCount'
-    DV_DURATION: '#/components/schemas/DvDuration'
-    DV_PROPORTION: '#/components/schemas/DvProportion'
-    DV_QUANTITY: '#/components/schemas/DvQuantity'
diff --git a/specifications/schemas/data_types/DvEncapsulated.yaml b/specifications/schemas/data_types/DvEncapsulated.yaml
@@ -12,8 +12,3 @@ properties:
     $ref: ../data_types/CodePhrase.yaml
   language:
     $ref: ../data_types/CodePhrase.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_MULTIMEDIA: '#/components/schemas/DvMultimedia'
-    DV_PARSABLE: '#/components/schemas/DvParsable'
diff --git a/specifications/schemas/data_types/DvInterval.yaml b/specifications/schemas/data_types/DvInterval.yaml
@@ -20,8 +20,3 @@ properties:
   upper_included:
     type: boolean
 x-discriminator-value: DV_INTERVAL
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_INTERVAL: '#/components/schemas/DvInterval'
-    DV_INTERVAL_of_DATE_TIME: '#/components/schemas/DvIntervalOfDateTime'
diff --git a/specifications/schemas/data_types/DvOrdered.yaml b/specifications/schemas/data_types/DvOrdered.yaml
@@ -15,18 +15,3 @@ properties:
     items:
       $ref: ../data_types/ReferenceRange.yaml
 x-discriminator-value: DV_ORDERED
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_AMOUNT: '#/components/schemas/DvAmount'
-    DV_COUNT: '#/components/schemas/DvCount'
-    DV_DATE: '#/components/schemas/DvDate'
-    DV_DATE_TIME: '#/components/schemas/DvDateTime'
-    DV_DURATION: '#/components/schemas/DvDuration'
-    DV_ORDINAL: '#/components/schemas/DvOrdinal'
-    DV_PROPORTION: '#/components/schemas/DvProportion'
-    DV_QUANTIFIED: '#/components/schemas/DvQuantified'
-    DV_QUANTITY: '#/components/schemas/DvQuantity'
-    DV_SCALE: '#/components/schemas/DvScale'
-    DV_TEMPORAL: '#/components/schemas/DvTemporal'
-    DV_TIME: '#/components/schemas/DvTime'
diff --git a/specifications/schemas/data_types/DvQuantified.yaml b/specifications/schemas/data_types/DvQuantified.yaml
@@ -10,15 +10,3 @@ properties:
     type: string
     default: '='
 x-discriminator-value: DV_QUANTIFIED
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_AMOUNT: '#/components/schemas/DvAmount'
-    DV_COUNT: '#/components/schemas/DvCount'
-    DV_DATE: '#/components/schemas/DvDate'
-    DV_DATE_TIME: '#/components/schemas/DvDateTime'
-    DV_DURATION: '#/components/schemas/DvDuration'
-    DV_PROPORTION: '#/components/schemas/DvProportion'
-    DV_QUANTITY: '#/components/schemas/DvQuantity'
-    DV_TEMPORAL: '#/components/schemas/DvTemporal'
-    DV_TIME: '#/components/schemas/DvTime'
diff --git a/specifications/schemas/data_types/DvTemporal.yaml b/specifications/schemas/data_types/DvTemporal.yaml
@@ -9,9 +9,3 @@ properties:
   accuracy:
     $ref: ../data_types/DvDuration.yaml
 x-discriminator-value: DV_TEMPORAL
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_DATE: '#/components/schemas/DvDate'
-    DV_DATE_TIME: '#/components/schemas/DvDateTime'
-    DV_TIME: '#/components/schemas/DvTime'
diff --git a/specifications/schemas/data_types/DvText.yaml b/specifications/schemas/data_types/DvText.yaml
@@ -23,8 +23,3 @@ properties:
   encoding:
     $ref: ../data_types/CodePhrase.yaml
 x-discriminator-value: DV_TEXT
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_TEXT: '#/components/schemas/DvText'
-    DV_CODED_TEXT: '#/components/schemas/DvCodedText'
diff --git a/specifications/schemas/data_types/DvUri.yaml b/specifications/schemas/data_types/DvUri.yaml
@@ -11,8 +11,3 @@ properties:
   value:
     type: string
 x-discriminator-value: DV_URI
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    DV_URI: '#/components/schemas/DvUri'
-    DV_EHR_URI: '#/components/schemas/DvEhrUri'
diff --git a/specifications/schemas/ehr/AbstractEntry.yaml b/specifications/schemas/ehr/AbstractEntry.yaml
@@ -21,12 +21,3 @@ properties:
     $ref: ../common/UPartyProxy.yaml
   provider:
     $ref: ../common/UPartyProxy.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    ADMIN_ENTRY: '#/components/schemas/AdminEntry'
-    CARE_ENTRY: '#/components/schemas/CareEntry'
-    OBSERVATION: '#/components/schemas/Observation'
-    EVALUATION: '#/components/schemas/Evaluation'
-    INSTRUCTION: '#/components/schemas/Instruction'
-    ACTION: '#/components/schemas/Action'
diff --git a/specifications/schemas/ehr/CareEntry.yaml b/specifications/schemas/ehr/CareEntry.yaml
@@ -7,10 +7,3 @@ properties:
     $ref: ../data_structures/UItemStructure.yaml
   guideline_id:
     $ref: ../base_types/ObjectRef.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    OBSERVATION: '#/components/schemas/Observation'
-    EVALUATION: '#/components/schemas/Evaluation'
-    INSTRUCTION: '#/components/schemas/Instruction'
-    ACTION: '#/components/schemas/Action'
diff --git a/specifications/schemas/ehr/ContentItem.yaml b/specifications/schemas/ehr/ContentItem.yaml
@@ -2,13 +2,3 @@ title: CONTENT_ITEM
 type: object
 allOf:
   - $ref: ../common/Locatable.yaml
-x-cg-discriminator:
-  propertyName: _type
-  mapping:
-    ENTRY: '#/components/schemas/AbstractEntry'
-    ADMIN_ENTRY: '#/components/schemas/AdminEntry'
-    CARE_ENTRY: '#/components/schemas/CareEntry'
-    OBSERVATION: '#/components/schemas/Observation'
-    EVALUATION: '#/components/schemas/Evaluation'
-    INSTRUCTION: '#/components/schemas/Instruction'
-    ACTION: '#/components/schemas/Action'