@salesforce/lds-adapters-cms-authoring 0.131.0

package/src/raml/luvio.raml

@@ -0,0 +1,607 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'CMSAuthoring'
+
+types:
+  ManagedContentDeploymentRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: deploymentId
+  ManagedContentVariantRepresentation:
+    (luvio.ttl): 3600000
+    (luvio.opaque): true
+    (luvio.key):
+      id: managedContentVariantId
+  ManagedContentDocumentRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      content_key: contentKey
+      language: language
+      version: version
+  ManagedContentSpaceFolderItemCollectionRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+  ManagedContentTranslationV2Representation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  ManagedContentUnpublishOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      id: deploymentId
+  ManagedContentPublishOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      id: deploymentId
+  ManagedContentReferencedByCollectionRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+  ManagedContentVariantReferencesCollectionRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+  ManagedContentCollectionDetailRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      collection_key: collectionKey
+      language: language
+      version: versionNumber
+  ManagedContentSearchResultItemsCollectionRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+  ManagedContentVariantVersionCollectionRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      variantId: managedContentVariantId
+  ManagedContentV2JobRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  ManagedContentSpaceCollectionRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+  ManagedContentRenditionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  ManagedContentSpaceRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+
+/cms:
+  /deployments:
+    post:
+      (luvio.adapter):
+        name: createDeployment
+        tests:
+          validConfigs:
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                      "0apx0000000GmanAAC"
+                    ],
+                  "description": "Test Description",
+                  "contentIds":
+                    [
+                      "20Yxx0000011VYAEA2"
+                    ],
+                  "executeStagedDeployments": false,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z"
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                      "0apx0000000GmanAAC"
+                    ],
+                  "description": "Test Description",
+                  "contentIds":
+                    [
+                      "20Yxx0000011VYAEA2"
+                    ],
+                  "executeStagedDeployments": false,
+                  "includeContentReferences": true,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z"
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                    ],
+                  "description": "Test Description",
+                  "contentIds":
+                    [
+                      "20Yxx0000011VYAEA2"
+                    ],
+                  "executeStagedDeployments": false,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z"
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                    ],
+                  "description": "Test Description",
+                  "contentIds":
+                    [
+                      "20Yxx0000011VYAEA2"
+                    ],
+                  "executeStagedDeployments": false,
+                  "includeContentReferences": true,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z"
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                      "20Yxx0000011VYAEA2"
+                    ],
+                  "description": "Test Description",
+                  "executeStagedDeployments": false,
+                  "includeContentReferences": true,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z",
+                  "variantIds":
+                    [
+                      "9Psxx0000004DwKCAU"
+                    ]
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                    ],
+                  "description": "Test Description",
+                  "executeStagedDeployments": false,
+                  "includeContentReferences": true,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z",
+                  "variantIds":
+                    [
+                      "9Psxx0000004DwKCAU"
+                    ]
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS",
+                  "channelIds":
+                    [
+                    ],
+                  "description": "Test Description",
+                  "contentIds":
+                    [
+                    ],
+                  "executeStagedDeployments": false,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z"
+                }
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "contentSpaceId": "0Zux0000000KykTCAS"
+                }
+              }
+          invalidConfigs:
+            - |
+              {
+                "contentSpaceId": "0Zux0000000KykTCAS"
+              }
+            - |
+              { "contentSpaceId": "0Zux0000000KykTCAS",
+                "channelIds":
+                  [
+                    "0apx0000000GmanAAC"
+                  ],
+                "description": "Test Description",
+                "contentIds":
+                  [
+                    "20Yxx0000011VYAEA2"
+                  ],
+                "executeStagedDeployments": false,
+                "scheduledDate": "2021-03-23T17:14:00.000Z"
+              }
+            - |
+              { "DeploymentInput":
+                {
+                  "channelIds":
+                    [
+                      "0apx0000000GmanAAC"
+                    ],
+                  "description": "Test Description",
+                  "contentIds":
+                    [
+                      "20Yxx0000011VYAEA2"
+                    ],
+                  "executeStagedDeployments": false,
+                  "scheduledDate": "2021-03-23T17:14:00.000Z"
+                }
+              }
+/connect:
+  /cms:
+    /content/spaces/{contentSpaceId}:
+      /translation:
+        post:
+          (luvio.adapter):
+            name: createTranslationV2Job
+    /contents:
+      post:
+        (luvio.adapter):
+          name: createManagedContent
+          tests:
+            validConfigs:
+              - |
+                {
+                  "ManagedContentInputParam": {
+                      "contentSpaceOrFolderId":"0Zuxx00000001DpCAI",
+                      "contentType":"news",
+                      "title":"hello authoring 2.0",
+                      "urlName":"testurl",
+                      "contentBody":{
+                        "title": "hello authoring 2.0",
+                        "body":"test body",
+                        "excerpt":"test excerpt"
+                      }
+                  }
+                }
+            invalidConfigs:
+              - |
+                {
+                      "contentSpaceOrFolderId":"0Zuxx00000001DpCAI",
+                      "contentType":"news",
+                      "title":"hello authoring 2.0",
+                      "urlName":"testurl",
+                      "contentBody":{
+                        "title": "hello authoring 2.0",
+                        "body":"test body",
+                        "excerpt":"test excerpt"
+                      }
+                }
+              - |
+                {
+                  "ManagedContentInputParam": {
+                      "contentSpaceOrFolderId":"0Zuxx00000001DpCAI"
+                  }
+                }
+              - |
+                {
+                  "ManagedContentInputParam": {
+                      "contentType":"news",
+                      "title":"hello authoring 2.0",
+                      "urlName":"testurl",
+                      "contentBody":{
+                        "title": "hello authoring 2.0",
+                        "body":"test body",
+                        "excerpt":"test excerpt"
+                      }
+                  }
+                }
+              - |
+                {
+                  "ManagedContentInputParam": {
+                      "contentSpaceOrFolderId":"0Zuxx00000001DpCAI",
+                      "title":"hello authoring 2.0",
+                      "urlName":"testurl",
+                      "contentBody":{
+                        "title": "hello authoring 2.0",
+                        "body":"test body",
+                        "excerpt":"test excerpt"
+                      }
+                  }
+                }
+              - |
+                {
+                  "ManagedContentInputParam": {
+                      "contentSpaceOrFolderId":"0Zuxx00000001DpCAI",
+                      "contentType":"news",
+                      "urlName":"testurl",
+                      "contentBody":{
+                        "title": "hello authoring 2.0",
+                        "body":"test body",
+                        "excerpt":"test excerpt"
+                      }
+                  }
+                }
+              - |
+                {
+                  "ManagedContentInputParam": {
+                      "contentSpaceOrFolderId":"0Zuxx00000001DpCAI",
+                      "contentType":"news",
+                      "title":"hello authoring 2.0",
+                      "urlName":"testurl"
+                  }
+                }
+      /{contentKeyOrId}:
+        get:
+          (luvio.adapter):
+            name: getManagedContent
+          (luvio.key):
+            content_key: urlParams.contentKeyOrId
+            language: queryParams.language || ''
+            version: queryParams.version || ''
+        /renditions/{renditionType}:
+          get:
+            (luvio.adapter):
+              name: getManagedContentVariantRendition
+      /{contentKeyOrId}/referenced-by:
+        get:
+          (luvio.adapter):
+            name: getManagedContentReferencedBy
+      /{contentKeyOrId}/variants/references:
+        get:
+          (luvio.adapter):
+            name: getManagedContentVariantReferences
+      /variants:
+        post:
+          (luvio.adapter):
+            name: createManagedContentVariant
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "managedContentKeyOrId": "20YRM0000000CPi2AM",
+                      "language": "fr",
+                      "title":"French variant",
+                      "urlName":"french-variant",
+                      "contentBody":{
+                        "title": "French title",
+                        "body":"french body"
+                      }
+                    }
+                  }
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "managedContentKeyOrId": "20YRM0000000CPi2AM",
+                      "language": "fr",
+                      "title":"French variant",
+                      "contentBody":{
+                        "title": "French title",
+                        "body":"french body"
+                      }
+                    }
+                  }
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "managedContentKeyOrId": "20YRM0000000CPi2AM",
+                      "language": "fr",
+                      "urlName":"french-variant",
+                      "contentBody":{
+                        "title": "French title",
+                        "body":"french body"
+                      }
+                    }
+                  }
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "managedContentKeyOrId": "20YRM0000000CPi2AM",
+                      "language": "fr",
+                      "contentBody":{
+                        "title": "French title",
+                        "body":"french body"
+                      }
+                    }
+                  }
+              invalidConfigs:
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "managedContentKeyOrId": "20YRM0000000CPi2AM",
+                      "title":"French variant",
+                      "urlName":"french-variant",
+                      "contentBody":{
+                        "title": "French title",
+                        "body":"french body"
+                      }
+                    }
+                  }
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "language": "fr",
+                      "title":"French variant",
+                      "urlName":"french-variant",
+                      "contentBody":{
+                        "title": "French title",
+                        "body":"french body"
+                      }
+                    }
+                  }
+                - |
+                  {
+                    "managedContentVariantInputParam": {
+                      "managedContentKeyOrId": "20YRM0000000CPi2AM",
+                      "language": "fr",
+                      "title":"French variant",
+                      "urlName":"french-variant"
+                    }
+                  }
+      /variants/{variantId}:
+        delete:
+          (luvio.adapter):
+            name: deleteManagedContentVariant
+          (luvio.key):
+            id: urlParams.variantId
+        get:
+          (luvio.adapter):
+            name: getManagedContentVariant
+          (luvio.key):
+            id: urlParams.variantId
+        put:
+          (luvio.adapter):
+            name: replaceManagedContentVariant
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "variantId": "9Psxx0000004DwKCAU",
+                    "ManagedContentVariantInputParam": {
+                        "title":"hello authoring 2.0",
+                        "urlName":"testurl",
+                        "contentBody":{
+                          "title": "hello authoring 2.0",
+                          "body":"test body",
+                          "excerpt":"test excerpt"
+                        }
+                    }
+                  }
+              invalidConfigs:
+                - |
+                  {
+                    "ManagedContentVariantInputParam": {
+                          "title":"hello authoring 2.0",
+                          "urlName":"testurl",
+                          "contentBody":{
+                            "title": "hello authoring 2.0",
+                            "body":"test body",
+                            "excerpt":"test excerpt"
+                          }
+                    }
+                  }
+                - |
+                  {
+                    "variantId": "9Psxx0000004DwKCAU"
+                  }
+                - |
+                  {
+                    "variantId": "9Psxx0000004DwKCAU",
+                    "ManagedContentVariantInputParam": {
+                        "title":"hello authoring 2.0",
+                        "urlName":"testurl"
+                    }
+                  }
+      /variants/{variantId}/versions:
+        get:
+          (luvio.adapter):
+            name: getManagedContentVariantVersions
+          (luvio.key):
+            variantId: urlParams.variantId
+      /unpublish:
+        post:
+          (luvio.adapter):
+            name: unpublishManagedContent
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "unpublishInput": {
+                      "description": "Test Description",
+                      "contentIds": ["20YRM0000000CPi2AM", "20YRM0000000CPi2AN"],
+                      "variantIds": []
+                    }
+                  }
+                - |
+                  {
+                    "unpublishInput": {
+                      "description": "Test Description",
+                      "contentIds": [],
+                      "variantIds": ["9Psxx0000004DwKCAU", "9Psxx0000004DwKCAV"]
+                    }
+                  }
+              invalidConfigs:
+                - |
+                  {
+                    "description": "Test Description",
+                    "contentIds": ["20YRM0000000CPi2AM"],
+                    "variantIds": ["9Psxx0000004DwKCAU"]
+                  }
+      /publish:
+        post:
+          (luvio.adapter):
+            name: publishManagedContent
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "publishInput": {
+                      "description": "Test Description",
+                      "contentIds": ["20YRM0000000CPi2AM", "20YRM0000000CPi2AN"],
+                      "includeContentReferences": true,
+                      "variantIds": []
+                    }
+                  }
+                - |
+                  {
+                    "publishInput": {
+                      "description": "Test Description",
+                      "contentIds": [],
+                      "variantIds": ["9Psxx0000004DwKCAU", "9Psxx0000004DwKCAV"]
+                    }
+                  }
+              invalidConfigs:
+                - |
+                  {
+                    "description": "Test Description",
+                    "contentIds": ["20YRM0000000CPi2AM"],
+                    "variantIds": ["9Psxx0000004DwKCAU"]
+                  }
+    /folders/{folderId}/items:
+      get:
+        (luvio.adapter):
+          name: getManagedContentByFolderId
+    /collections/{collectionKeyOrId}:
+      get:
+        (luvio.adapter):
+          name: getCollectionItems
+        (luvio.key):
+          collection_key: urlParams.collectionKeyOrId
+          language: queryParams.language || ''
+          version: queryParams.version || ''
+    /items/search:
+      get:
+        (luvio.adapter):
+          name: getSearchResults
+    /spaces:
+      get:
+        (luvio.adapter):
+          name: getManagedContentSpaces
+      /{contentSpaceId}/contents:
+        /export:
+          post:
+            (luvio.adapter):
+              name: createManagedContentExportV2Job
+        /import:
+          post:
+            (luvio.adapter):
+              name: createManagedContentImportV2Job
+    /spaces/{contentSpaceId}:
+      get:
+        (luvio.adapter):
+          name: getManagedContentSpace
+        (luvio.key):
+          id: urlParams.contentSpaceId
+      patch:
+        (luvio.adapter):
+          name: patchManagedContentSpace