@salesforce/lds-adapters-cdp-semantic-authoring 1.302.0 → 1.304.0

package/src/raml/api.raml

@@ -1940,6 +1940,167 @@ types:
         properties:
           //:
             type: string
+  SemanticSubMetricCollectionOutputRepresentation:
+    description: Semantic Sub Metrics collection representation.
+    type: object
+    properties:
+      items:
+        description: The list of semantic SubMetrics.
+        type: array
+        required: false
+        items:
+          type: SemanticSubMetricOutputRepresentation
+  SemanticSubMetricsByMetricCollectionOutputRepresentation:
+    description: Collection of metric to sub metrics.
+    type: object
+    properties:
+      items:
+        description: The list of semantic metric to sub metrics.
+        type: array
+        required: false
+        items:
+          type: SemanticSubMetricsByMetricOutputRepresentation
+  SemanticSubMetricsByMetricOutputRepresentation:
+    description: contain metric data with it's sub metrics.
+    type: object
+    properties:
+      metricApiName:
+        description: The API name of the metric.
+        type: string | nil
+        required: false
+      subMetrics:
+        description: The sub metrics that depend on the metric
+        type: array
+        required: false
+        items:
+          type: SemanticSubMetricOutputRepresentation
+  SemanticSubMetricInputRepresentation:
+    description: Input representation for specifying a semantic sub-metric
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      label:
+        description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
+        type: string | nil
+      filterLogic:
+        description: The filter logic of the sub-metric.
+        type: string | nil
+      filters:
+        description: The filters of the sub-metric.
+        type: array
+        items:
+          type: object
+      semanticMetricDefinitionApiName:
+        description: The API name of the semantic metric definition.
+        type: string
+      timeRange:
+        description: The time range of the sub-metric.
+        type: object
+  SemanticSubMetricOutputRepresentation:
+    description: A semantic Sub Metric.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      baseModelApiName:
+        description: The baseModelApiName of the semantic entity.
+        type: string
+        required: false
+      createdBy:
+        description: The user who created the semantic entity.
+        type: string
+      createdDate:
+        description: The date in which the semantic entity was created.
+        type: string
+      description:
+        description: The Description of the semantic entity.
+        type: string | nil
+        required: false
+      id:
+        description: The object ID of the semantic entity.
+        type: string
+        required: false
+      label:
+        description: The display name of the semantic entity to be used in the ui.
+        type: string | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      filterLogic:
+        description: The filter logic of the Sub Metric.
+        type: string | nil
+        required: false
+      filters:
+        description: The filters of the Sub Metric.
+        type: array
+        required: false
+        items:
+          type: SemanticFilterOutputRepresentation
+      semanticMetricDefinitionApiName:
+        description: The API name of the semantic metric definition.
+        type: string | nil
+        required: false
+      timeRange:
+        description: The time range of the Sub Metric.
+        type: SemanticTimeRangeOutputRepresentation | nil
+        required: false
+  SemanticTimeRangeInputRepresentation:
+    description: Input representation for specifying a semantic time range
+    type: object
+    properties:
+      customerEndDate:
+        description: The end date of the customer-defined time range.
+        type: string
+      customerStartDate:
+        description: The start date of the customer-defined time range.
+        type: string
+      timeRangeType:
+        description: The type of the time range.
+        type: string
+        enum:
+          - Customer
+          - LastMonth
+          - LastWeek
+          - LastYear
+          - MonthToDate
+          - Yesterday
+  SemanticTimeRangeOutputRepresentation:
+    description: A semantic time range.
+    type: object
+    properties:
+      customerEndDate:
+        description: The end date of the customer-defined time range.
+        type: string | nil
+        required: false
+      customerStartDate:
+        description: The start date of the customer-defined time range.
+        type: string | nil
+        required: false
+      timeRangeType:
+        description: The type of the time range.
+        type: string | nil
+        required: false
+        enum:
+          - Customer
+          - LastMonth
+          - LastWeek
+          - LastYear
+          - MonthToDate
+          - Yesterday
 /ssot/semantic/models:
   get:
     displayName: getSemanticModelCollection
@@ -2212,37 +2373,86 @@ types:
       modelApiNameOrId:
         type: string
         required: true
-  /metrics:
+  /metric-api-names/{metricApiNames}/sub-metrics:
     get:
