code review fixes

Author: ben-kalmus

specs/composition-full/common/params/Composition.yml

@@ -46,9 +46,17 @@ externalInjectedItem:
     objectID:
       type: string
     metadata:
-      $ref: '../schemas/components/CompositionBehavior.yml#/metadata'
+      $ref: '#/injectedItemMetadata'
   description: |
     An objectID injected into an external source.
   required:
     - objectID
   example: {'objectID': 'my-object-1', 'metadata': {'my-field': 'my-value'}}
+
+injectedItemMetadata:
+  type: object
+  additionalProperties: true
+  description: |
+    User defined key-values that will be added to injected item in the response.
+    This is identical to Hits metadata which is defined in Composition or Composition Rule, with the benefit of being set at runtime.
+  example: {'my-value': 'my-field'}

specs/composition-full/common/schemas/components/CompositionBehavior.yml

@@ -55,7 +55,7 @@ injectedItem:
       description: injected Item unique identifier.
     source:
       description: Search source to be used to inject items into result set.
-      $ref: '#/injectionSource'
+      $ref: '#/injectedItemSource'
     position:
       type: integer
       minimum: 0
@@ -65,32 +65,29 @@ injectedItem:
       minimum: 0
       maximum: 20
     metadata:
-      $ref: '#/metadata'
+      title: injectedItemMetadata
+      type: object
+      description: Used to add metadata to the results of the injectedItem.
+      properties:
+        hits:
+          title: injectedItemHitsMetadata
+          type: object
+          description: Adds the provided metadata to each injected hit via an `_extra` attribute.
+          properties:
+            addItemKey:
+              type: boolean
+              description: When true, the `_injectedItemKey` field is set in the `_extra` object of each affected hit.
+            extra:
+              type: object
+              additionalProperties: true
+              description: The user-defined key-value pairs that will be placed in the `_extra` field of each affected hit.
   required:
     - key
     - source
     - position
     - length
 
-injectionSource:
+injectedItemSource:
   oneOf:
     - $ref: './InjectionSource.yml#/search'
     - $ref: './InjectionSource.yml#/external'
-
-metadata:
-  title: injectedItemMetadata
-  type: object
-  description: Used to add metadata to the results of the injectedItem.
-  properties:
-    hits:
-      title: injectedItemHitsMetadata
-      type: object
-      description: Adds the provided metadata to each injected hit via an `_extra` attribute.
-      properties:
-        addItemKey:
-          type: boolean
-          description: When true, the `_injectedItemKey` field is set in the `_extra` object of each affected hit.
-        extra:
-          type: object
-          additionalProperties: true
-          description: The user-defined key-value pairs that will be placed in the `_extra` field of each affected hit.

specs/composition-full/common/schemas/components/InjectionSource.yml

@@ -3,35 +3,27 @@ search:
   description: Injected items will originate from a search request performed on the specified index.
   type: object
   additionalProperties: false
-  allOf:
-    - $ref: '#/baseSource'
-    - type: object
-      additionalProperties: false
+  properties:
+    index:
+      type: string
+      description: Composition Index name.
+      example: Products
+    params:
+      $ref: './Injection.yml#/injectedItemsQueryParameters'
+  required:
+    - index
 
 external:
   title: injectedItemExternalSource
   description: Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload.
   type: object
   additionalProperties: false
   allOf:
-    - $ref: '#/baseSource'
+    - $ref: '#/search'
   properties:
     ordering:
       $ref: '#/externalOrdering'
 
-baseSource:
-  type: object
-  additionalProperties: false
-  properties:
-    index:
-      type: string
-      description: Composition Index name.
-      example: Products
-    params:
-      $ref: './Injection.yml#/injectedItemsQueryParameters'
-  required:
-    - index
-
 externalOrdering:
-  enum: ['default', 'user-defined']
+  enum: ['default', 'userDefined']
   default: 'default'