@salesforce/lds-adapters-platform-external-services 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,615 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.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:
+  ApiInfoRepresentation:
+    description: Information about an available API.
+    type: object
+    properties:
+      description:
+        description: Description of this API
+        type: string
+      id:
+        description: Unique identifier for this API
+        type: string
+      name:
+        description: Name of this API
+        type: string
+      version:
+        description: Version of this API
+        type: string
+  ApiListRepresentation:
+    description: A list of available APIs.
+    type: object
+    properties:
+      apis:
+        description: List of available APIs
+        type: array
+        items:
+          type: ApiInfoRepresentation
+  ApiSchemaRepresentation:
+    description: The schema for an API.
+    type: object
+    properties:
+      schemaContents:
+        description: Schema document contents
+        type: string
+  DataShapeInferenceOutputRepresentation:
+    description: Represents inferred data shape
+    type: object
+    properties:
+      errorMessages:
+        description: Error messages
+        type: array
+        items:
+          type: InferenceErrorMessageRepresentation
+      example?:
+        description: Example of the inferred field
+        type: string
+      items:
+        description: Items of the inferred array field
+        type: array
+        items:
+          type: DataShapeInferenceOutputRepresentation
+      properties:
+        description: Properties of the inferred schema
+        type: object
+        properties:
+          //:
+            type: DataShapeInferenceOutputRepresentation
+      success:
+        description: Status of the inferring
+        type: boolean
+      type?:
+        description: Data type of the inferred field
+        type: string
+  ExternalServiceSchemaRequestRepresentation:
+    description: Results of an external service schema request
+    type: object
+    properties:
+      error:
+        description: Error encountered if any
+        type: string
+      serviceSchema:
+        description: Raw service schema retrieved using named credentials
+        type: string
+  ExternalServiceStatisticsBreakdownRepresentation:
+    description: External Services statistics breakdown results for a Service / Operation
+      component
+    type: object
+    properties:
+      active:
+        description: Is the parent component active
+        type: boolean
+      activeCount:
+        description: The active count of the component
+        type: integer
+      component:
+        description: The name of the parent component
+        type: string
+      componentType:
+        description: The type of the parent component
+        type: string
+      statisticFor:
+        description: The component type of this statistics for
+        type: string
+      totalCount:
+        description: The total count of the component
+        type: integer
+  ExternalServiceStatisticsForServiceRepresentation:
+    description: External Services statistics results for a Service component
+    type: object
+    properties:
+      schemaSize:
+        description: The size of the schema
+        type: integer
+      schemaType:
+        description: The type of the schema
+        type: string
+        enum:
+          - OpenApi
+          - OpenApi3
+      serviceName:
+        description: The External Service registration name
+        type: string
+      statistics:
+        description: The statistics of the children components of this service
+        type: array
+        items:
+          type: ExternalServiceStatisticsBreakdownRepresentation
+      systemVersion:
+        description: The system version of the service registration
+        type: integer
+  ExternalServiceActionOutputRepresentation:
+    description: Represents the Ext Service Action Details
+    type: object
+    properties:
+      externalServicePath:
+        description: The path for the external services edit page
+        type: string
+      method:
+        description: Http Method type of the service
+        type: string
+      parameters:
+        description: Path/query parameters details of the service
+        type: array
+        items:
+          type: ExternalServiceActionParameterRepresentation
+      path:
+        description: Url Path used by the service
+        type: string
+      registrationName:
+        description: Registration name of the action service.
+        type: string
+  ExternalServiceActionParameterRepresentation:
+    description: Input Parameter details of the external service
+    type: object
+    properties:
+      description:
+        description: Description of the parameter
+        type: string
+      location:
+        description: Type of Parameter i.e. Path/Query
+        type: string
+      name:
+        description: Name of the Parameter
+        type: string
+      required:
+        description: Is the parameter a required field
+        type: boolean
+  ExternalServiceStatisticsOutputRepresentation:
+    description: External Services statistics results for a single service or overview
+      of all services
+    type: object
+    properties:
+      serviceCount:
+        description: Number of external service registrations
+        type: integer
+      services:
+        description: List of the services statistics breakdown
+        type: array
+        items:
+          type: ExternalServiceStatisticsForServiceRepresentation
+      statistics:
+        description: Count statistics overview for operation and object components
+        type: array
+        items:
+          type: ExternalServiceStatisticsOverviewRepresentation
+  ExternalServiceStatisticsOverviewRepresentation:
+    description: External Services statistics overview results for Operation and Object
+    type: object
+    properties:
+      activeCount:
+        description: The active count of the component
+        type: integer
+      statisticFor:
+        description: The component type of this statistics for
+        type: string
+      totalCount:
+        description: The total count of the component
+        type: integer
+  InferenceErrorMessageRepresentation:
+    description: Data shape inferring errors
+    type: object
+    properties:
+      message:
+        description: Error message
+        type: string
+      severityLevel:
+        description: Severity of the error
+        type: string
+        enum:
+          - Error
+          - Info
+          - Warning
+  NamedCredentialListRepresentation:
+    description: A list of Named Credentials.
+    type: object
+    properties:
+      namedCredentials:
+        description: List of Named Credentials
+        type: array
+        items:
+          type: NamedCredentialRepresentation
+  NamedCredentialRepresentation:
+    description: Information about a Named Credential.
+    type: object
+    properties:
+      endpoint:
+        description: Endpoint of this Named Credential
+        type: string
+      masterLabel:
+        description: Master Label of this Named Credential
+        type: string
+      name:
+        description: Name of this Named Credential
+        type: string
+  OpenApiSpecInferenceInputWrapperRepresentation: # TODO: Hand-rolled (W-8334626) due to issue #29 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+    description: Wrapper for data input for inferring Open Api specification
+    type: object
+    properties:
+      input:
+        description: Data input for inferring Open Api specification
+        type: OpenApiSpecInferenceInputRepresentation
+  OpenApiSpecInferenceInputRepresentation:
+    description: Data input for inferring Open Api specification
+    type: object
+    properties:
+      description:
+        description: Sets the description of the external service
+        type: string
+      externalServiceId?:
+        description: Sets the external service Id
+        type: string
+      method:
+        description: Sets the method of the external service
+        type: string
+      name:
+        description: Sets the name of the external service
+        type: string
+      operationDescription:
+        description: Sets the descripton of the external service action/operation
+        type: string
+      operationName:
+        description: Sets the name of the external service action/operation
+        type: string
+      parameters:
+        description: Sets the parameters of the external service
+        type: array
+        items:
+          type: OpenApiSpecInferenceParameterRepresentation
+      path:
+        description: Sets the path of the external service
+        type: string
+      requestBody?:
+        description: Sets the request body
+        type: object
+      responseBody:
+        description: Sets the response body
+        type: object
+  OpenApiSpecInferenceOutputRepresentation:
+    description: Represents the inferred Open Api specification
+    type: object
+    properties:
+      errorMessages:
+        description: Error messages
+        type: array
+        items:
+          type: InferenceErrorMessageRepresentation
+      schema:
+        description: Inferred schema of the Open Api specification
+        type: string
+      success:
+        description: Whether or not the inference was successful
+        type: boolean
+  OpenApiSpecInferenceParameterRepresentation:
+    description: Represents information of a parameter
+    type: object
+    properties:
+      description?:
+        description: Sets the description for the parameter
+        type: string
+      example?:
+        description: Sets the example value for the parameter
+        type: string
+      location:
+        description: Sets the location of the parameter
+        type: string
+      name:
+        description: Sets the name of the parameter
+        type: string
+      required:
+        description: Sets requiredness of the parameter
+        type: boolean
+      type:
+        description: Sets the data type of the parameter
+        type: string
+  # TODO Hand-Rolled due to issue #29 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  SchemaValidationInputWrapperRepresentation:
+    description: Wrapper for input representation for schema validation
+    type: object
+    properties:
+      schema:
+        description: Input representation for schema validation
+        type: SchemaValidationInputRepresentation
+  SchemaValidationInputRepresentation:
+    description: Input representation for schema validation
+    type: object
+    properties:
+      schema:
+        description: Sets the schema of the external service
+        type: string
+      schemaName:
+        description: Sets the external service name
+        type: string
+      systemVersion:
+        description: Sets the system version of the external service
+        type: integer
+  SchemaValidationMessageRepresentation:
+    description: Information about a schema validation result
+    type: object
+    properties:
+      endColumn:
+        description: End column corresponding to the schema validation result
+        type: integer | nil
+        required: false # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+      endLine:
+        description: End line corresponding to the schema validation result
+        type: integer | nil
+        required: false # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+      endPosition:
+        description: End position corresponding to the schema validation result
+        type: integer | nil
+        required: false # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+      message:
+        description: Message for schema validation result
+        type: string
+      startColumn:
+        description: Start column corresponding to the schema validation result
+        type: integer | nil
+        required: false # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+      startLine:
+        description: Start line corresponding to the schema validation result
+        type: integer | nil
+        required: false # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+      startPosition:
+        description: Start position corresponding to the schema validation result
+        type: integer | nil
+        required: false # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+      validationClass:
+        description: Validation class for schema validation result
+        type: string
+        enum:
+          - Semantic
+          - Syntax
+      validationLevel:
+        description: Validation level for schema validation result
+        type: string
+        enum:
+          - Error
+          - Info
+          - Warning
+  SchemaValidationOutputRepresentation:
+    description: A list of schema validation results
+    type: object
+    properties:
+      schemaName:
+        description: Name of this schema
+        type: string
+      schemaSize:
+        description: Size of the schema
+        type: integer
+      schemaType:
+        description: Type of schema
+        type: string
+        enum:
+          - OpenApi
+          - OpenApi3
+      schemaValidation:
+        description: List of schema validation messages
+        type: array
+        items:
+          type: SchemaValidationMessageRepresentation
+      systemVersion:
+        description: System version used for this schema
+        type: integer
+  # TODO Hand-Rolled due to issue #29 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  TestConnectionInputWrapperRepresentation:
+    description:
+      Wrapper for input representation for testing a connection and inferring the datashape of
+      the response
+    type: object
+    properties:
+      configuration:
+        description: Input representation for test connection request
+        type: TestConnectionInputRepresentation
+  TestConnectionInputRepresentation:
+    description: Data input for testing a connection and inferring the datashape of
+      the response
+    type: object
+    properties:
+      mediaType:
+        description: Sets the name of the external service action/operation
+        type: string
+      method:
+        description: Sets the method of the external service
+        type: string
+      namedCredentialName:
+        description: Sets the name of the external service
+        type: string
+      parameters:
+        description: Sets the parameters of the external service
+        type: array
+        items:
+          type: OpenApiSpecInferenceParameterRepresentation
+      path:
+        description: Sets the path of the external service
+        type: string
+      requestBody?:
+        description: Sets the request body
+        type: object
+  TestConnectionOutputRepresentation:
+    description: Represents response and inferred data shape
+    type: object
+    properties:
+      dataShape:
+        description: The datashape of the response, only shown for valid calls
+        type: DataShapeInferenceOutputRepresentation | nil
+        required: false
+      errorMessages:
+        description: The error messages from testing the api
+        type: array
+        items:
+          type: InferenceErrorMessageRepresentation
+      rawData?:
+        description: The raw data received from the server
+        type: string
+      statusCode?:
+        description: The status code of the response
+        type: string
+/externalservices:
+  /actions/services/{actionName}:
+    get:
+      displayName: getExternalServiceAction
+      description: Get the action details of the Http Action invocable action operation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalServiceActionOutputRepresentation
+    uriParameters:
+      actionName:
+        description: 'The external service action name. Eg: registrationName.operationName'
+        type: string
+        required: true
+  /externalserviceschemarequest:
+    get:
+      description: Retrieves an external service schema
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalServiceSchemaRequestRepresentation
+      queryParameters:
+        namedCredentialId:
+          type: string
+          required: false
+        schemaAbsolutePath:
+          type: string
+          required: false
+        schemaPath:
+          type: string
+          required: false
+  /inference:
+    /datashape/{version}:
+      post:
+        description: Infer data shape from example data
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataShapeInferenceOutputRepresentation
+        queryParameters:
+          exampleData:
+            type: string
+            required: false
+          mediaType:
+            type: string
+            required: false
+      uriParameters:
+        version:
+          description: Version of the Open Api Spec
+          type: string
+          required: true
+    /datashape/{version}/sendrequest:
+      post:
+        displayName: postTestConnectionInference
+        description: Infer Open Api specification
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: TestConnectionOutputRepresentation
+        body:
+          application/json:
+            type: TestConnectionInputWrapperRepresentation
+            # TODO: Hand-rolled W-11766973 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): configuration
+      uriParameters:
+        version:
+          description: Version of the Open Api Spec
+          type: string
+          required: true
+    /openapispec/{version}:
+      post:
+        description: Infer Open Api specification
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: OpenApiSpecInferenceOutputRepresentation
+        body:
+          application/json:
+            type: OpenApiSpecInferenceInputWrapperRepresentation
+            # TODO: Hand-rolled W-11766973 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): input
+      uriParameters:
+        version:
+          description: Version of the Open Api Spec
+          type: string
+          required: true
+  /schemas/{schemaName}/validation:
+    post:
+      description: Retrieves a list of schema validation results for a specific
+        external service and its schema
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SchemaValidationOutputRepresentation
+      body:
+        application/json:
+          type: SchemaValidationInputWrapperRepresentation
+          # TODO: Hand-rolled W-11766973 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          # required: false
+          (oas-body-name): schema
+    uriParameters:
+      schemaName:
+        type: string
+        required: true
+  /statistics/services:
+    get:
+      description: Get external service statistics including service, operation
+        and object's total and active counts
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalServiceStatisticsOutputRepresentation
+  /statistics/services/{registrationName}:
+    get:
+      description: Get external service statistics including service, operation
+        and object's total and active counts
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalServiceStatisticsOutputRepresentation
+    uriParameters:
+      registrationName:
+        description: 'The external service registration name. Eg: namespace__serviceName'
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,55 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'external-services'
+(luvio.ttl): 300000
+
+types:
+  DataShapeInferenceOutputRepresentation:
+    (luvio.opaque): true
+  OpenApiSpecInferenceOutputRepresentation:
+    (luvio.ttl): 500
+  SchemaValidationOutputRepresentation:
+    (luvio.key):
+      schemaName: schemaName
+  TestConnectionOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+
+/externalservices:
+  /inference:
+    /datashape/{version}:
+      post:
+        (luvio.method): get
+        (luvio.adapter):
+          name: getDataShape
+    /datashape/{version}/sendrequest:
+      post:
+        (luvio.method): get
+        (luvio.adapter):
+          name: sendTestConnectionRequest
+    /openapispec/{version}:
+      post:
+        (luvio.method): get
+        (luvio.adapter):
+          name: getOpenApiSpec
+  /statistics/services:
+    get:
+      (luvio.adapter):
+        name: getStatistics
+
+    /{registrationName}:
+      get:
+        (luvio.adapter):
+          name: getStatisticsForService
+  /schemas/{schemaName}/validation:
+    post:
+      (luvio.adapter):
+        name: validateSchema
+  /actions/services/{actionName}:
+    get:
+      (luvio.adapter):
+        name: getActionDetailsForService