@salesforce/lds-adapters-platform-learning-content 0.131.0

package/src/raml/luvio.raml

@@ -0,0 +1,112 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'LearningContentPlatform'
+(luvio.ttl): 2592000000
+
+types:
+  # EvaluateLearningItemInputRepresentation:
+  #   (luvio.opaque): true
+  #   (luvio.ttl): 10000
+  FeaturedItemRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      id: id
+  LearningSearchDescribeContentRepresentation:
+    (luvio.ttl): 21600000 # 6 hours
+    (luvio.key):
+      type: type
+  LearningSearchResultsRepresentation:
+    (luvio.ttl): 21600000 # 6 hours
+    (luvio.key):
+      type: type
+  LearningItemRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      learning_item_id: id
+  LearningItemProgressRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      learning_item_id: learningItemId
+  LearningModelOutputRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      learning_item_id: id
+  LearningPracticeRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      learning_item_id: learningItemId
+  LearningTextLessonRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      learning_item_id: learningItemId
+  TrailheadModuleRepresentation:
+    (luvio.ttl): 21600000 # 15 seconds
+    (luvio.key):
+      relatedId: relatedId
+
+/learning-content-platform:
+  /featured-item:
+    /list/related:
+      get:
+        (luvio.adapter):
+          name: getFeaturedItemsRelatedList
+    /list/recommended:
+      get:
+        (luvio.adapter):
+          name: getFeaturedItemsRecommendedList
+  /learning:
+    /search:
+      /describe:
+        get:
+          (luvio.adapter):
+            name: getLearningSearchDescribe
+      /type/{contentType}:
+        get:
+          (luvio.adapter):
+            name: getLearningSearchResults
+          (luvio.key):
+            type: urlParams.contentType
+    /config:
+      get:
+        (luvio.adapter):
+          name: getLearningConfig
+    /item/list:
+      get:
+        (luvio.adapter):
+          name: getLearningItemsList
+    /item/progress:
+      get:
+        (luvio.adapter):
+          name: getLearningItemProgress
+    /model/{learningItemId}:
+      get:
+        (luvio.adapter):
+          name: getLearningModel
+        (luvio.key):
+          learning_item_id: urlParams.learningItemId
+    /module/{moduleId}:
+      get:
+        (luvio.adapter):
+          name: getModule
+        (luvio.key):
+          relatedId: urlParams.moduleId
+    /practice/{learningItemId}:
+      get:
+        (luvio.adapter):
+          name: getLearningPractice
+        (luvio.key):
+          learning_item_id: urlParams.learningItemId
+    /evaluate:
+      post:
+        (luvio.adapter):
+          name: evaluateLearningItem
+    /textlesson/{learningItemId}:
+      get:
+        (luvio.adapter):
+          name: getTextLesson
+        (luvio.key):
+          learning_item_id: urlParams.learningItemId