@salesforce/lds-adapters-analytics-app-framework 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,179 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'AppFramework'
+(luvio.ttl): 2592000000
+
+types:
+  AppActivityCollectionRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      appId: appId
+  AppActivityItemRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      appId: appId
+      id: id
+  AppCollectionRepresentation:
+    (luvio.ttl): 5000
+  AppRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  AppResultRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: app.id
+  AssetCollectionRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      appId: appId
+  AssetRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  InstalledAssetCollectionRepresentation:
+    (luvio.ttl): 5000
+  TemplateCollectionRepresentation:
+    (luvio.ttl): 5000
+  TemplateRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  TemplateConfigurationRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+  TemplateTagCollectionRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: templateId
+  TemplateReadinessRepresentation:
+    (luvio.ttl): 1000
+    (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
+  TemplatedAssetCollectionRepresentation:
+    (luvio.ttl): 5000
+  TemplatedAssetRepresentation:
+    (luvio.ttl): 5000
+    (luvio.key):
+      id: id
+
+/app-framework:
+  /apps:
+    get:
+      (luvio.adapter):
+        name: getApps
+    post:
+      (luvio.adapter):
+        name: createApp
+  /apps/{appIdOrApiName}:
+    delete:
+      (luvio.adapter):
+        name: deleteApp
+      (luvio.key):
+        id: urlParams.appIdOrApiName
+    get:
+      (luvio.adapter):
+        name: getApp
+      (luvio.key):
+        id: urlParams.appIdOrApiName
+    put:
+      (luvio.adapter):
+        name: updateApp
+  /apps/{appIdOrApiName}/assets:
+    get:
+      (luvio.adapter):
+        name: getAppAssets
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+    post:
+      (luvio.adapter):
+        name: createAppAsset
+  /apps/{appIdOrApiName}/updateBasicApp:
+    post:
+      (luvio.adapter):
+        name: updateBasicApp
+  /apps/{appIdOrApiName}/assets/{appAssetId}:
+    get:
+      (luvio.adapter):
+        name: getAppAsset
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+        id: urlParams.appAssetId
+    delete:
+      (luvio.adapter):
+        name: deleteAppAsset
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+        id: urlParams.appAssetId
+    patch:
+      (luvio.adapter):
+        name: updateAppAsset
+  /apps/{appIdOrApiName}/activities:
+    get:
+      (luvio.adapter):
+        name: getAppActivities
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+  /apps/{appIdOrApiName}/activities/{id}:
+    get:
+      (luvio.adapter):
+        name: getAppActivity
+      (luvio.key):
+        appId: urlParams.appIdOrApiName
+        id: urlParams.id
+  /installed-assets:
+    get:
+      (luvio.adapter):
+        name: getInstalledAssets
+  /templates:
+    get:
+      (luvio.adapter):
+        name: getTemplates
+    post:
+      (luvio.adapter):
+        name: createTemplate
+  /templates/{templateIdOrApiName}:
+    get:
+      (luvio.adapter):
+        name: getTemplate
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+    delete:
+      (luvio.adapter):
+        name: deleteTemplate
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+    patch:
+      (luvio.adapter):
+        name: updateTemplate
+  /templates/{templateIdOrApiName}/assets:
+    get:
+      (luvio.adapter):
+        name: getTemplateAssets
+  /templates/{templateIdOrApiName}/configuration:
+    get:
+      (luvio.adapter):
+        name: getTemplateConfig
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+  /templates/{templateIdOrApiName}/readiness:
+    post:
+      (luvio.adapter):
+        name: readinessCheck
+  /templates/{templateIdOrApiName}/tags:
+    get:
+      (luvio.adapter):
+        name: getTags
+      (luvio.key):
+        id: urlParams.templateIdOrApiName
+    put:
+      (luvio.adapter):
+        name: setTags