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

package/src/raml/api.raml

@@ -0,0 +1,170 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.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:
+  GuardrailDetailRepresentation:
+    description: Detail of the Guardrail such as Name, Min and Max value
+    type: object
+    properties:
+      guardRailCurrentValue:
+        description: Current Value of the Guardrail.
+        type: string
+      guardRailMaxValue:
+        description: Max Value of the Guardrail
+        type: string
+      guardRailMinValue:
+        description: Min Value of the Guardrail.
+        type: string
+      guardRailName:
+        description: Name of the Guardrail.
+        type: string
+      guardRailRestrictionType:
+        description: Whether Guardrail type is soft or hard.
+        type: string
+      messages:
+        description: The list exception messages for a guardrail.
+        type: MessageListRepresentation
+  IndustriesGuardrailInputRepresentation:
+    description: Input for Guardrail Validation
+    type: object
+    properties:
+      component:
+        description: Name of the component. A product may have several components,
+          for example OmniStudio has FLEX_CARD, IP and OMNI_SCRIPT as components.
+        type: string
+      guardrailName:
+        description: Name of the Guardrail.
+        type: string
+      guardrailValue:
+        description: Value of the guardrail to be validated
+        type: string
+      product:
+        description: 'Name of the product. For example: OMNI_STUDIO.'
+        type: string
+  IndustriesGuardrailListRepresentation:
+    description: List of all Guardrails
+    type: object
+    properties:
+      industriesGuardrailList:
+        description: A list of GuardrailDetailRepresentation
+        type: array
+        items:
+          type: GuardrailDetailRepresentation
+  IndustriesGuardrailRepresentation:
+    description: The detail of a Guardrail
+    type: object
+    properties:
+      industriesGuardrail:
+        description: The detail of a Guardrail.
+        type: GuardrailDetailRepresentation
+  MessageListRepresentation:
+    description: List of all Guardrail Messages
+    type: object
+    properties:
+      messageList:
+        description: A list of MessageRepresentation
+        type: array
+        items:
+          type: MessageRepresentation
+  MessageRepresentation:
+    description: During validation, the message is communicated to the user
+    type: object
+    properties:
+      code:
+        description: Error code of the exception.
+        type: string
+      exceptionmessage:
+        description: Exception Message String.
+        type: string
+      type:
+        description: The exception type could be WARNING or ERROR.
+        type: string
+  ValidationMessageRepresentation:
+    description: Response of guardrail validation
+    type: object
+    properties:
+      guardrailValue:
+        description: Actual value of the guardrail
+        type: string
+      message:
+        description: Warning or Error Message if the status is FAILURE
+        type: MessageRepresentation
+        required: false
+      status:
+        description: SUCCESS if value is less than guardrail value, FAILURE otherwise
+        type: string
+/connect/industries:
+  /guardrail:
+    get:
+      displayName: getIndustriesGuardrail
+      description: Retrieve the value of a single Guardrail
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IndustriesGuardrailRepresentation
+      queryParameters:
+        component:
+          type: string
+          required: false
+        name:
+          type: string
+          required: false
+        product:
+          type: string
+          required: false
+  /guardrail/validate:
+    post:
+      displayName: postValidateGuardrail
+      description: Validate the guardrail value.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ValidationMessageRepresentation
+      body:
+        application/json:
+          type: IndustriesGuardrailInputRepresentation
+          (oas-body-name): industriesGuardrailDef
+  /guardrails:
+    get:
+      displayName: getIndustriesGuardrails
+      description: Retrieve all the Guardrails
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IndustriesGuardrailListRepresentation
+      queryParameters:
+        component:
+          type: string
+          required: false
+        product:
+          type: string
+          required: false

package/src/raml/luvio.raml

@@ -0,0 +1,47 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Guardrail'
+
+types:
+  GuardrailDetailRepresentation:
+    (luvio.ttl): 360000
+
+  IndustriesGuardrailInputRepresentation:
+    (luvio.ttl): 360000
+
+  IndustriesGuardrailRepresentation:
+    (luvio.ttl): 360000
+
+  IndustriesGuardrailListRepresentation:
+    (luvio.ttl): 360000
+
+  MessageListRepresentation:
+    (luvio.ttl): 360000
+
+  MessageRepresentation:
+    (luvio.ttl): 360000
+
+  ValidationMessageRepresentation:
+    (luvio.ttl): 360000
+    (luvio.key):
+      guardrailValue: guardrailValue
+
+/connect/industries:
+  /guardrail:
+    get:
+      (luvio.adapter):
+        name: getIndustriesGuardrail
+
+  /guardrail/validate:
+    post:
+      (luvio.adapter):
+        name: postValidateGuardrail
+
+  /guardrails:
+    get:
+      (luvio.adapter):
+        name: getIndustriesGuardrails