@salesforce/lds-adapters-platform-data-seed 1.339.0

package/src/raml/api.raml

@@ -0,0 +1,192 @@
+#%RAML 1.0
+title: Salesforce API Platform Cloudbeat
+protocols:
+  - HTTPS
+
+types:
+  DataSeedStatusOutputRepresentation:
+    description: Data Seed Response Representation
+    type: object
+    properties:
+      data:
+        description: Data Seed Request's History Data List
+        type: array
+        items:
+          type: DataSeedRequestObjectRepresentation
+      correlation_id:
+        description: Data Seed Request's Correlation ID
+        type: string
+
+  DataSeedRequestObjectRepresentation:
+    description: Data Seed Request properties
+    type: object
+    properties:
+      request_id:
+        description: Request ID
+        type: string
+      organization_id:
+        description: Organization ID
+        type: string
+      name:
+        description: Request Name
+        type: string
+      description:
+        description: Request Description
+        type: string
+      job_type:
+        description: Request Job Type
+        type: string
+      status:
+        description: Request Status
+        type: string
+      step:
+        description: Request Step
+        type: string
+      log_text:
+        description: Request Log Text
+        type: string
+      execution_start_time:
+        description: Request Execution Start Time
+        type: string
+      execution_end_time:
+        description: Request Execution End Time
+        type: string
+      created_by:
+        description: Request Created By User
+        type: string
+
+  DataSeedStatusErrorRepresentation:
+    description: Data Seed Error Representation
+    type: object
+    properties:
+      error:
+        description: Data Seed Error Message
+        type: string
+
+  PreSignedUrlInputRepresentation:
+    description: Pre Signed Url Input Representation
+    type: object
+    properties:
+      file_name:
+        description: File Name
+        type: string
+
+  PreSignedUrlResultRepresentation:
+    description: Pre Signed Url Response Representation
+    type: object
+    properties:
+      url:
+        description: Pre Signed Url
+        type: string
+      s3_unique_id:
+        description: Url Unique Id
+        type: string
+
+  PreSignedUrlBadErrorRepresentation:
+    description: Pre Signed Url Missing Parameters Error Representation
+    type: object
+    properties:
+      error:
+        description: Pre Signed Url Bad Request Error Message
+        type: string
+
+  PreSignedUrlServerErrorRepresentation:
+    description: Pre Signed Url Server Error Representation
+    type: object
+    properties:
+      error:
+        description: Pre Signed Url Server Error Message
+        type: string
+      correlation_id:
+        description: Pre Signed Url Request Correlation Id
+        type: string
+
+/platform/data-seed/v1:
+  /data-seed-request:
+    get:
+      displayName: DataSeedStatusAPI
+      description: For a given requestId return it's status
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with request's status.
+          body:
+            application/json:
+              type: DataSeedStatusOutputRepresentation
+        400:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        403:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        500:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+  /data-seed-generate-presigned-upload-url:
+    post:
+      displayName: getPreSignedUrl
+      description: Add an existing Data Cloud Object as a new Semantic Data Object to a specific Semantic Model.
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns Pre Signed Url
+          body:
+            application/json:
+              type: PreSignedUrlResultRepresentation
+        400:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: PreSignedUrlBadErrorRepresentation
+        500:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: PreSignedUrlInputRepresentation
+
+description: |
+  Data Seed service owned by AI Data Seeding Platform team that migrate or generates the data to a target org
+mediaType:
+  - application/json
+baseUri: api.salesforce.com

package/src/raml/luvio.raml

@@ -0,0 +1,24 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'data-seed'
+
+(luvio.ttl): 30000
+types:
+  PreSignedUrlResultRepresentation:
+    (luvio.ttl): 300000
+    (luvio.key):
+      s3_unique_id: s3_unique_id
+
+/platform/data-seed/v1:
+  /data-seed-request:
+    get:
+      (luvio.adapter):
+        name: getDataSeedStatus
+  /data-seed-generate-presigned-upload-url:
+    post:
+      (luvio.adapter):
+        name: getUploadPreSignedUrl