@salesforce/lds-adapters-analytics-wave 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,378 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'WAVE'
+(luvio.ttl): 2592000000
+
+types:
+  ActionCollectionRepresentation:
+    (luvio.ttl): 300
+  BaseWaveAssetRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  DataflowJobCollectionRepresentation:
+    (luvio.ttl): 300
+  DataflowCollectionRepresentation:
+    (luvio.ttl): 300
+  DataConnectorStatusRepresentation:
+    (luvio.ttl): 300
+  DataConnectorCollectionRepresentation:
+    (luvio.ttl): 300
+  DataConnectorTypeCollectionRepresentation:
+    # 1 week 1 * 7 * 24 * 60 * 1000
+    (luvio.ttl): 10080000
+  DataflowJobNodeCollectionRepresentation:
+    (luvio.ttl): 300
+  DependencyRepresentation:
+    (luvio.ttl): 300
+  DatasetCollectionRepresentation:
+    (luvio.ttl): 300
+  DatasetVersionCollectionRepresentation:
+    (luvio.ttl): 300
+  DatasetCoverageRepresentation:
+    (luvio.ttl): 300
+  RecipeCollectionRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 300
+  RecipeNotificationRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: recipe.id
+  ReplicatedDatasetCollectionRepresentation:
+    (luvio.ttl): 300
+  ReplicatedDatasetRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: uuid
+  ReplicatedFieldCollectionRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: replicatedDataset.id
+  RestoreDatasetVersionRepresentation:
+    (luvio.key):
+      # This representation is only used in the response of an RPC like endpoint
+      # Use url as key since we won't look up this data
+      id: url
+  SaqlQueryResultsRepresentation:
+    (luvio.opaque): true
+  ScheduleRepresentation:
+    (luvio.key):
+      id: assetId
+  SourceObjectRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      connectorIdOrApiName: dataConnector.id # Only support id for now
+      SourceObjectName: name
+  SourceFieldCollectionRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      connectorIdOrApiName: dataConnector.id # Only support id for now
+      SourceObjectName: sourceObjectName
+  SourceObjectCollectionRepresentation:
+    (luvio.ttl): 300
+  SourceObjectDataRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 5000
+  TemplateCollectionRepresentation:
+    (luvio.ttl): 300000
+  TemplateConfigurationRepresentation:
+    (luvio.ttl): 300000
+    (luvio.key):
+      id: id
+  TemplateReleaseNotesRepresentation:
+    (luvio.ttl): 300000
+    (luvio.key):
+      id: id
+  TemplateRepresentation:
+    (luvio.ttl): 300000
+    (luvio.key):
+      id: id
+  TemplateValidateRepresentation:
+    (luvio.ttl): 300000
+    (luvio.key):
+      id: id
+    # using opaque due to issues with non-required `state` field (see
+    # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1698346932911129?thread_ts=1698182864.491379&cid=C5WMAFS02)
+    (luvio.opaque): true
+  WaveAnalyticsLimitCollectionRepresentation:
+    (luvio.ttl): 300
+  WaveFolderCollectionRepresentation:
+    (luvio.ttl): 5000
+  XmdRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      url: url
+
+/wave:
+  /actions/{entityId}:
+    get:
+      (luvio.adapter):
+        name: getActions
+  /asset/{assetId}/schedule:
+    get:
+      (luvio.adapter):
+        name: getSchedule
+      (luvio.key):
+        id: urlParams.assetId
+    put:
+      (luvio.adapter):
+        name: updateSchedule
+  /dataConnectors:
+    get:
+      (luvio.adapter):
+        name: getDataConnectors
+    post:
+      (luvio.adapter):
+        name: createDataConnector
+  /dataConnectors/{connectorIdOrApiName}:
+    get:
+      (luvio.adapter):
+        name: getDataConnector
+      (luvio.key):
+        id: urlParams.connectorIdOrApiName
+    patch:
+      (luvio.adapter):
+        name: updateDataConnector
+    delete:
+      (luvio.adapter):
+        name: deleteDataConnector
+      (luvio.key):
+        id: urlParams.connectorIdOrApiName
+    /sourceObjects:
+      get:
+        (luvio.adapter):
+          name: getDataConnectorSourceObjects
+    /sourceObjects/{sourceObjectName}:
+      get:
+        (luvio.adapter):
+          name: getDataConnectorSourceObject
+        (luvio.key):
+          connectorIdOrApiName: urlParams.connectorIdOrApiName
+          SourceObjectName: urlParams.sourceObjectName
+      /dataPreview:
+        post:
+          (luvio.adapter):
+            name: getDataConnectorSourceObjectDataPreviewWithFields
+          (luvio.method): get
+      /fields:
+        get:
+          (luvio.adapter):
+            name: getDataConnectorSourceFields
+          (luvio.key):
+            connectorIdOrApiName: urlParams.connectorIdOrApiName
+            SourceObjectName: urlParams.sourceObjectName
+    /ingest:
+      post:
+        (luvio.adapter):
+          name: ingestDataConnector
+    /status:
+      get:
+        (luvio.adapter):
+          name: getDataConnectorStatus
+  /dataConnectorTypes:
+    get:
+      (luvio.adapter):
+        name: getDataConnectorTypes
+  /dataflows:
+    get:
+      (luvio.adapter):
+        name: getDataflows
+  /dataflowjobs:
+    get:
+      (luvio.adapter):
+        name: getDataflowJobs
+    post:
+      (luvio.adapter):
+        name: createDataflowJob
+  /dataflowjobs/{dataflowjobId}:
+    get:
+      (luvio.adapter):
+        name: getDataflowJob
+      (luvio.key):
+        id: urlParams.dataflowjobId
+    patch:
+      (luvio.adapter):
+        name: updateDataflowJob
+  /dataflowjobs/{dataflowjobId}/nodes:
+    get:
+      (luvio.adapter):
+        name: getDataflowJobNodes
+  /dataflowjobs/{dataflowjobId}/nodes/{nodeId}:
+    get:
+      (luvio.adapter):
+        name: getDataflowJobNode
+      (luvio.key):
+        id: urlParams.nodeId
+  /datasets:
+    get:
+      (luvio.adapter):
+        name: getDatasets
+    post:
+      (luvio.adapter):
+        name: createDataset
+  /datasets/{datasetIdOrApiName}:
+    delete:
+      (luvio.adapter):
+        name: deleteDataset
+      (luvio.key):
+        id: urlParams.datasetIdOrApiName
+    get:
+      (luvio.adapter):
+        name: getDataset
+      (luvio.key):
+        id: urlParams.datasetIdOrApiName
+    patch:
+      (luvio.adapter):
+        name: updateDataset
+    /versions:
+      get:
+        (luvio.adapter):
+          name: getDatasetVersions
+      post:
+        (luvio.adapter):
+          name: createDatasetVersion
+      /{versionId}:
+        get:
+          (luvio.adapter):
+            name: getDatasetVersion
+          (luvio.key):
+            id: urlParams.versionId
+        patch:
+          (luvio.adapter):
+            name: updateDatasetVersion
+        /xmds/{xmdType}:
+          get:
+            (luvio.adapter):
+              name: getXmd
+          put:
+            (luvio.adapter):
+              name: updateXmd
+  /dependencies/{assetId}:
+    get:
+      (luvio.adapter):
+        name: getDependencies
+  /folders:
+    get:
+      (luvio.adapter):
+        name: getWaveFolders
+    post:
+      (luvio.adapter):
+        name: createWaveFolder
+  /folders/{folderId}:
+    delete:
+      (luvio.adapter):
+        name: deleteWaveFolder
+      (luvio.key):
+        id: urlParams.folderId
+    get:
+      (luvio.adapter):
+        name: getWaveFolder
+      (luvio.key):
+        id: urlParams.folderId
+    patch:
+      (luvio.adapter):
+        name: updatePartialWaveFolder
+    put:
+      (luvio.adapter):
+        name: updateWaveFolder
+  /limits:
+    get:
+      (luvio.adapter):
+        name: getAnalyticsLimits
+  /query:
+    post:
+      (luvio.adapter):
+        name: executeQuery
+      (luvio.method): get
+  /recipes:
+    get:
+      (luvio.adapter):
+        name: getRecipes
+  /recipes/{id}:
+    get:
+      (luvio.adapter):
+        name: getRecipe
+      (luvio.key):
+        id: urlParams.id
+    delete:
+      (luvio.adapter):
+        name: deleteRecipe
+      (luvio.key):
+        id: urlParams.id
+    patch:
+      (luvio.adapter):
+        name: updateRecipe
+    /notification:
+      get:
+        (luvio.adapter):
+          name: getRecipeNotification
+        (luvio.key):
+          id: urlParams.id
+      put:
+        (luvio.adapter):
+          name: updateRecipeNotification
+  /replicatedDatasets:
+    get:
+      (luvio.adapter):
+        name: getReplicatedDatasets
+    post:
+      (luvio.adapter):
+        name: createReplicatedDataset
+  /replicatedDatasets/{id}:
+    get:
+      (luvio.adapter):
+        name: getReplicatedDataset
+      (luvio.key):
+        id: urlParams.id
+    delete:
+      (luvio.adapter):
+        name: deleteReplicatedDataset
+      (luvio.key):
+        id: urlParams.id
+    patch:
+      (luvio.adapter):
+        name: updateReplicatedDataset
+  /replicatedDatasets/{id}/fields:
+    get:
+      (luvio.adapter):
+        name: getReplicatedFields
+      (luvio.key):
+        id: urlParams.id
+    patch:
+      (luvio.adapter):
+        name: updateReplicatedFields
+  /security/coverage:
+    /datasets/{datasetIdOrApiName}/versions/{versionId}:
+      get:
+        (luvio.adapter):
+          name: getSecurityCoverageDatasetVersion
+  /templates:
+    get:
+      (luvio.adapter):
+        name: getWaveTemplates
+  /templates/{templateIdOrApiName}:
+    get:
+      (luvio.adapter):
+        name: getWaveTemplate
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+  /templates/{templateIdOrApiName}/configuration:
+    get:
+      (luvio.adapter):
+        name: getWaveTemplateConfig
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+  /templates/{templateIdOrApiName}/releasenotes:
+    get:
+      (luvio.adapter):
+        name: getWaveTemplateReleaseNotes
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+  /templates/{templateIdOrApiName}/validate:
+    post:
+      (luvio.adapter):
+        name: validateWaveTemplate