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

package/src/raml/api.raml

@@ -0,0 +1,195 @@
+#%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:
+  ConstraintErrorResponseRepresentation:
+    description: Constraint Service Error Response representation
+    type: object
+    properties:
+      errorCode:
+        description: Error Code from Constraint Service Response. For example, INVALID_INPUT_ERROR,
+        type: string
+      message:
+        description: Error message from Constraint Service Response.
+        type: string
+  ConstraintVersionOutputRepresentation:
+    description: Constraint Version Connect API output representation
+    type: object
+    properties:
+      constraintModel:
+        description: Constraint Model
+        type: string
+      description:
+        description: Constraint Description
+        type: string
+      status:
+        description: Status
+        type: string
+  CreateConstraintVersionInputRepresentation:
+    description: Create new constraint input representation
+    type: object
+    properties:
+      constraintModel:
+        description: Constraint model of the version
+        type: string
+      description:
+        description: Description of the constraint version
+        type: string
+      status:
+        description: Status of the constraint version
+        type: string
+        enum:
+          - Active
+          - Inactive
+  CreateConstraintVersionOutputRepresentation:
+    description: Create Constraint Version Connect API Output
+    type: object
+    properties:
+      errors:
+        description: List of errors encountered during the API processing.
+        type: array
+        items:
+          type: ConstraintErrorResponseRepresentation
+      success:
+        description: API request successfully completed
+        type: boolean
+      versionId:
+        description: New constraint version ID
+        type: string
+  UpdateConstraintVersionInputRepresentation:
+    description: Update constraint input representation
+    type: object
+    properties:
+      constraintModel:
+        description: Constraint Model
+        type: string
+        required: false # TODO hand rolled. W-16265940
+      description:
+        description: Constraint Model
+        type: string
+        required: false # TODO hand rolled. W-16265940
+      status:
+        description: Status
+        type: string
+        required: false # TODO hand rolled. W-16265940
+        enum:
+          - Active
+          - Inactive
+  UpdateConstraintVersionOutputRepresentation:
+    description: Update Constraint Version Connect API Output
+    type: object
+    properties:
+      errors:
+        description: List of errors encountered during the API processing.
+        type: array
+        items:
+          type: ConstraintErrorResponseRepresentation
+      success:
+        description: API request successfully completed
+        type: boolean
+/industries/constraints/{expressionSetId}/versions:
+  get:
+    displayName: getConstraintVersion
+    description: Get a constraint version
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ConstraintVersionOutputRepresentation
+  patch:
+    displayName: patchConstraintVersion
+    description: Patch a constraint version
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: UpdateConstraintVersionOutputRepresentation
+    body:
+      application/json:
+        type: UpdateConstraintVersionInputRepresentation
+        (oas-body-name): constraintInput
+  post:
+    displayName: postConstraintVersion
+    description: Create a new constraint version
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: CreateConstraintVersionOutputRepresentation
+    body:
+      application/json:
+        type: CreateConstraintVersionInputRepresentation
+        (oas-body-name): constraintInput
+  uriParameters:
+    expressionSetId:
+      type: string
+      required: true
+/industries/constraints/{expressionSetId}/versions/{expressionSetVersionId}:
+  get:
+    displayName: getConstraintVersion
+    description: Get a constraint version
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ConstraintVersionOutputRepresentation
+  patch:
+    displayName: patchConstraintVersion
+    description: Patch a constraint version
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: UpdateConstraintVersionOutputRepresentation
+    body:
+      application/json:
+        type: UpdateConstraintVersionInputRepresentation
+        (oas-body-name): constraintInput
+  post:
+    displayName: postConstraintVersion
+    description: Create a new constraint version
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: CreateConstraintVersionOutputRepresentation
+    body:
+      application/json:
+        type: CreateConstraintVersionInputRepresentation
+        (oas-body-name): constraintInput
+  uriParameters:
+    expressionSetId:
+      type: string
+      required: true
+    expressionSetVersionId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,41 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'constraints'
+(luvio.ttl): 1000
+
+types:
+  ConstraintErrorResponseRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  ConstraintVersionOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  CreateConstraintVersionOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      success: success
+  UpdateConstraintVersionOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      success: success
+
+/industries/constraints/{expressionSetId}/versions:
+  post:
+    (luvio.adapter):
+      name: createConstraintVersion
+  uriParameters:
+    expressionSetId:
+  /{expressionSetVersionId}:
+    get:
+      (luvio.adapter):
+        name: getConstraintVersion
+    patch:
+      (luvio.adapter):
+        name: updateConstraintVersion
+    uriParameters:
+      expressionSetId:
+      expressionSetVersionId: