@salesforce/lds-adapters-platform-learning-content 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,126 @@
+#%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
+  LearningItemRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      learning_item_id: id
+    (luvio.updateAvailable):
+      name: notifyLearningItemUpdateAvailable
+      parameters:
+        learning_item_id: id
+  LearningItemProgressRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      learning_item_id: learningItemId
+    (luvio.updateAvailable):
+      name: notifyLearningItemProgressUpdateAvailable
+      parameters:
+        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
+    (luvio.updateAvailable):
+      name: notifyLearningTextLessonUpdateAvailable
+      parameters:
+        learning_item_id: learningItemId
+  TrailheadModuleRepresentation:
+    (luvio.ttl): 21600000 # 15 seconds
+    (luvio.key):
+      relatedId: relatedId
+  CoachingAICallSubmissionOutputRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      generation_id: generationId
+  CoachingAIFeedbackSummaryOutputRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      generation_id: generationId
+
+/learning-content-platform:
+  /coaching:
+    /ai-feedback:
+      post:
+        (luvio.adapter):
+          name: submitForCoachingAIFeedback
+    /moments/ai-product-pitch-feedback:
+      post:
+        (luvio.adapter):
+          name: submitForCoachingMomentsProductPitchFeedback
+    /{learningItemSubmissionId}/ai-feedback:
+      get:
+        (luvio.adapter):
+          name: getCoachingAIFeedback
+  /featured-item:
+    /list/related:
+      get:
+        (luvio.adapter):
+          name: getFeaturedItemsRelatedList
+    /list/recommended:
+      get:
+        (luvio.adapter):
+          name: getFeaturedItemsRecommendedList
+  /learning:
+    /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