@salesforce/lds-adapters-industries-context 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,505 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'IndustriesContext'
+(luvio.ttl): 60000
+
+types:
+  ContextDefinitionInfoRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextDefinitionId
+  ContextDefinitionListRepresentation:
+    (luvio.ttl): 1000
+  ContextDefinitionUpgradeListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextDefinitionListId
+  ContextServiceAccessRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      id: uniqueIdentifier
+  ContextAttributeTagListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  ContextDefinitionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextDefinitionId
+  ContextInfoRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: contextId
+  ContextDefinitionVersionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: contextDefinitionVersionId
+  ContextAttrHydrationDetailRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: contextAttrHydrationDetailId
+  ContextMappingRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextMappingId
+  ContextNodeRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: contextNodeId
+  ContextAttributeRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextAttributeId
+  ContextAttributeTagRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextTagId
+  ContextAttributeMappingRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextAttributeMappingId
+  ContextNodeMappingRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextNodeMappingId
+  ContextAttributeListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextAttributeListId
+  ContextAttributeMappingListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextAttributeMappingListId
+  QueryContextRecordResultRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextId
+  ContextNodeListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextNodeListId
+  ContextTagListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextDefinitionId
+  ContextMappingListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextMappingListId
+  ContextNodeMappingListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextNodeMappingListId
+  QueryRecordsResultRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextQueryRecordListId
+  ContextTranslationServiceRecordRepresentation:
+    (luvio.ttl): 1000
+  DynamicAttributeSearchResultRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      id: dynamicAttributeSearchResultId
+  ContextDefinitionFilterListRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextDefinitionId
+  ContextDefinitionFilterRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: contextDefinitionFilterId
+
+/connect:
+  /context:
+    /queryrecord:
+      post:
+        (luvio.adapter):
+          name: queryContextRecordAndChildren
+        queryParameters:
+          children:
+            type: boolean
+            default: false
+  /context/{contextId}:
+    get:
+      (luvio.adapter):
+        name: getContext
+      (luvio.key):
+        id: urlParams.contextId
+  /context-definitions:
+    get:
+      (luvio.adapter):
+        name: getContextDefinitions
+      queryParameters:
+        includeInactive:
+          type: boolean
+          required: false
+        includeUpgrade:
+          type: boolean
+          required: false
+    post:
+      (luvio.adapter):
+        name: createContextServiceDefinition
+    /info/{contextDefinitionId}:
+      get:
+        (luvio.adapter):
+          name: getContextServiceDefinitionInfo
+        (luvio.key):
+          id: urlParams.contextDefinitionId
+    /upgrades:
+      patch:
+        (luvio.adapter):
+          name: upgradeContextServiceDefinition
+    /{contextDefinitionId}:
+      delete:
+        (luvio.adapter):
+          name: deleteContextServiceDefinition
+        (luvio.key):
+          id: urlParams.contextDefinitionId
+      get:
+        (luvio.adapter):
+          name: getContextServiceDefinition
+        (luvio.key):
+          id: urlParams.contextDefinitionId
+      patch:
+        (luvio.adapter):
+          name: updateContextServiceDefinition
+      uriParameters:
+        contextDefinitionId:
+      /context-filters:
+        get:
+          (luvio.adapter):
+            name: getContextFilters
+          (luvio.key):
+            id: urlParams.contextDefinitionId
+        post:
+          (luvio.adapter):
+            name: createContextFilters
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+      /context-filters/{contextDefinitionFilterId}:
+        get:
+          (luvio.adapter):
+            name: getContextFilter
+          (luvio.key):
+            id: urlParams.contextDefinitionFilterId
+        patch:
+          (luvio.adapter):
+            name: updateContextFilter
+        delete:
+          (luvio.adapter):
+            name: deleteContextFilter
+          (luvio.key):
+            id: urlParams.contextDefinitionFilterId
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+          contextDefinitionFilterId:
+            description: Unique ID to represent a Context Definition Filter
+            type: string
+            required: true
+      /context-mappings:
+        patch:
+          (luvio.adapter):
+            name: updateContextMappings
+        post:
+          (luvio.adapter):
+            name: createContextMappings
+        uriParameters:
+          contextDefinitionId:
+      /context-mappings/{contextMappingId}:
+        delete:
+          (luvio.adapter):
+            name: deleteContextServiceMapping
+          (luvio.key):
+            id: urlParams.contextMappingId
+        get:
+          (luvio.adapter):
+            name: getContextServiceMapping
+          (luvio.key):
+            id: urlParams.contextMappingId
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+          contextMappingId:
+            description: Unique ID to represent a Context Mapping
+            type: string
+            required: true
+      /context-nodes:
+        patch:
+          (luvio.adapter):
+            name: updateContextNodes
+        post:
+          (luvio.adapter):
+            name: createContextNodes
+        uriParameters:
+          contextDefinitionId:
+      /context-nodes/{contextNodeId}:
+        delete:
+          (luvio.adapter):
+            name: deleteContextServiceNode
+          (luvio.key):
+            id: urlParams.contextNodeId
+        get:
+          (luvio.adapter):
+            name: getContextServiceNode
+          (luvio.key):
+            id: urlParams.contextNodeId
+        uriParameters:
+          contextDefinitionId:
+          contextNodeId:
+      /dynamic-attributes:
+        get:
+          (luvio.adapter):
+            name: getDynamicAttributes
+          (luvio.key):
+            id: urlParams.contextDefinitionId
+      /context-tags:
+        get:
+          (luvio.adapter):
+            name: getContextTags
+          (luvio.key):
+            id: urlParams.contextDefinitionId
+          queryParameters:
+            includeReferencedDefinitionTags:
+              type: boolean
+              required: false
+              default: false
+        patch:
+          (luvio.adapter):
+            name: updateContextTags
+        post:
+          (luvio.adapter):
+            name: createContextTags
+        uriParameters:
+          contextDefinitionId:
+      /context-tags/{contextTagId}:
+        delete:
+          (luvio.adapter):
+            name: deleteContextServiceTag
+          (luvio.key):
+            id: urlParams.contextTagId
+        get:
+          (luvio.adapter):
+            name: getContextServiceTag
+          (luvio.key):
+            id: urlParams.contextTagId
+        uriParameters:
+          contextTagId:
+            description: Unique ID to represent a Context Tag
+            type: string
+            required: true
+  /context-mappings/{contextMappingId}/context-node-mappings:
+    patch:
+      (luvio.adapter):
+        name: updateContextNodeMappings
+    post:
+      (luvio.adapter):
+        name: createContextNodeMappings
+    uriParameters:
+      contextMappingId:
+  /context-mappings/clone:
+    post:
+      (luvio.adapter):
+        name: cloneContextMappings
+  /context-mappings/{contextMappingId}/context-node-mappings/{contextNodeMappingId}:
+    get:
+      (luvio.adapter):
+        name: getContextServiceNodeMapping
+      (luvio.key):
+        id: urlParams.contextNodeMappingId
+    delete:
+      (luvio.adapter):
+        name: deleteContextServiceNodeMapping
+      (luvio.key):
+        id: urlParams.contextNodeMappingId
+    uriParameters:
+      contextNodeMappingId:
+        type: string
+        required: true
+      contextMappingId:
+        type: string
+        required: true
+  /context-node-mappings/{contextNodeMappingId}/context-attribute-mappings:
+    patch:
+      (luvio.adapter):
+        name: updateContextAttributeMappings
+    post:
+      (luvio.adapter):
+        name: createContextAttributeMappings
+    uriParameters:
+      contextNodeMappingId:
+  /context-node-mappings/{contextNodeMappingId}/context-attribute-mappings/{contextAttributeMappingId}:
+    delete:
+      (luvio.adapter):
+        name: deleteContextServiceAttributeMapping
+      (luvio.key):
+        id: urlParams.contextAttributeMappingId
+    get:
+      (luvio.adapter):
+        name: getContextServiceAttributeMapping
+      (luvio.key):
+        id: urlParams.contextAttributeMappingId
+    uriParameters:
+      contextAttributeMappingId:
+      contextNodeMappingId:
+  /context-nodes/{contextNodeId}/context-attributes:
+    patch:
+      (luvio.adapter):
+        name: updateContextAttributes
+    post:
+      (luvio.adapter):
+        name: createContextAttributes
+    uriParameters:
+      contextNodeId:
+  /context-nodes/{contextNodeId}/context-attributes/{contextAttributeId}:
+    delete:
+      (luvio.adapter):
+        name: deleteContextServiceAttribute
+      (luvio.key):
+        id: urlParams.contextAttributeId
+    get:
+      (luvio.adapter):
+        name: getContextServiceAttribute
+      (luvio.key):
+        id: urlParams.contextAttributeId
+    uriParameters:
+      contextAttributeId:
+      contextNodeId:
+  /contextmapping:
+    post:
+      (luvio.adapter):
+        name: createContextMapping
+    /{contextMappingId}:
+      delete:
+        (luvio.adapter):
+          name: deleteContextMapping
+        (luvio.key):
+          id: urlParams.contextMappingId
+      get:
+        (luvio.adapter):
+          name: getContextMapping
+        (luvio.key):
+          id: urlParams.contextMappingId
+      patch:
+        (luvio.adapter):
+          name: updateContextMapping
+      uriParameters:
+        contextMappingId:
+    /attributenode:
+      post:
+        (luvio.adapter):
+          name: createContextAttributeMapping
+    /attributenode/{contextAttributeMappingId}:
+      delete:
+        (luvio.adapter):
+          name: deleteContextAttributeMapping
+        (luvio.key):
+          id: urlParams.contextAttributeMappingId
+      get:
+        (luvio.adapter):
+          name: getContextAttributeMapping
+        (luvio.key):
+          id: urlParams.contextAttributeMappingId
+      patch:
+        (luvio.adapter):
+          name: updateContextAttributeMapping
+      uriParameters:
+        contextAttributeMappingId:
+    /node:
+      post:
+        (luvio.adapter):
+          name: createContextNodeMapping
+    /node/{contextNodeMappingId}:
+      delete:
+        (luvio.adapter):
+          name: deleteContextNodeMapping
+        (luvio.key):
+          id: urlParams.contextNodeMappingId
+      get:
+        (luvio.adapter):
+          name: getContextNodeMapping
+        (luvio.key):
+          id: urlParams.contextNodeMappingId
+      patch:
+        (luvio.adapter):
+          name: updateContextNodeMapping
+      uriParameters:
+        contextNodeMappingId:
+  /contexts:
+    /query-records:
+      post:
+        (luvio.adapter):
+          name: createContextQueryRecords
+    /{contextId}:
+      get:
+        (luvio.adapter):
+          name: getContextInfo
+        (luvio.key):
+          id: urlParams.contextId
+      delete:
+        (luvio.adapter):
+          name: deleteContext
+        (luvio.key):
+          id: urlParams.contextId
+      uriParameters:
+        contextId:
+          description: Unique ID to represent a Context
+          type: string
+          required: true
+    /{contextId}/context-mappings/{contextMappingId}/translate:
+      get:
+        (luvio.adapter):
+          name: getContextTranslation
+        queryParameters:
+          isDependenciesEstablished:
+            type: boolean
+            required: false
+          removeRestrictedFields:
+            type: boolean
+            required: false
+          persistAttibuteTypes:
+            type: array
+            required: false
+            default:
+              - OUTPUT
+              - INPUTOUTPUT
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      uriParameters:
+        contextId:
+          type: string
+          required: true
+        contextMappingId:
+          type: string
+          required: true
+  /contextservice/access/{preferenceName}/{uniqueIdentifier}:
+    get:
+      (luvio.adapter):
+        name: getContextServiceAccess
+      (luvio.key):
+        id: urlParams.preferenceName
+    put:
+      (luvio.adapter):
+        name: putContextServiceAccess
+    uriParameters:
+      preferenceName:
+        type: string
+        required: true
+      uniqueIdentifier:
+        type: string
+        required: true