Feature/spectral

.github/workflows/ci.yml

@@ -13,5 +13,7 @@ jobs:
       uses: actions/setup-java@v1
       with:
         java-version: 1.8
+    - name: Lint with spectral
+      run: npm install && npm run spectral
     - name: Build with Maven
       run: mvn clean verify --file pom.xml

.spectral.yaml

@@ -0,0 +1,20 @@
+extends: spectral:oas
+functions: [x-header-parameter]
+rules:
+  wrong-version:
+    description: OpenApi version must be 3.x.x
+    given: $.openapi
+    severity: error
+    then:
+      field: "@value"
+      function: pattern
+      functionOptions:
+        match: "^3\.\d\.\d+$"
+  x-header-not-set:
+    message: "{{error}}"
+    given: $.paths.*.post
+    severity: error
+    then:
+      function: "x-header-parameter"
+      functionOptions:
+        value: "test"

README.md

@@ -50,3 +50,23 @@ Note: _(One must have issued `npm install` previously.)_
 Run e.g. on master: `mvn -B release:prepare` e.g. via [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/baloise/corellia)
 
 Subsequently the GitHub action worksflow "create release" will pick up the published tag and release and deploy the artifacts in the Github package registry.
+
+
+## Spectral linting (just to not forget how to do it.)
+
+use the following comand to lint openapi.json
+```
+node run spectral
+```
+`.spectral` contains the rules and `functions/` contains the custom functions used in the rule
+
+Custom example rules are:
+ - Version must be 3.0.1
+ - all post actions must have X-Caller-Name and X-EventId in the header
+
+All standard rules for openapie 3 are usesd as well.
+
+Documentation can be found here:
+https://meta.stoplight.io/docs/spectral/README.md
+
+`docker run --rm -it -v %cd%:/tmp  quay.balgroupit.com/baloise-base-images/spectral lint  /tmp/docs/openapi.json --ruleset=/tmp/docs/spectral.yaml`

docs/openapi.json

@@ -478,7 +478,7 @@
         "properties" : {
           "data" : {
             "type" : "array",
-            "description" : "The document itself. If the documentType is CONTRACT then the document must contain one of these keywords 'Versicherungsvertrag, Contrat d�assurance, Contratto di assicurazione, Insurance policy'",
+            "description" : "The document itself. If the documentType is CONTRACT then the document must contain one of these keywords 'Versicherungsvertrag, Contrat d�assurance, Contratto di assicurazione, Insurance policy'",
             "items" : {
               "type" : "string",
               "format" : "byte"

functions/x-header-parameter.js

@@ -0,0 +1,10 @@
+module.exports = (targetVal, opts) => {
+    if ((targetVal.parameters.filter(param => param.name == "X-Caller-Name").length == 0)
+          || (targetVal.parameters.filter(param => param.name == "X-Event-ID").length == 0)) {
+      return [
+        {
+          message: 'Header must have X-Caller-Name and X-Event-Id set in operation: ' + targetVal.operationId,
+        },
+      ];
+    }
+};