-      displayName: getSemanticMetricCollection
-      description: Retrieves a result of Semantic Metrics.
+      displayName: getSemanticSubMetricsByMetric
+      description: Retrieves a collection of metric to sub metrics
       responses:
         '200':
           description: Success
           body:
             application/json:
-              type: SemanticMetricCollectionOutputRepresentation
+              type: SemanticSubMetricsByMetricCollectionOutputRepresentation
     uriParameters:
+      metricApiNames:
+        type: string
+        required: true
       modelApiNameOrId:
         type: string
         required: true
-  /metrics/{metricNameOrId}:
+  /metrics:
     get:
-      displayName: getSemanticMetric
-      description: Retrieves a specific Semantic Metric.
+      displayName: getSemanticMetricCollection
+      description: Retrieves a result of Semantic Metrics.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticMetricCollectionOutputRepresentation
+    post:
+      displayName: postSemanticMetricCollection
+      description: Creates a new semantic metric
       responses:
         '200':
           description: Success
           body:
             application/json:
               type: SemanticMetricOutputRepresentation
+      body:
+        application/json:
+          type: SemanticMetricInputRepresentation
+          (oas-body-name): input
     uriParameters:
-      metricNameOrId:
-        type: string
-        required: true
       modelApiNameOrId:
         type: string
         required: true
+    /{metricNameOrId}:
+      delete:
+        displayName: deleteSemanticMetric
+        description: Deletes a specific Semantic Metric.
+        responses:
+          '200':
+            description: Success
+      get:
+        displayName: getSemanticMetric
+        description: Retrieves a specific Semantic Metric.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticMetricOutputRepresentation
+      put:
+        displayName: putSemanticMetric
+        description: Updates a specific Semantic Metric.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticMetricOutputRepresentation
+        body:
+          application/json:
+            type: SemanticMetricInputRepresentation
+            (oas-body-name): inputName
+      uriParameters:
+        metricNameOrId:
+          type: string
+          required: true
+        modelApiNameOrId:
+          type: string
+          required: true
   /parameters:
     get:
       displayName: getSemanticParameterCollection
@@ -2305,3 +2515,63 @@ types:
         relationshipNameOrId:
           type: string
           required: true
+  /sub-metrics:
+    get:
+      displayName: getSemanticSubMetricCollection
+      description: Retrieves a result of Semantic Sub Metrics.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticSubMetricCollectionOutputRepresentation
+    post:
+      displayName: postSemanticSubMetricCollection
+      description: Creates a new semantic sub metric
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticSubMetricOutputRepresentation
+      body:
+        application/json:
+          type: SemanticSubMetricInputRepresentation
+          (oas-body-name): input
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+    /{subMetricNameOrId}:
+      delete:
+        displayName: deleteSemanticSubMetric
+        description: Deletes a specific Semantic Sub Metric.
+        responses:
+          '200':
+            description: Success
+      get:
+        displayName: getSemanticSubMetric
+        description: Retrieves a specific Semantic Sub Metric.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticSubMetricOutputRepresentation
+      put:
+        displayName: putSemanticSubMetric
+        description: Updates a specific Semantic Sub Metric.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticSubMetricOutputRepresentation
+        body:
+          application/json:
+            type: SemanticSubMetricInputRepresentation
+            (oas-body-name): inputName
+      uriParameters:
+        modelApiNameOrId:
+          type: string
+        subMetricNameOrId:
+          type: string

package/src/raml/luvio.raml

@@ -14,6 +14,9 @@ types:
   SemanticMetricOutputRepresentation:
     (luvio.key):
       name: id
+  SemanticSubMetricOutputRepresentation:
+    (luvio.key):
+      name: apiName
 
 /ssot/semantic/models:
   get:
@@ -32,9 +35,23 @@ types:
     get:
       (luvio.adapter):
         name: getSemanticMetrics
+  /metric-api-names/{metricApiNames}/sub-metrics:
+    get:
+      (luvio.adapter):
+        name: getSemanticMetricsToSubMetrics
   /metrics/{metricNameOrId}:
     get:
       (luvio.key):
         name: urlParams.metricNameOrId
       (luvio.adapter):
         name: getSemanticMetric
+  /sub-metrics:
+    get:
+      (luvio.adapter):
+        name: getSemanticSubMetrics
+  /sub-metrics/{subMetricNameOrId}:
+    get:
+      (luvio.key):
+        name: urlParams.subMetricNameOrId
+      (luvio.adapter):
+        name: getSemanticSubMetric