fix: update rule dok18

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

Author: fredriknordlander

GUIDELINES.md

@@ -39,6 +39,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
    - [ID: DOK.11](#id-dok11)
    - [ID: DOK.15](#id-dok15)
    - [ID: DOK.17](#id-dok17)
+   - [ID: DOK.18](#id-dok18)
    - [ID: DOK.19](#id-dok19)
    - [ID: DOK.20](#id-dok20)
 2. [Område: Datum- och tidsformat](#område-datum--och-tidsformat)
@@ -355,6 +356,31 @@ I exemplet ovan, så exemplifieras regeln det med ett icke godkänt värde på v
 
 ---
 
+### ID: DOK.18
+
+**Krav:** API specifikationen BÖR beskrivas med antingen JSON eller YAML.
+
+**Typ:** BÖR
+
+**JSON Path Plus-uttryck:**
+
+```
+$.paths.*.*.responses.*.content'
+$.paths.*.*.requestBody.content'
+```
+
+**Förklaring:**
+
+Regeln förutsätter att API-specifikationen beskrivs med antingen JSON eller YAM där den regeln letar upp alla content objekt under både requestBody och responses. Om det inte är dem, så returnerar regeln ett fel i form av en varning. 
+
+**Exempel:**
+
+![alt text](images/dok18.png)
+
+I exemplet ovan, så exemplifieras regeln med ett ej godkänd värde på content objekten under objektet requestBody samt under objetet responses, eftersom värdet på dessa är satt till: 'text/plain' och inte  någon av de godkända typerna 'application/yaml' eller application/json.
+
+---
+
 ### ID: DOK.19
 
 **Krav:** 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.

apis/dok-api.yaml

@@ -205,14 +205,30 @@ paths:
         '201':
           description: Created
           content:
-            application/json:
+            text/plain:
               schema:
                 type: string                    
               example:
               - id: 19
                 name: thing1
-              - id: 20
-                name: thing2
+  /items5:
+    get:
+      summary: Get items
+      responses:
+        '200':
+          description: error response
+          content:
+            application/xml:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: string
+              example:
+              - id: 17
+                name: Pete
+              - id: 18
+                name: Tom
 components:
   schemas:
     Pet:

images/dok18.png

@@ -49,19 +49,27 @@ testRule('Dok18', [
       info: { version: '1.0' },
       servers: [{ url: 'https://example.com/my-api/v1' }],
       paths: {
-        '/Dettacase': {
+        '/item2': {
           get: {
-            description: 'Ogiltigt testfall av CamelCase',
-            parameters: [
-              {
-                name: 'Very_LongName',
-                in: 'path',
-                required: false,
-              },
-            ],
+            description: 'Ogiltigt testfall av test för giltigt format av API specifikationen',
             responses: {
               '200': {
-                description: '',
+                description: 'Ej godkänt svar',
+                content: {
+                  'application/xml': {
+                    schema: {
+                      type: 'object',
+                      properties: {
+                        id: {
+                          type: 'string',
+                        },
+                        name: {
+                          type: 'string',
+                        },
+                      },
+                    },
+                  },
+                },
               },
             },
           },
@@ -70,21 +78,41 @@ testRule('Dok18', [
     },
     errors: [
       {
-        code: 'Dok20',
-        message: 'Förväntade returkoder och felkoder SKALL vara fullständigt dokumenterade.',
-        path: ['paths', '/Dettacase', 'get', 'responses', '200', 'description'],
-        severity: DiagnosticSeverity.Error,
-        range: {
-          start: {
-            line: 0,
-            character: 276,
-          },
-          end: {
-            line: 0,
-            character: 278,
+        code: 'Dok18',
+        message: 'API specifikationen BÖR beskrivas med antingen JSON eller YAML.',
+        path: ['paths', '/item2', 'get', 'responses', '200', 'content'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+  {
+    name: 'ogiltigt testfall',
+    document: {
+      openapi: '3.1.0',
+      info: { version: '1.0' },
+      servers: [{ url: 'https://example.com/my-api/v1' }],
+      paths: {
+        '/item3': {
+          post: {
+            requestBody: {
+              content: {
+                'text/plain': {
+                  example1: 'example1',
+                },
+              },
+            },
+            responses: {},
           },
         },
       },
+    },
+    errors: [
+      {
+        code: 'Dok18',
+        message: 'API specifikationen BÖR beskrivas med antingen JSON eller YAML.',
+        path: ['paths', '/item3', 'post', 'requestBody','content'],
+        severity: DiagnosticSeverity.Warning,
+      },
     ],
   },
 ]);

tests/unit/dok.test.ts

@@ -82,6 +82,7 @@ const ruleTypes = [
   DokRules.Dok03License,
   DokRules.Dok03LicenseName,
   DokRules.Dok03LicenseUrl,
+  DokRules.Dok18,
   ResRules.Res02,
   ResRules.Res06,
 ];