feat: add rule DOK.09

Signed-off-by: Mats Johansson <extern.mats.johansson@digg.se>

Author: mmjohansson

GUIDELINES.md

@@ -35,6 +35,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
    - [ID: DOK.06](#id-dok06)
    - [ID: DOK.07](#id-dok07)
    - [ID: DOK.08](#id-dok08)
+   - [ID: DOK.09](#id-dok09)
    - [ID: DOK.15](#id-dok15)
    - [ID: DOK.17](#id-dok17)
    - [ID: DOK.19](#id-dok19)
@@ -240,6 +241,29 @@ _Ett av objekten räcker för att uppfylla regeln._
 
 ---
 
+### ID: DOK.09
+
+**Krav:** Kända problem och begränsningar SKALL finnas tydlig beskrivna i dokumentationen.
+
+**Typ:** SKALL
+
+**JSON Path Plus-uttryck:**
+
+```
+$
+```
+
+**Förklaring:**
+Regeln förutsätter att det finns en förekomst av något av objekten `info.description` och `externalDocs.description`, och att de innehåller någon av strängarna "limit", "begränsning" eller "problem". Alternativt så räcker det om det finns en förekomst av `info.x-limitations`.
+
+**Exempel:**
+
+![Exempelbild på ovan nämnda objekts placering i en OpenAPI Description](images/dok9.png)
+
+_Ett av objekten räcker för att uppfylla regeln, men "limit", "begränsning" eller "problem" behöver nämnas i `description`-fälten för att de ska räknas._
+
+---
+
 ### 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

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

images/dok9.png

@@ -286,6 +286,64 @@ export class Dok08 extends BaseRuleset {
   }
   severity = DiagnosticSeverity.Error;
 }
+export class Dok09 extends BaseRuleset {
+  static customProperties: CustomProperties = {
+    område: 'Dokumentation',
+    id: 'DOK.09',
+  };
+  given = '$';
+  message = 'Kända problem och begränsningar SKALL finnas tydlig beskrivna i dokumentationen.';
+  then = [
+    {
+      function: (targetVal: any, _opts: string, paths: string[]) => {
+        const includesLimitTerm = (description: string): boolean => {
+          if (description) {
+            const limitTerms = ['limit', 'begränsning', 'problem'];
+            return limitTerms.some((term) => description.includes(term));
+          } else {
+            return false;
+          }
+        };
+
+        const externalDocs = targetVal?.externalDocs;
+        const info = targetVal?.info;
+        if (
+          info?.['x-limitations'] ||
+          includesLimitTerm(info?.description?.toLowerCase()) ||
+          includesLimitTerm(externalDocs?.description?.toLowerCase())
+        ) {
+          return [];
+        }
+
+        return [
+          {
+            message: this.message,
+            severity: this.severity,
+            paths: paths,
+          },
+        ];
+      },
+    },
+    {
+      function: (targetVal: string, _opts: string, paths: string[]) => {
+        this.trackRuleExecutionHandler(
+          JSON.stringify(targetVal, null, 2),
+          _opts,
+          paths,
+          this.severity,
+          this.constructor.name,
+          moduleName,
+          Dok09.customProperties,
+        );
+      },
+    },
+  ];
+  constructor() {
+    super();
+    super.initializeFormats(['OAS2', 'OAS3']);
+  }
+  severity = DiagnosticSeverity.Error;
+}
 export class Dok19 extends BaseRuleset {
   static customProperties: CustomProperties = {
     område: 'Dokumentation',

rulesets/DokRules.ts

@@ -317,6 +317,60 @@ testRule('Dok08', [
     ],
   },
 ]);
+testRule('Dok09', [
+  {
+    name: 'giltigt testfall - info.description innehåller keyword',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0', description: 'något om limits' },
+    },
+    errors: [],
+  },
+  {
+    name: 'giltigt testfall - externalDocs.description innehåller keyword',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0' },
+      externalDocs: { description: 'något om begränsningar' },
+    },
+    errors: [],
+  },
+  {
+    name: 'giltigt testfall - info.x-limitations är definierad',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0', 'x-limitations': 'behöver bara existera utan keywords' },
+    },
+    errors: [],
+  },
+  {
+    name: 'ogiltigt testfall - samtliga fält saknas',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0' },
+    },
+    errors: [
+      {
+        message: 'Kända problem och begränsningar SKALL finnas tydlig beskrivna i dokumentationen.',
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+  {
+    name: 'ogiltigt testfall - fält finns men saknar samtliga keywords',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0', description: 'test' },
+      externalDocs: { description: 'test' },
+    },
+    errors: [
+      {
+        message: 'Kända problem och begränsningar SKALL finnas tydlig beskrivna i dokumentationen.',
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+]);
 testRule('Dok17', [
   {
     name: 'giltigt testfall',

tests/dok.test.ts

@@ -60,6 +60,7 @@ const ruleTypes = [
   DokRules.Dok06,
   DokRules.Dok07,
   DokRules.Dok08,
+  DokRules.Dok09,
   FelRules.Fel01,
   FelRules.Fel02,
   FnsRules.Fns08,