feat: extend rule dok.19 to also check summary in path operations

Signed-off-by: Mirelle Falstad <extern.mirelle.falstad@digg.se>

Author: mirelle-xlent

GUIDELINES.md

@@ -104,7 +104,15 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
 
 ```
 $
-```
+```> npx jest tests/dok.test.ts
+No tests found, exiting with code 1
+Run with `--passWithNoTests` to exit with code 0
+In /home/mirellefalstad/workspaces/rap-lp/rest-api-profil-lint-processor
+  112 files checked.
+  testMatch: **/tests/unit/**/*.test.ts - 13 matches
+  testPathIgnorePatterns: /node_modules/ - 112 matches
+  testRegex:  - 0 matches
+Pattern: tests/dok.test.ts - 0 matches
 
 **Förklaring:**
 
@@ -370,13 +378,13 @@ $.paths[*][*]
 ```
 
 **Förklaring:**
-Regeln förutsätter att det finns en förekomst av objektet `Paths`. Regeln undersöker vidare om det finns förekomster av fältet `description` oavsett om det är en GET, POST, PUT, PATCH eller en DELETE operation.
+Regeln förutsätter att objektet `paths` förekommer. Den kontrollerar att fälten `description` och `summary` finns för varje GET-, POST-, PUT-, PATCH- eller DELETE-operation.
 
 **Exempel:**
 
-![alt text](images/dok19.png)
+![Exempel på en OpenAPI-specifikation där varje operation under olika endpoints (GET, POST, PUT, DELETE) har markerats med röd ram kring fälten summary och description. Bilden illustrerar vilka delar av API-specifikationen som regeln DOK.19 validerar.](images/dok19.png)
 
-I exemplet ovan, så exemplifieras regeln med en två get samt en post operation, där regeln undersöker om det finns en förekomst av fältet description.
+_I exemplet ovan illustreras regeln med flera operationer, där DOK.19 kontrollerar att fälten description och summary är ifyllda._
 
 ---
 

images/dok19.png

@@ -398,7 +398,11 @@ export class Dok19 extends BaseRuleset {
   message =
     'Ett API:s resurser och de möjliga operationer som kan utföras på resursen SKALL beskrivas så utförligt och tydligt som möjligt';
   then = [
-    {
+      {
+      field: 'summary',
+      function: truthy,
+    },
+     {
       field: 'description',
       function: truthy,
     },
@@ -422,6 +426,7 @@ export class Dok19 extends BaseRuleset {
   }
   severity = DiagnosticSeverity.Error;
 }
+
 export class Dok01 extends BaseRuleset {
   static customProperties: CustomProperties = {
     område: 'Dokumentation',

src/rulesets/DokRules.ts

@@ -455,6 +455,7 @@ testRule('Dok17', [
     ],
   },
 ]);
+
 testRule('Dok19', [
   {
     name: 'giltigt testfall',
@@ -466,6 +467,7 @@ testRule('Dok19', [
         '/thiscase': {
           operation: {
             description: 'description field test',
+            summary: 'summary field test',
             responses: {
               '200': {
                 description: 'test',
@@ -487,7 +489,7 @@ testRule('Dok19', [
         '/thiscase': {
           operation: {
             //description: "dfadfa",
-            //summery: "",
+            //summary: "",
             responses: {
               '200': {
                 description: '',