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

package/src/raml/api.raml

@@ -0,0 +1,390 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  EmptyRepresentation:
+    description: Represents empty response
+    type: object
+    properties:
+      fakeKey: string # TODO: Handrolled because luvio doesn't support mutation operations that don't return a key
+  NetworkDataCategoryGroupRepresentation:
+    description: Describes a network data category group
+    type: object
+    properties:
+      categoryGroupName:
+        description: Network Data Category Group Name
+        type: string
+      rootCategory:
+        description: Root Category Representation
+        type: NetworkDataCategoryRepresentation
+        required: true
+  NetworkDataCategoryRepresentation:
+    description: Describes a network data category
+    type: object
+    properties:
+      categoryName:
+        description: Network Data Category Name
+        type: string | nil
+      childCategories:
+        description: Children of Network Data Category
+        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
+      description:
+        description: Network Data Category Description
+        type: string | nil
+        required: false
+      id:
+        description: Network Data Category id
+        type: string
+      imageUrl:
+        description: Image Url of Network Data Category
+        type: string | nil
+        required: false
+      categoryOrGroupLabel:
+        description: Label of the Data Category or Data Category Group
+        type: string | nil
+        required: false
+      label:
+        description: Network Data Category Label
+        type: string | nil
+        required: false
+      relativeUrl:
+        description: Relative Url of the Network Data Category
+        type: string | nil
+        required: false
+      categoryGroupName:
+        description: Network Data Category Group Name
+        type: string | nil
+        required: false
+  NetworkDataCategoryCollectionRepresentation:
+    description: Represents a list of Network Data Categories.
+    type: object
+    properties:
+      baseUrl:
+        description: LWR Base URL for Network Data Category Detail page
+        type: string | nil
+        required: false
+      networkDataCategories:
+        description: A collection of network data categories
+        type: array
+        items:
+          type: NetworkDataCategoryRepresentation
+  NetworkDataCategoryTreeRepresentation:
+    description: Represents a network data category tree
+    type: object
+    properties:
+      communityId: string
+      dataCategoryGroups:
+        description: List of category groups
+        type: array
+        items:
+          type: NetworkDataCategoryGroupRepresentation
+  DataCategoryGroupCollectionInputRepresentation:
+    description: Represents a data category
+    type: object
+    properties:
+      dataCategoryGroups:
+        description: Collection of Data Category Groups
+        type: array
+        items:
+          type: any
+  DataCategoryGroupCollectionInputWrapperRepresentation: # TODO Hand-rolled W-8334626
+    description: Wrapper for replicated dataset input representation
+    type: object
+    properties:
+      networkDataCategoryTree:
+        type: DataCategoryGroupCollectionInputRepresentation
+        description: Replicated dataset input representation
+  LightningKnowledgeArticleVersionCollectionRepresentation:
+    description: Represents a list of Knowledge Articles in Lightning.
+    type: object
+    properties:
+      baseUrl:
+        description: LWR Base URL for Knowledge Article Detail page
+        type: string | nil
+        required: false
+      items:
+        description: A collection of knowledge articles.
+        type: array
+        items:
+          type: LightningKnowledgeArticleVersionRepresentation
+  LightningKnowledgeArticleVersionRepresentation:
+    description: Describing a Knowledge article in lightning.
+    type: object
+    properties:
+      id:
+        description: KnowledgeArticleVersion Id
+        type: string
+      knowledgeArticleId:
+        description: ID of the corresponding knowledge article.
+        type: string
+      lastPublishedDate:
+        description: Last published date of the article.
+        type: string
+      summary:
+        description: Summary of the articles contents.
+        type: string | nil
+        required: false
+      title:
+        description: Title of the Article
+        type: string
+      urlName:
+        description: URL_NAME of the Article
+        type: string
+  ServiceCatalogItemCollectionRepresentation:
+    description: Represents a list of ServiceCatalogItemRepresentations
+    type: object
+    properties:
+      baseUrl:
+        description: LWR Base URL for Service Catalog Item Definition Detail page
+        type: string | nil
+        required: false
+      items:
+        description: A collection of service catalog items.
+        type: array
+        items:
+          type: ServiceCatalogItemRepresentation
+  ServiceCatalogItemRepresentation:
+    description: Describes a service catalog item
+    type: object
+    properties:
+      description:
+        description: Short Description of Service Catalog Item
+        type: string | nil
+        required: false
+      developerName:
+        description: Dev name of Service Catalog Item
+        type: string
+      id:
+        description: Service Catalog Item Id
+        type: string
+      imageId:
+        description: Image Id of Service Catalog Item
+        type: string | nil
+        required: false
+      label:
+        description: Label of Service Catalog Item
+        type: string
+/connect:
+  /network-data-category/{networkDataCategoryId}/catalog-item:
+    get:
+      displayName: getServiceCatalogItemsForCommumity
+      description: Get all catalog items belonging to the network data category
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServiceCatalogItemCollectionRepresentation
+      queryParameters:
+        pageSize:
+          type: integer
+          required: false
+        pageNumber:
+          type: integer
+          required: false
+        sortOrder:
+          type: string
+          required: false
+        sortedBy:
+          type: string
+          required: false
+    uriParameters:
+      networkDataCategoryId:
+        type: string
+        required: true
+  /communities/{communityId}:
+    /network-data-category/{networkDataCategoryId}:
+      patch:
+        displayName: updateNetworkDataCategory
+        description: Update label and description of a selected data category for
+          the given community ID
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: NetworkDataCategoryRepresentation
+        queryParameters:
+          description:
+            type: string
+            required: false
+          label:
+            type: string
+            required: false
+      uriParameters:
+        communityId:
+          type: string
+          required: true
+        networkDataCategoryId:
+          type: string
+          required: true
+      /catalog-item:
+        get:
+          displayName: getServiceCatalogItems
+          description: Get all catalog items belonging to the network data category
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ServiceCatalogItemCollectionRepresentation
+          queryParameters:
+            pageSize:
+              type: integer
+              required: false
+            pageNumber:
+              type: integer
+              required: false
+            sortOrder:
+              type: string
+              required: false
+            sortedBy:
+              type: string
+              required: false
+        uriParameters:
+          networkDataCategoryId:
+            type: string
+            required: true
+          communityId:
+            type: string
+            required: true
+      /knowledge-article:
+        get:
+          displayName: getKnowledgeArticles
+          description: Get all articles belonging to the category
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: LightningKnowledgeArticleVersionCollectionRepresentation
+          queryParameters:
+            language:
+              type: string
+              required: false
+            pageNumber:
+              type: integer
+              required: false
+            pageSize:
+              type: integer
+              required: false
+            sortOrder:
+              type: string
+              required: false
+            sortedBy:
+              type: string
+              required: false
+        uriParameters:
+          networkDataCategoryId:
+            type: string
+            required: true
+          communityId:
+            type: string
+            required: true
+      /parent-path:
+        get:
+          displayName: getParentNetworkDataCategoryPath
+          description: Get entire parent path for a given network data category
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: NetworkDataCategoryCollectionRepresentation
+          queryParameters:
+            language:
+              type: string
+              required: false
+        uriParameters:
+          communityId:
+            type: string
+            required: true
+          networkDataCategoryId:
+            type: string
+            required: true
+      /child-category:
+        get:
+          displayName: getChildNetworkDataCategories
+          description: Get children of the given network data category
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: NetworkDataCategoryCollectionRepresentation
+          queryParameters:
+            language:
+              type: string
+              required: false
+            pageNumber:
+              type: integer
+              required: false
+            pageSize:
+              type: integer
+              required: false
+            sortOrder:
+              type: string
+              required: false
+            sortedBy:
+              type: string
+              required: false
+        uriParameters:
+          communityId:
+            type: string
+            required: true
+          networkDataCategoryId:
+            type: string
+            required: true
+    /data-category/network-data-category:
+      get:
+        displayName: getNetworkDataCategories
+        description: Get all network data category trees in a given community
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: NetworkDataCategoryTreeRepresentation
+      put:
+        displayName: updateNetworkDataCategories
+        description: Save or Update selected data category and its parent categories
+          for the given community ID
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EmptyRepresentation
+        body:
+          application/json:
+            type: DataCategoryGroupCollectionInputWrapperRepresentation #TODO Hand-rolled W-8334626. Original type: DataCategoryGroupCollectionInputRepresentation
+            (oas-body-name): networkDataCategoryTree
+      uriParameters:
+        communityId:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -0,0 +1,59 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'NetworkDataCategory'
+(luvio.ttl): 900000
+
+types:
+  EmptyRepresentation:
+    (luvio.key):
+      fakeKey: fakeKey
+  NetworkDataCategoryTreeRepresentation:
+    (luvio.key):
+      communityId: communityId
+    (luvio.updateAvailable):
+      name: notifyNetworkDataCategoryTreeRepresentationUpdateAvailable
+      parameters:
+        communityId: communityId
+  NetworkDataCategoryRepresentation:
+    (luvio.key):
+      id: id
+
+/connect:
+  /network-data-category/{networkDataCategoryId}/catalog-item:
+    get:
+      (luvio.adapter):
+        name: getServiceCatalogItems
+  /communities/{communityId}:
+    /network-data-category/{networkDataCategoryId}:
+      patch:
+        (luvio.adapter):
+          name: updateNetworkDataCategory
+      /catalog-item:
+        get:
+          (luvio.adapter):
+            name: getServiceCatalogItemsForCommunity
+      /knowledge-article:
+        get:
+          (luvio.adapter):
+            name: getArticlesForCategory
+      /parent-path:
+        get:
+          (luvio.adapter):
+            name: getParentNetworkDataCategoryPath
+      /child-category:
+        get:
+          (luvio.adapter):
+            name: getChildCategories
+    /data-category/network-data-category:
+      get:
+        (luvio.adapter):
+          name: getNetworkDataCategories
+        (luvio.key):
+          communityId: urlParams.communityId
+      put:
+        (luvio.adapter):
+          name: updateNetworkDataCategories