feat: add rule DOK.11

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

Author: mirelle-xlent

GUIDELINES.md

@@ -36,6 +36,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
    - [ID: DOK.07](#id-dok07)
    - [ID: DOK.08](#id-dok08)
    - [ID: DOK.09](#id-dok09)
+   - [ID: DOK.11](#id-dok11)
    - [ID: DOK.15](#id-dok15)
    - [ID: DOK.17](#id-dok17)
    - [ID: DOK.19](#id-dok19)
@@ -88,7 +89,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
 
 ## Område: Dokumentation
 
-**Täckningsgrad: 33%**
+**Täckningsgrad: 46%**
 
 ### ID: DOK.01
 
@@ -267,6 +268,30 @@ _Ett av objekten räcker för att uppfylla regeln, men "limit", "begränsning" e
 
 ---
 
+### ID: DOK.11
+
+**Krav:** Avsikten och beteendet hos API:et SKALL beskrivas så utförligt och tydligt som möjligt.
+
+**Typ:** SKALL
+
+**JSON Path Plus-uttryck:**
+
+```
+$.info
+```
+
+**Förklaring:**
+Regeln förutsätter att det finns en förekomst av fältet `description` under objektet `info`.
+Beskrivningen måste finnas och får endast vara en icke-tom textsträng som inte enbart består av blanksteg.
+
+**Exempel:**
+
+![Exempelbild på hur en korrekt description kan se ut](images/dok11.png)
+
+_Exemplet ovan är giltigt då description finns, och innehåller en textsträng som inte enbart består av blanksteg._
+
+---
+
 ### ID: DOK.15
 
 **Krav:** I dokumentationen av API:et SKALL exempel på API:ets fråga (en:request) och svar (en:reply) finnas i sin helhet.

REUSE.toml

@@ -36,6 +36,7 @@ path = [
     "images/dok7.png",
     "images/dok8.png",
     "images/dok9.png",
+    "images/dok11.png",
     "images/dot1-2.png",
     "images/dot1.png",
     "images/dot4.png",

images/dok11.png

@@ -344,6 +344,51 @@ export class Dok09 extends BaseRuleset {
   }
   severity = DiagnosticSeverity.Error;
 }
+
+export class Dok11 extends BaseRuleset {
+  static customProperties: CustomProperties = {
+    område: 'Dokumentation',
+    id: 'DOK.11',
+  };
+  given = '$.info';
+  message = 'Avsikten och beteendet hos API:et SKALL beskrivas så utförligt och tydligt som möjligt.';
+  then = [
+    {
+      function: (targetVal: any, _opts: string, paths: string[]) => {
+        const description = targetVal.description;
+        if (!description || typeof description !== 'string' || description.trim() === '') {
+          return [
+            {
+              message: this.message,
+              severity: this.severity,
+              paths: paths,
+            },
+          ];
+        }
+        return [];
+      },
+    },
+    {
+      function: (targetVal: string, _opts: string, paths: string[]) => {
+        this.trackRuleExecutionHandler(
+          JSON.stringify(targetVal, null, 2),
+          _opts,
+          paths,
+          this.severity,
+          this.constructor.name,
+          moduleName,
+          Dok11.customProperties,
+        );
+      },
+    },
+  ];
+  constructor() {
+    super();
+    super.initializeFormats(['OAS2', 'OAS3']);
+  }
+  severity = DiagnosticSeverity.Error;
+}
+
 export class Dok19 extends BaseRuleset {
   static customProperties: CustomProperties = {
     område: 'Dokumentation',

rulesets/DokRules.ts

@@ -371,6 +371,66 @@ testRule('Dok09', [
     ],
   },
 ]);
+
+testRule('Dok11', [
+  {
+    name: 'giltigt testfall',
+    document: {
+      openapi: '3.1.0',
+      info: {
+        version: '1.0',
+        description: 'When the documentation consists of multiple paragraphs, the greater-than operator can be used.',
+      },
+    },
+    errors: [],
+  },
+  {
+    name: 'ogiltigt testfall - description saknas',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0' },
+    },
+    errors: [
+      {
+        message: 'Avsikten och beteendet hos API:et SKALL beskrivas så utförligt och tydligt som möjligt.',
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+  {
+    name: 'ogiltigt testfall - description finns, men innehåller endast blanksteg',
+    document: {
+      openapi: '3.1.0',
+      info: {
+        version: '1.0',
+        description: '  ',
+      },
+    },
+    errors: [
+      {
+        message: 'Avsikten och beteendet hos API:et SKALL beskrivas så utförligt och tydligt som möjligt.',
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+  {
+    name: 'ogiltigt testfall - description finns, men är tom',
+    document: {
+      openapi: '3.1.0',
+      info: {
+        version: '1.0',
+        description: '',
+      },
+    },
+    errors: [
+      {
+        message: 'Avsikten och beteendet hos API:et SKALL beskrivas så utförligt och tydligt som möjligt.',
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+]);
+
 testRule('Dok17', [
   {
     name: 'giltigt testfall',

tests/dok.test.ts

@@ -72,6 +72,7 @@ const ruleTypes = [
   DotRules.Dot04,
   DokRules.Dok19,
   DokRules.Dok01,
+  DokRules.Dok11,
   DokRules.Dok17,
   DokRules.Dok03Info,
   DokRules.Dok03ContactName,