@salesforce/lds-adapters-industries-dataloading 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,115 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.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:
+  ObjectCsvDataTemplateRepresentation:
+    description: Output representation for csv data template
+    type: object
+    properties:
+      code:
+        description: return code
+        type: integer
+      message:
+        description: return message
+        type: string
+      template:
+        description: return template
+        type: object
+
+  FeatureObjectsResultRepresentation:
+    description: Output representation for objects for a feature
+    type: object
+    properties:
+      code:
+        description: return code
+        type: integer
+      currentPageNumber:
+        description: return currentPageNumber
+        type: integer
+      currentPageSize:
+        description: return currentPageSize
+        type: integer
+      message:
+        description: return message
+        type: string
+      objects:
+        description: return objects
+        type: array
+        items:
+          type: FeatureObjectRepresentation
+      totalAvailableItems:
+        description: return totalAvailableItems
+        type: integer
+
+  FeatureObjectRepresentation:
+    description: Representation for an object in list of objects
+    type: object
+    properties:
+      apiName:
+        description: return apiName
+        type: string
+      label:
+        description: return label
+        type: string
+
+/connect/industries/csv-data-template/{objectApiName}:
+  get:
+    description: method to get CSV Data Template for an object
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ObjectCsvDataTemplateRepresentation
+  uriParameters:
+    objectApiName:
+      type: string
+      required: true
+
+/connect/industries/{featureName}/objects:
+  get:
+    description: method to get list of objects for feature
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FeatureObjectsResultRepresentation
+    queryParameters:
+      limit:
+        type: integer
+        required: false
+      offset:
+        type: integer
+        required: false
+      entityType:
+        type: string
+        required: true
+  uriParameters:
+    featureName:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,25 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'dataloading'
+
+types:
+  ObjectCsvDataTemplateRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+  FeatureObjectsResultRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+
+/connect/industries/csv-data-template/{objectApiName}:
+  get:
+    (luvio.adapter):
+      name: getCsvDataTemplate
+
+/connect/industries/{featureName}/objects:
+  get:
+    (luvio.adapter):
+      name: getObjectsForFeature