@salesforce/lds-adapters-cms-managedcontentspaces 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,182 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  ManagedContentSpaceChannelsRepresentation:
+    description: List of managed content space channels.
+    type: object
+    properties:
+      currentPageUrl:
+        description: URL to the current page of Manage Content Space Channels.
+        type: string | nil
+      nextPageUrl:
+        description: URL to the next page of Manage Content Space Channels.
+        type: string | nil
+      previousPageUrl:
+        description: URL to the previous page of Managed Content Space Channel records
+        type: string | nil
+      spaceChannels:
+        description: Managed content space channels
+        type: array
+        items:
+          type: ManagedContentSpaceChannelRepresentation
+      totalSpaceChannels:
+        description: Total count of Manage Content Space Channel records returned
+          for the current request
+        type: integer
+  ManagedContentSpaceChannelRepresentation:
+    description: Representation of a Managed Content space Channel
+    type: object
+    properties:
+      channelSummary:
+        description: ManagedContent channel information
+        type: ManagedContentChannelSummaryRepresentation
+      createdBy:
+        description: Information of the user who created the Managed Content Space
+          Channel.
+        type: ManagedContentUserSummaryRepresentation
+      createdDate:
+        description: Date when the space channel is created
+        type: string
+      status:
+        description: Status of the Managed Content Space Channel.
+        type: string
+        enum:
+          - Created
+          - Delink
+          - Failed
+          - Pending
+  ManagedContentChannelSummaryRepresentation:
+    description: Contextual Information of the channel in managed content delivery
+      api
+    type: object
+    properties:
+      id:
+        description: Id of the Managed Content Channel
+        type: string
+      name:
+        description: Name of the managed content channel
+        type: string
+      type:
+        description: Type of Managed Content Channel
+        type: string
+        enum:
+          - CloudToCloud
+          - Community
+          - ConnectedApp
+          - PublicUnauthenticated
+          - UserPermission
+      url:
+        description: URL to the single channel management API that can read detailed
+          information of a channel, update or delete it
+        type: string
+  ManagedContentUserSummaryRepresentation:
+    description: Information about a user who created/modified content.
+    type: object
+    properties:
+      id:
+        description: The id of the user.
+        type: string
+      name:
+        description: The name of the user.
+        type: string
+      resourceUrl:
+        description: The connect endpoint resourceUrl of the user to get more information
+          about the user.
+        type: string
+  ManagedContentSpaceChannelsInputRepresentation:
+    description: The input representation for a Managed Content space Channels
+    type: object
+    properties:
+      spaceChannels:
+        description: List of Managed Content Space Channels to be added or removed
+          from the workspace
+        type: array
+        items:
+          type: ManagedContentSpaceChannelsInputList
+  ManagedContentSpaceChannelsInputList:
+    description: ManagedContentSpaceChannelInputRepresentation list input representation
+      wrapper.
+    type: object
+    properties:
+      mcSpaceChannelInput:
+        description: Managed Content Space Channels list to be added or removed from
+          the workspace.
+        type: array
+        items:
+          type: ManagedContentSpaceChannelInputRepresentation
+  ManagedContentSpaceChannelInputRepresentation:
+    description: The input representation for a Managed Content Space Channel
+    type: object
+    properties:
+      channelId:
+        description: Id of the Managed Content Channel
+        type: string
+      operation:
+        description: Operation to perform for Managed Content Channel
+        type: string
+        enum:
+          - Add
+          - Remove
+
+/connect:
+  /cms:
+    /spaces/{contentSpaceId}:
+      /channels:
+        get:
+          displayName: getManagedContentSpaceChannels
+          description: Get a space channels for a specific ManagedContentSpace record.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentSpaceChannelsRepresentation
+          queryParameters:
+            page:
+              type: integer
+              required: false
+            pageSize:
+              type: integer
+              required: false
+        patch:
+          displayName: patchManagedContentSpaceChannels
+          description: Update space channels for a specific ManagedContentSpace
+            record.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ManagedContentSpaceChannelsRepresentation
+          body:
+            application/json:
+              type: ManagedContentSpaceChannelsInputRepresentation
+              (oas-body-name): spaceChannels
+        uriParameters:
+          contentSpaceId:
+            type: string
+            required: true

package/src/raml/luvio.raml

@@ -0,0 +1,27 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'CmsManagement'
+
+types:
+  ManagedContentSpaceChannelsRepresentation:
+    (luvio.ttl): 30000
+  ManagedContentSpaceChannelRepresentation:
+    (luvio.ttl): 30000
+  ManagedContentChannelSummaryRepresentation:
+    (luvio.ttl): 30000
+    (luvio.key):
+      channelId: id
+
+/connect/cms/spaces/{contentSpaceId}/channels:
+  get:
+    (luvio.adapter):
+      name: getManagedContentSpaceChannels
+    responses:
+      200:
+        body:
+          application/json:
+            type: ManagedContentSpaceChannelsRepresentation