fix: correct given expression + removal of incorrectly entered files for Dok06

Signed-off-by: Fredrik Nordlander <fredrik.nordlander@digg.se>

Author: fredriknordlander

GUIDELINES.md

@@ -75,6 +75,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
 9. [Område: Säkerhet](#område-säkerhet)
    - [ID: SAK.09](#id-sak09)
    - [ID: SAK.10](#id-sak10)
+   - [ID: SAK.15](#id-sak15)
    - [ID: SAK.18](#id-sak18)
 10. [Område: Förutsättningar](#område-förutsättningar)
 - [ID: FOR.02](#id-for02)
@@ -943,7 +944,7 @@ I exemplet ovan, så exemplifieras regeln med en kontroll av de query parametrar
 
 ## Område: Säkerhet
 
-**Täckningsgrad: 9%**
+**Täckningsgrad: 11%**
 
 ### ID: SAK.09
 
@@ -991,6 +992,29 @@ I exemplet ovan så kommer regeln att ge ett positivt utfall eftersom det finns
 
 ---
 
+### ID: SAK.15
+
+**Krav:** API-nycklar SKALL INTE inkluderas i URL eller querysträngen.
+
+**Typ:** SKALL
+
+**JSON Path Plus-uttryck:**
+
+```
+$.components.securitySchemes[?(@ && @.type=='apiKey')]
+```
+
+**Förklaring:**
+Regeln kontrollerar, under förutsättning att ett security scheme är definierat, att om typen är 'apiKey', så får värdet för parametern 'in' inte vara 'query.
+
+**Exempel:**
+
+![alt text](images/sak15.png)
+
+I exemplet ovan ger regeln ett negativt utfall, eftersom det definierade säkerhetsschemat 'ApiKeyQuery' har typen 'apiKey' och parametern 'in' är satt till 'query', vilket strider mot regeln.
+
+---
+
 ### ID: SAK.18
 
 **Krav:** OAuth version 2.0 eller senare BÖR användas för auktorisation.

REUSE.toml

@@ -50,6 +50,7 @@ path = [
     "images/rest-api-profil.png",
     "images/sak09.png",
     "images/sak10.png",
+    "images/sak15.png",
     "images/sak18.png",
     "images/ufn1-2.png",
     "images/ufn1.png",

images/sak15.png

@@ -8,7 +8,6 @@ import { truthy, falsy, pattern } from '@stoplight/spectral-functions';
 import { DiagnosticSeverity } from '@stoplight/types';
 import { Dok03Base } from './rulesetUtil.ts';
 import { Dok15Base } from './rulesetUtil.ts';
-import { commonEnglishWords, commonSwedishWords } from './constants/CommonWords.ts';
 const moduleName: string = 'DokRules.ts';
 
 export class Dok15Get extends Dok15Base {
@@ -134,52 +133,6 @@ export class Dok20 extends BaseRuleset {
   }
   severity = DiagnosticSeverity.Error;
 }
-export class Dok06 extends BaseRuleset {
-  static customProperties: CustomProperties = {
-    område: 'Dokumentation',
-    id: 'DOK.06',
-  };
-  given = '$.info.description';
-  message = 'Dokumentationen BÖR finnas på både svenska och engelska.';
-  then = [
-    {
-      function: (targetVal: string, _opts: string, paths: string[]) => {
-        const lowerCaseTargetVal = targetVal.toLowerCase();
-        const containsEnglish = commonEnglishWords.some((word) => new RegExp(`\\b${word}\\b`).test(lowerCaseTargetVal));
-        const containsSwedish = commonSwedishWords.some((word) => new RegExp(`\\b${word}\\b`).test(lowerCaseTargetVal));
-
-        if (!containsEnglish || !containsSwedish) {
-          return [
-            {
-              message: this.message,
-              severity: this.severity,
-            },
-          ];
-        } else {
-          return [];
-        }
-      },
-    },
-    {
-      function: (targetVal: string, _opts: string, paths: string[]) => {
-        this.trackRuleExecutionHandler(
-          JSON.stringify(targetVal, null, 2),
-          _opts,
-          paths,
-          this.severity,
-          this.constructor.name,
-          moduleName,
-          Dok06.customProperties,
-        );
-      },
-    },
-  ];
-  constructor() {
-    super();
-    super.initializeFormats(['OAS3']);
-  }
-  severity = DiagnosticSeverity.Warning;
-}
 export class Dok07 extends BaseRuleset {
   static customProperties: CustomProperties = {
     område: 'Dokumentation',

rulesets/DokRules.ts

@@ -102,7 +102,7 @@ export class Sak15 extends BaseRuleset {
   description = '-';
   message = 'API-nycklar SKALL INTE inkluderas i URL eller querysträngen';
   given =
-    "$..securitySchemes[?(@.type=='apiKey')]";
+    "$.components.securitySchemes[?(@ && @.type=='apiKey')]";
     then = [
       {
         function: (targetVal: any, _opts: any, paths: string[]) => {
@@ -174,4 +174,4 @@ export class Sak18 extends BaseRuleset {
   }
   severity = DiagnosticSeverity.Warning;
 }
-export default { Sak09, Sak10, Sak18 };
+export default { Sak09, Sak10, Sak15, Sak18 };

rulesets/SakRules.ts

@@ -80,55 +80,6 @@ testRule('Dok20', [
     ],
   },
 ]);
-testRule('Dok06', [
-  {
-    name: 'giltigt testfall',
-    document: {
-      openapi: '3.1.0',
-      info: { version: '1.0', description: 'Här finns det dokumentation på svenska and english.' },
-    },
-    errors: [],
-  },
-  {
-    name: 'ogiltigt testfall - endast svenska',
-    document: {
-      openapi: '3.1.0',
-      info: { version: '1.0', description: 'Detta är på svenska' },
-    },
-    errors: [
-      {
-        message: 'Dokumentationen BÖR finnas på både svenska och engelska.',
-        severity: DiagnosticSeverity.Warning,
-      },
-    ],
-  },
-  {
-    name: 'ogiltigt testfall - endast engelska',
-    document: {
-      openapi: '3.1.0',
-      info: { version: '1.0', description: 'This is in english' },
-    },
-    errors: [
-      {
-        message: 'Dokumentationen BÖR finnas på både svenska och engelska.',
-        severity: DiagnosticSeverity.Warning,
-      },
-    ],
-  },
-  {
-    name: 'ogiltigt testfall - båda språken med sammansatta ord',
-    document: {
-      openapi: '3.1.0',
-      info: { version: '1.0', description: 'Härfinnsdetdokumentationpåsvenskaandenglish.' },
-    },
-    errors: [
-      {
-        message: 'Dokumentationen BÖR finnas på både svenska och engelska.',
-        severity: DiagnosticSeverity.Warning,
-      },
-    ],
-  },
-]);
 testRule('Dok07', [
   {
     name: 'giltigt testfall',

rulesets/constants/CommonWords.ts

@@ -56,7 +56,6 @@ const ruleTypes = [
   FnsRules.Fns07,
   FnsRules.Fns06,
   DokRules.Dok20,
-  DokRules.Dok06,
   DokRules.Dok07,
   FelRules.Fel01,
   FelRules.Fel02,