@salesforce/lds-adapters-cdp-semantic-authoring 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,161 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'SemanticAuthoring'
+(luvio.ttl): 30000 # 30 seconds in Miliseconds
+
+types:
+  SemanticModelOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticDataObjectOutputRepresentation:
+    (luvio.key):
+      name: id
+    (luvio.opaque): true
+  SemanticRelationshipOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticLogicalViewOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticCalculatedMeasurementOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticCalculatedDimensionOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticParameterOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticMetricOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticSubMetricOutputRepresentation:
+    (luvio.opaque): true # Needs to be opaque due to cyclic types
+    (luvio.key):
+      name: id
+  SemanticDimensionOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticMeasurementOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticMappedFieldOutputRepresentation:
+    (luvio.opaque): true # Needs to be opaque due to cyclic types
+    (luvio.key):
+      name: id
+  SemanticUnionOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticGroupingOutputRepresentation:
+    (luvio.key):
+      name: id
+  SemanticGoalOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      subMetricNameOrId: subMetricDefinitionApiName
+      startDate: dateRange.startDate
+      endDate: dateRange.endDate
+  SemanticDependencyOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+  SemanticDependencyCollectionOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+
+/ssot/semantic/models:
+  get:
+    (luvio.adapter):
+      name: getSemanticModels # This should correspond  to the methodName in the signature var of @ConnectResourceMethod
+  post:
+    (luvio.adapter):
+      name: createSemanticModel
+
+/ssot/semantic/metrics/{metricIds}:
+  get:
+    (luvio.adapter):
+      name: getSemanticMetricsByIds
+
+/ssot/semantic/sub-metrics/{subMetricIds}:
+  get:
+    (luvio.adapter):
+      name: getSemanticSubMetricsById
+
+/ssot/semantic/models/{modelApiNameOrId}:
+  get:
+    (luvio.adapter):
+      name: getSemanticModel
+    (luvio.key):
+      name: urlParams.modelApiNameOrId
+  patch:
+    (luvio.adapter):
+      name: patchSemanticModel
+  /metrics:
+    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
+    post:
+      (luvio.adapter):
+        name: createSemanticSubMetric
+  /sub-metrics/{subMetricNameOrId}:
+    get:
+      (luvio.key):
+        name: urlParams.subMetricNameOrId
+      (luvio.adapter):
+        name: getSemanticSubMetric
+    delete:
+      (luvio.key):
+        name: urlParams.subMetricNameOrId
+      (luvio.adapter):
+        name: deleteSemanticSubMetric
+  /sub-metrics/{subMetricNameOrId}/goal:
+    patch:
+      (luvio.adapter):
+        name: patchSemanticMetricGoal
+    delete:
+      (luvio.key):
+        name: urlParams.subMetricNameOrId
+      (luvio.adapter):
+        name: deleteGoalFromSubMetric
+  /dependencies:
+    get:
+      (luvio.adapter):
+        name: getLeafDependenciesByTypes
+  /goals:
+    get:
+      (luvio.key):
+        subMetricNameOrId: queryParams.subMetricApiNameOrId
+        startDate: queryParams.startDate
+        endDate: queryParams.endDate
+      (luvio.adapter):
+        name: getSemanticGoal
+    post:
+      (luvio.adapter):
+        name: createSemanticGoal
+    put:
+      (luvio.adapter):
+        name: updateSemanticGoal
+    delete:
+      (luvio.key):
+        subMetricNameOrId: queryParams.subMetricApiNameOrId
+        startDate: queryParams.startDate
+        endDate: queryParams.endDate
+      (luvio.adapter):
+        name: deleteSemanticGoal