@salesforce/lds-adapters-service-data-category 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,83 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.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:
+  DataCategoryGroupCollectionRepresentation:
+    description: Data Category Group Collection Representation
+    type: object
+    properties:
+      dataCategoryGroups:
+        description: Collection of Data Category Groups
+        type: array
+        items:
+          type: DataCategoryGroupRepresentation
+  DataCategoryGroupRepresentation:
+    description: Data Category Group Representation
+    type: object
+    properties:
+      categoryGroupName:
+        description: Developer Name of the Data Category Group
+        type: string
+      description:
+        description: Description of the Data Category Group
+        type: string | nil
+        required: false
+      label:
+        description: Label of the Data Category Group
+        type: string | nil
+        required: false
+      rootCategory:
+        description: Root Category of the Data Category Group
+        type: DataCategoryRepresentation | nil
+        required: false
+  DataCategoryRepresentation:
+    description: Data Category Representation
+    type: object
+    properties:
+      categoryName:
+        description: Developer Name of the Data Category
+        type: string | nil
+        required: false
+      childCategories:
+        description: List of child data categories
+        type: array
+        items:
+          type: any # This is a workaround because recursive (tree) representations aren't supported in Luvio, even though they're supported in Connect API
+      label:
+        description: Label of the Data Category
+        type: string | nil
+        required: false
+/connect:
+  /data-category/category-group:
+    get:
+      displayName: getCategoryGroups
+      description: Returns all active data category groups and their child categories
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataCategoryGroupCollectionRepresentation

package/src/raml/luvio.raml

@@ -0,0 +1,14 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'DataCategory'
+(luvio.ttl): 900000
+
+/connect:
+  /data-category/category-group:
+    get:
+      (luvio.adapter):
+        name: getCategoryGroups