@salesforce/lds-adapters-starter-solution-recipes 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,227 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  SolutionLibraryErrorRepresentation:
+    description: Represents Solution Library definition
+    type: object
+    properties:
+      code:
+        description: Solution Library Error code
+        type: string
+      message:
+        description: Solution Library Error message
+        type: string
+  SolutionLibraryFilterInputRepresentation:
+    description: A Solution Library Filters representation
+    type: object
+    properties:
+      bookMarked:
+        description: Filter Bookmarked recipes
+        type: boolean
+        required: false # TODO Hand-rolled W-15955585
+      clouds:
+        description: List of Solution Library clouds
+        type: array
+        required: false # TODO Hand-rolled W-15955585
+        items:
+          type: string
+      markedAsDone:
+        description: Sets Filter MarkedAsDone recipes
+        type: boolean
+        required: false # TODO Hand-rolled W-15955585
+  SolutionLibraryInputRepresentation:
+    description: A Solution Library Entry
+    type: object
+    properties:
+      currentRecipes:
+        description: List of Solution Library recipes currently shown
+        type: array
+        required: false # TODO Hand-rolled W-15955585
+        items:
+          type: string
+      filters:
+        description: Solution Library filters
+        type: SolutionLibraryFilterInputRepresentation # TODO Hand-rolled W-15955623
+        required: false # TODO Hand-rolled W-15955585
+      offset:
+        description: Start returning data from the offset position
+        type: integer
+        required: false # TODO Hand-rolled W-15955585
+      section:
+        description: Section on solution library ( recommended, more to explore)
+        type: string
+  SolutionLibraryOutputRepresentation:
+    description: Represents Solution Library definition
+    type: object
+    properties:
+      error:
+        description: Solution Library Error
+        type: SolutionLibraryErrorRepresentation
+        required: false
+      isSuccess:
+        description: Indicates if Solution library recipes can be retrieved
+        type: boolean
+      recipes:
+        description: Solution Library Recipes
+        type: array
+        required: false
+        items:
+          type: SolutionLibraryRecipeRepresentation
+  SolutionLibraryPageReferenceRepresentation:
+    description: Represents Solution Library action param PageReferenceRepresentation
+    type: object
+    properties:
+      attributes:
+        description: Solution Library page reference attributes
+        type: object
+        properties:
+          //:
+            type: string
+      type:
+        description: Solution Library page reference type
+        type: string
+  SolutionLibraryRecipeRepresentation:
+    description: Represents Solution Library Recipe definition
+    type: object
+    properties:
+      action:
+        description: Solution Library Recipe action
+        type: SolutionRecipeActionRepresentation
+      description:
+        description: Solution Library Recipe Description
+        type: string
+      icon:
+        description: Solution Library Recipe Icon
+        type: string
+      iconAltText:
+        description: Solution Library Recipe IconAltText
+        type: string
+      iconStyle:
+        description: Solution Library Recipe IconStyle
+        type: string
+      id:
+        description: Solution Library recipe Id for GNR
+        type: string
+      isBookmarked:
+        description: Solution Library Recipe Save for later
+        type: boolean
+      isMarkedAsComplete:
+        description: Solution Library Recipe Mark as complete
+        type: boolean
+      recipeId:
+        description: Solution Library Recipe Id
+        type: string
+      score:
+        description: Solution Library Recipe score
+        type: integer
+      state:
+        description: Solution Library Recipe State
+        type: string
+      tagId:
+        description: Solution Library Recipe TagId
+        type: array
+        items:
+          type: string
+      title:
+        description: Solution Library Recipe Title
+        type: string
+  SolutionRecipeActionParamsRepresentation:
+    description: Represents Solution Library definition
+    type: object
+    properties:
+      id:
+        description: Solution Library Action param id
+        type: string
+        required: false
+      index:
+        description: Solution Library Recipe action param index
+        type: integer
+        required: false
+      isDeclarative:
+        description: Solution Library Recipe action param is declarative
+        type: boolean
+        required: false
+      isFolder:
+        description: Solution Library Recipe action param isFolder
+        type: boolean
+        required: false
+      lsf:
+        description: Solution Library Recipe action param lsf
+        type: string
+        required: false
+      lsfParams:
+        description: Solution Library Recipe action param LSF params
+        type: object
+        required: false
+        properties:
+          //:
+            type: string
+      name:
+        description: Solution Library Recipe action param name
+        type: string
+        required: false
+      pageReference:
+        description: Solution Library Action param page ref
+        type: SolutionLibraryPageReferenceRepresentation
+        required: false
+      pubSubEvents:
+        description: Solution Library Recipe action param pub sub events
+        type: string
+        required: false
+      stepId:
+        description: Solution Library Recipe action param stepid
+        type: string
+        required: false
+      url:
+        description: Solution Library Recipe action param url
+        type: string
+        required: false
+  SolutionRecipeActionRepresentation:
+    description: Represents Solution Recipe Action definition
+    type: object
+    properties:
+      params:
+        description: Solution Library Recipe action params
+        type: SolutionRecipeActionParamsRepresentation
+        required: false
+      type:
+        description: Solution Library Recipe action type
+        type: string
+/connect/solution-library/recipes:
+  post:
+    displayName: postSolutionLibraryPost
+    description: Retrieve list of solution library recipes.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SolutionLibraryOutputRepresentation
+    body:
+      application/json:
+        type: SolutionLibraryInputRepresentation # TODO Hand-rolled W-8988522
+        (oas-body-name): SolutionLibrarySearchData

package/src/raml/luvio.raml

@@ -0,0 +1,21 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'solution-recipes'
+(luvio.ttl): 1000
+
+types:
+  SolutionLibraryOutputRepresentation:
+    (luvio.key):
+      isSuccess: isSuccess
+  SolutionLibraryRecipeRepresentation:
+    (luvio.key):
+      id: id
+
+/connect/solution-library/recipes:
+  post:
+    (luvio.adapter):
+      name: postSolutionLibraryRecipes