@salesforce/lds-adapters-cdp-metadata 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,288 @@
+#%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:
+  CdpQueryMetadataOutputRepresentation:
+    description: Represents Cdp Query Metadata Output
+    type: object
+    properties:
+      metadata:
+        description: Result metadata set
+        type: array
+        items:
+          type: any # TODO hand rolled. W-15573704
+  CdpDgMetadataRepresentation:
+    description: Represents Cdp DataGraph Metadata output
+    type: object
+    properties:
+      dataGraphMetadata:
+        description: DataGraph Metadata
+        type: array
+        items:
+          type: CdpQueryDataGraphMetadataRepresentation
+  CdpQueryDataGraphMetadataRepresentation:
+    description: Represents Cdp DataGraph Metadata output
+    type: object
+    properties:
+      dataspaceName:
+        description: DataGraphMetadata dataspaceName
+        type: string
+      description:
+        description: DataGraphMetadata description
+        type: string
+      developerName:
+        description: DataGraphMetadata name
+        type: string
+      dgObject:
+        description: DataGraphMetadata dgObject
+        type: DataGraphObjectDataRepresentation
+      extendedProperties:
+        description: DataGraphMetadata extendedProperties
+        type: object
+        required: false
+      idDmoName:
+        description: DataGraphMetadata idDmoName
+        type: string
+      idsDmo:
+        description: DataGraphMetadata idsDmo
+        type: DataGraphIdsDmoRepresentation
+      primaryObjectName:
+        description: DataGraphMetadata primaryObjectName
+        type: string
+      primaryObjectType:
+        description: DataGraphMetadata primaryObjectType
+        type: string
+      status:
+        description: DataGraphMetadata status
+        type: string
+      valuesDmo:
+        description: DataGraphMetadata valuesDmo
+        type: DataGraphValuesDmoRepresentation
+      valuesDmoName:
+        description: DataGraphMetadata valuesDmoName
+        type: string
+      version:
+        description: DataGraphMetadata version
+        type: string
+  DataGraphFieldRepresentation:
+    description: Represents DataGraphFields
+    type: object
+    properties:
+      ciFieldType:
+        description: DataGraphField ciFieldType
+        type: string
+        required: false
+      dataGraphFieldDevName:
+        description: DataGraphField fieldDevName
+        type: string
+      dataType:
+        description: DataGraphField dataType
+        type: string
+      developerName:
+        description: DataGraphField developerName
+        type: string
+      isProjected:
+        description: DataGraphField isProjected
+        type: string
+      keyCol:
+        description: DataGraphField keyCol
+        type: string
+      keyQualifierName:
+        description: DataGraphField keyQualifierName
+        type: string
+      length:
+        description: DataGraphField length
+        type: string
+      lookupCol:
+        description: DataGraphField lookupCol
+        type: string
+      usageTag:
+        description: DataGraphField usageTag
+        type: string
+  DataGraphIdsDmoRepresentation:
+    description: Represents DataGraphIdsDmo data
+    type: object
+    properties:
+      developerName:
+        description: DataGraphIdsDmo developerName
+        type: string
+      fields:
+        description: DataGraphIdsDmo fields
+        type: array
+        items:
+          type: DataGraphIdsDmoFieldRepresentation
+  DataGraphIdsDmoFieldRepresentation:
+    description: Represents DataGraphIdsDmoField data
+    type: object
+    properties:
+      capabilities:
+        description: DataGraphIdsDmoField capabilities
+        type: array
+        items:
+          type: integer
+      dataType:
+        description: DataGraphIdsDmoField dataType
+        type: string
+      developerName:
+        description: DataGraphIdsDmoField developerName
+        type: string
+  DataGraphObjectDataRepresentation:
+    description: Represents DataGraphObject data
+    type: object
+    properties:
+      dataGraphSourceDevName:
+        description: DataObject sourceDevName
+        type: string
+      developerName:
+        description: DataObject data developerName
+        type: string
+      fields:
+        description: DataObject data fields
+        type: array
+        items:
+          type: DataGraphFieldRepresentation
+      filterCriteria:
+        description: DataObject data filterCriteria
+        type: string
+      memberDmoName:
+        description: DataObject data memberDmoName
+        type: string
+      paths:
+        description: DataObject data paths
+        type: array
+        items:
+          type: DataGraphRelationshipRepresentation
+      recencyCriteria:
+        description: DataObject data recencyCriteria
+        type: array
+        items:
+          type: RecencyCriteriaRepresentation
+      relatedObjects:
+        description: Data Lake data relatedObjects
+        type: array
+        items:
+          type: any
+      type:
+        description: DataObject data type
+        type: string
+  DataGraphRelationshipRepresentation:
+    description: Represents DataGraphRelationship
+    type: object
+    properties:
+      cardinality:
+        description: DataGraphRelationship cardinality
+        type: string
+      fieldName:
+        description: DataGraphRelationship fieldName
+        type: string
+      parentFieldName:
+        description: DataGraphRelationship parentFieldName
+        type: string
+  DataGraphValuesDmoFieldRepresentation:
+    description: Represents DataGraphValuesDmoField data
+    type: object
+    properties:
+      capabilities:
+        description: DataGraphValuesDmoField capabilities
+        type: array
+        items:
+          type: integer
+      dataType:
+        description: DataGraphValuesDmoField dataType
+        type: string
+      developerName:
+        description: DataGraphValuesDmoField developerName
+        type: string
+  DataGraphValuesDmoRepresentation:
+    description: Represents DataGraphValuesDmo data
+    type: object
+    properties:
+      developerName:
+        description: DataGraphValuesDmo developerName
+        type: string
+      fields:
+        description: DataGraphValuesDmo fields
+        type: array
+        items:
+          type: DataGraphValuesDmoFieldRepresentation
+  RecencyCriteriaRepresentation:
+    description: Represents RecencyCriteria data
+    type: object
+    properties:
+      fieldName:
+        description: RecencyCriteria fieldName
+        type: string
+      value:
+        description: RecencyCriteria value
+        type: string
+      valueType:
+        description: RecencyCriteria valueType
+        type: string
+      valueUnit:
+        description: RecencyCriteria valueUnit
+        type: string
+
+/ssot:
+  /metadata:
+    get:
+      displayName: getCdpMetadataQuery
+      description: Query MetaData API
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpQueryMetadataOutputRepresentation
+      queryParameters:
+        dataspace:
+          type: string
+          required: false
+        entityCategory:
+          type: string
+          required: false
+        entityName:
+          type: string
+          required: false
+        entityType:
+          type: string
+          required: false
+  /data-graphs/metadata:
+    get:
+      displayName: getCdpDataGraphMetadataQuery
+      description: Query Datagraph MetaData
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDgMetadataRepresentation
+      queryParameters:
+        dataGraphEntityName:
+          type: string
+          required: false
+        dataspace:
+          type: string
+          required: false

package/src/raml/luvio.raml

@@ -0,0 +1,24 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'cdp-metadata'
+(luvio.ttl): 3000000
+
+types:
+  CdpDgMetadataRepresentation:
+    (luvio.opaque): true
+  CdpQueryMetadataOutputRepresentation:
+    (luvio.opaque): true
+
+/ssot:
+  /metadata:
+    get:
+      (luvio.adapter):
+        name: getAllMetadata
+  /data-graphs/metadata:
+    get:
+      (luvio.adapter):
+        name: getDataGraphMetadata