chore: align framework agreement right operand to PascalCase (#30)

eclipse-tractusx · May 15, 2024 · 238c91a · 238c91a
1 parent 09527f1
commit 238c91a
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/cx/policy/samples/policy.sample.json b/cx/policy/samples/policy.sample.json
@@ -14,7 +14,7 @@
       "constraint": {
         "leftOperand": "FrameworkAgreement",
         "operator": "eq",
-        "rightOperand": "pcf:1.0.0"
+        "rightOperand": "Pcf:1.0.0"
       }
     }
   }

diff --git a/cx/policy/samples/policy.sample.playground.json b/cx/policy/samples/policy.sample.playground.json
@@ -31,7 +31,7 @@
       "constraint": {
         "leftOperand": "FrameworkAgreement",
         "operator": "eq",
-        "rightOperand": "pcf"
+        "rightOperand": "Pcf"
       }
     }
   }

diff --git a/cx/policy/specs/policy.definitions.md b/cx/policy/specs/policy.definitions.md
@@ -153,7 +153,7 @@ The PCF framework agreement is expressed as:
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "pcf:[version]"
+    "rightOperand": "Pcf:[version]"
   }
 }
 ```
@@ -167,7 +167,7 @@ The Sustainability framework agreement is expressed as:
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "sustainability:[version]"
+    "rightOperand": "Sustainability:[version]"
   }
 }
 ```
@@ -181,7 +181,7 @@ The Quality framework agreement is expressed as:
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "quality:[version]"
+    "rightOperand": "Quality:[version]"
   }
 }
 ```
@@ -195,7 +195,7 @@ The Resiliency framework agreement is expressed as:
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "resiliency:[version]"
+    "rightOperand": "Resiliency:[version]"
   }
 }
 ```
@@ -209,7 +209,7 @@ The Traceability framework agreement is expressed as:
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "traceability:[version]"
+    "rightOperand": "Traceability:[version]"
   }
 }
 ```
@@ -223,7 +223,7 @@ The Behavior framework agreement is expressed as:
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "behavioraltwin:[version]"
+    "rightOperand": "BehavioralTwin:[version]"
   }
 }
 ```
@@ -298,7 +298,7 @@ an active signed traceability agreement:
           {
             "leftOperand": "FrameworkAgreement",
             "operator": "eq",
-            "rightOperand": "traceability"
+            "rightOperand": "Traceability"
           }
         ]
       }

diff --git a/cx/policy/specs/policy.mapping.md b/cx/policy/specs/policy.mapping.md
@@ -32,20 +32,20 @@ Please check the syntax [here](./policy.definitions.md)
 Automatic mapping policy constraint expressions to credential type is possible assuming all framework credentials follow
 the same schema. Assuming that is the case, the evaluation of the policy (= the evaluation function) can be generic.
 
-In an example a policy constraint requiring the "pcf" credential in version 0.4.2, would look like this:
+In an example a policy constraint requiring the "Pcf" credential in version 0.4.2, would look like this:
 
 ```json
 {
   "constraint": {
     "leftOperand": "FrameworkAgreement",
     "operator": "eq",
-    "rightOperand": "pcf:0.4.2"
+    "rightOperand": "Pcf:0.4.2"
   }
 }
 ```
 
 If a specific contract version is referenced in the policy constraint, like in the example above, it follows that the
-policy **must be updated**, if version `0.4.3` of the `pcf` credential is released, and the policy should reference it.
+policy **must be updated**, if version `0.4.3` of the `Pcf` credential is released, and the policy should reference it.
 
 If no contract version is specified in the policy constraint, then the policy **need not be updated**.
 
@@ -70,7 +70,7 @@ In order to reconstruct the actual credential type, which in the example would b
 simple String manipulation:
 
 - remove `FrameworkAgreement`. Hint: use it to trigger the transformation.
-- capitalize the right-operand (i.e. `pcf --> Pcf`)
+- capitalize the right-operand if necessary (i.e. `pcf --> Pcf`)
 - append the `Credential` literal
 
 Formally, that transformation must adhere to the following EBNF: