@salesforce/lds-adapters-cdp-byoc 1.332.0-dev18

package/src/raml/api.raml

@@ -0,0 +1,220 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v63.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:
+  CdpUserRepresentation:
+    description: Represents a user
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID
+        type: string
+      name:
+        description: The name of the user
+        type: string
+      profilePhotoUrl:
+        description: The Chatter profile photo of the user
+        type: string
+  CustomCodeDeploymentInputRepresentation:
+    description: Input representation for creating a Custom Code Deployment
+    # Hand-rolled: Combines this object with the original
+    # base object (CdpAssetBaseInputRepresentation) as Luvio
+    # does not like multiple levels of inheritance in objects
+    type: object
+    properties:
+      # Hand-rolled: Our Connect API does not require a value be passed in here
+      codeType?:
+        description: Custom code type
+        type: string
+        enum:
+          - Function
+          - Script
+      computeType:
+        description: Compute type for executions of the custom code
+        type: string
+        enum:
+          - Cpu_l
+          - Cpu_m
+          - Cpu_s
+          - Cpu_xs
+          - High_cpu_l
+          - High_cpu_m
+          - High_cpu_s
+          - High_cpu_xs
+          - High_memory_cpu_l
+          - High_memory_cpu_m
+          - High_memory_cpu_s
+          - High_memory_cpu_xs
+      # Hand-rolled: Our Connect API does not require a value be passed in here
+      description?:
+        description: Description of the custom code deployment
+        type: string
+      # Hand-rolled: Our Connect API does not require an ID for all endpoints
+      id?:
+        description: Id
+        type: string
+      label:
+        description: Label of the custom code deployment
+        type: string
+      name:
+        description: Name
+        type: string
+      # Hand-rolled: Our Connect API does not use the namespace field currently
+      namespace?:
+        description: Namespace
+        type: string
+      # Hand-rolled: Our Connect API does not require a value be passed in here
+      parameters?:
+        description: Parameters of the custom code deployment
+        type: object
+        properties:
+          //:
+            type: string
+      version:
+        description: Version of the custom code
+        type: string
+  CustomCodeDeploymentRepresentation:
+    description: A custom code deployment.
+    # Hand-rolled: Combines this object with the original
+    # base object (CdpAssetBaseRepresentation) as Luvio
+    # does not like multiple levels of inheritance in objects
+    type: object
+    properties:
+      # Hand-rolled: Our Connect API does not always return a value here
+      codeType:
+        description: Custom code type
+        type: string
+        enum:
+          - Function
+          - Script
+      functionInvokeOptions?:
+        description: List of function invoke options
+        type: array
+        items:
+          type: string
+          enum:
+            - UnstructuredChunking
+      computeType:
+        description: Compute type for executions of the custom code
+        type: string
+        enum:
+          - Cpu_l
+          - Cpu_m
+          - Cpu_s
+          - Cpu_xs
+          - High_cpu_l
+          - High_cpu_m
+          - High_cpu_s
+          - High_cpu_xs
+          - High_memory_cpu_l
+          - High_memory_cpu_m
+          - High_memory_cpu_s
+          - High_memory_cpu_xs
+      createdBy:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate:
+        description: Created date
+        type: string
+      # Hand-rolled: Connect API does not return this value when null
+      deploymentFailureCode?:
+        description: Failure code for the custom code deployment
+        type: integer
+      # Hand-rolled: Connect API does not return this value when null
+      deploymentFailureReason?:
+        description: Failure reason for the custom code deployment
+        type: string
+      deploymentStatus:
+        description: Deployment status of the custom code
+        type: string
+        enum:
+          - Deployed
+          - Error
+          - Initializing
+          - Scanning
+      # Hand-rolled: Connect API does not return this value when not provided on input
+      description?:
+        description: Description of the custom code deployment
+        type: string
+      fileUploadUrl:
+        description: URL to use for custom code file upload
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      lastModifiedBy:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate:
+        description: Last modified date
+        type: string
+      name:
+        description: Name of the asset
+        type: string
+      # Hand-rolled: namespace is not returned by our Connect API implementation
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      parameters:
+        description: Parameters of custom code deployment
+        type: object
+        properties:
+          //:
+            type: string
+      status:
+        description: Sync status of the custom code deployment
+        type: string
+        enum:
+          - Active
+          - Deleting
+          - Error
+          - Processing
+      url:
+        description: Url
+        type: string
+      version:
+        description: Version of the custom code
+        type: string
+/ssot:
+  /data-custom-code:
+    post:
+      displayName: postCdpCustomCodeDeploymentCollection
+      description: Create a new custom code deployment
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CustomCodeDeploymentRepresentation
+      body:
+        application/json:
+          type: CustomCodeDeploymentInputRepresentation
+          # TODO Hand-rolled W-9271732
+          # required: false
+          (oas-body-name): customCodeDeployment

package/src/raml/luvio.raml

@@ -0,0 +1,25 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'byoc'
+(luvio.ttl): 60000
+
+types:
+  CdpAssetBaseRepresentation:
+    (luvio.key):
+      id: id
+  CustomCodeDeploymentInputRepresentation:
+    (luvio.key):
+      name: name
+  CustomCodeDeploymentRepresentation:
+    (luvio.key):
+      id: id
+
+/ssot:
+  /data-custom-code:
+    post:
+      (luvio.adapter):
+        name: createCustomCodeDeployment