chore: merge fix

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

Author: mmjohansson

.conform.yaml

@@ -19,3 +19,4 @@ policies:
       conventional:
         types: ['chore', 'build', 'docs', 'ci', 'perf', 'refactor', 'style', 'test', 'release']
         scopes: ['.*']
+        descriptionLength: 92

.github/workflows/publish-image.yaml

@@ -19,29 +19,29 @@ jobs:
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3
+        uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
 
       - name: Inspect builder
         run: |
           echo "Platforms: ${{ steps.buildx.outputs.platforms }}"
 
       - name: Log in to the Container registry
-        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3
+        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1 # v3.5.0
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Extract metadata (tags, labels) for distribution image
         id: metadist
-        uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
         with:
           images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}
           flavor: |
@@ -53,7 +53,7 @@ jobs:
             type=raw,value=${{ env.IMAGE_NAME }}-{{tag}}-{{date 'YYYYMMDD'}}-{{sha}},priority=32, enable=${{ startsWith(github.ref, 'refs/tags/v') }}
 
       - name: Build and push distribution image
-        uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25 # v5
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
         with:
           context: .
           file: Containerfile

.github/workflows/publish-package.yaml

@@ -13,10 +13,10 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
 
       # Setup .npmrc file to publish to GitHub Packages
-      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: "22.x"
           registry-url: "https://npm.pkg.github.com"

.github/workflows/test.yaml

@@ -12,10 +12,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
 
       - name: Set up Node.js
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: "22.15.0"
 

.prettierrc

@@ -6,6 +6,6 @@
   "printWidth": 120,
   "htmlWhitespaceSensitivity": "ignore",
   "bracketSameLine": false,
-  "vueIndentScriptAndStyle": true
+  "vueIndentScriptAndStyle": true,
+  "trailingComma": "all"
 }
-

GUIDELINES.md

@@ -32,7 +32,10 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
 1. [Område: Dokumentation](#område-dokumentation)
    - [ID: DOK.01](#id-dok01)
    - [ID: DOK.03](#id-dok03)
+   - [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)
@@ -75,16 +78,18 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
    - [ID: FNS.08](#id-fns08)
    - [ID: FNS.09](#id-fns09)
 10. [Område: Säkerhet](#område-säkerhet)
+    - [ID: SAK.01](#id-sak01)
     - [ID: SAK.09](#id-sak09)
     - [ID: SAK.10](#id-sak10)
     - [ID: SAK.15](#id-sak15)
+    - [ID: SAK.16](#id-sak16)
     - [ID: SAK.18](#id-sak18)
 11. [Område: Förutsättningar](#område-förutsättningar)
     - [ID: FOR.02](#id-for02)
 
 ## Område: Dokumentation
 
-**Täckningsgrad: 29%**
+**Täckningsgrad: 33%**
 
 ### ID: DOK.01
 
@@ -147,6 +152,38 @@ Regeln förutsätter att det finns en förekomst av objektet `info` med underlig
 
 ---
 
+### ID: DOK.06
+
+**Krav:** Dokumentationen BÖR finnas på både svenska och engelska.
+
+**Typ:** BÖR
+
+**JSON Path Plus-uttryck:**
+
+```
+$.info.description
+```
+
+**Förklaring:**
+Regeln förutsätter att det finns en förekomst av objektet `info` med underliggande struktur:
+
+- info
+  - description
+
+`description` förväntas dessutom innehålla dokumentation på både svenska och engelska. Detta görs i nuläget genom att försöka matcha enskilda ord mot de som finns i [ordlistorna.](rulesets/constants/CommonWords.ts)
+
+**Exempel:**
+
+![Exempelbild som visar att pipesymbolen kan användas för att skriva beskrivningen över flera rader i en OpenAPI Description](images/dok6-1.png)
+
+_Pipesymbolen kan med fördel användas när beskrivningen sträcker sig över flera rader eller stycken._
+
+![Exempelbild som visar att större än-tecknet kan använndas för att skriva beskrivningen över flera rader i en OpenAPI Description](images/dok6-2.png)
+
+_Större än-tecknet kan också användas när beskrivningen sträcker sig över flera rader eller stycken._
+
+---
+
 ### ID: DOK.07
 
 **Krav:** Dokumentationen av ett API BÖR innehålla övergripande information om API:et.
@@ -171,6 +208,66 @@ Regeln förutsätter att det finns en förekomst av objektet `info` med underlig
 
 ---
 
+### ID: DOK.08
+
+**Krav:** Ett API:s servicenivå SKALL finnas tydligt beskriven i dokumentationen.
+
+**Typ:** SKALL
+
+**JSON Path Plus-uttryck:**
+
+```
+$
+```
+
+**Förklaring:**
+Regeln förutsätter att det finns en förekomst av minst ett av objekten `info.termsOfService`, `info.x-sla` eller `externalDocs` med följande strukturer:
+
+- info
+
+  - termsOfService
+  - x-sla
+    - availability
+    - responseTime
+    - support
+
+- externalDocs
+  - description
+  - url
+
+`externalDocs.description` måste innehålla texten "service level agreement" eller "SLA", och `externalDocs.url` måste vara en giltig URL.
+
+**Exempel:**
+
+![Exempelbild på ovan nämnda objekts placering i en OpenAPI Description](images/dok8.png)
+
+_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.
@@ -359,9 +456,9 @@ Regeln kontrollerar att parametrar av typerna query och path inte använder föl
 
 **Exempel:**
 
-![Exempelbild på en resurs vars query-parameter använder ett ogiltigt namn](images/res02.png)
+![Exempelbild på hur parametrar anges på ett korrekt sätt i en OpenAPI Description](images/res02.png)
 
-_Query-parametern använder ett ogiltigt namn._
+_Exemplet ovan är giltigt då namnet på parametern inte är ett av ovanstående._
 
 ---
 
@@ -1008,7 +1105,30 @@ I exemplet ovan, så exemplifieras regeln med en kontroll av de query parametrar
 
 ## Område: Säkerhet
 
-**Täckningsgrad: 11%**
+**Täckningsgrad: 16%**
+
+### ID: SAK.01
+
+**Krav:** All transport SKALL ske över HTTPS med minst TLS 1.2.
+
+**Typ:** SKALL
+
+**JSON Path Plus-uttryck:**
+
+```
+$.servers
+```
+
+**Förklaring:**
+Regeln förutsätter att varje server har en giltig url specifierad och använder HTTPS-protokollet.
+
+**Exempel:**
+
+![Exempelbild på hur servrar anges på ett korrekt sätt i en OpenAPI Description](images/sak01.png)
+
+_Exemplet ovan är giltigt då samtliga servrar innehåller en giltig `url` och använder HTTPS._
+
+---
 
 ### ID: SAK.09
 
@@ -1079,6 +1199,31 @@ I exemplet ovan ger regeln ett negativt utfall, eftersom det definierade säkerh
 
 ---
 
+---
+
+### ID: SAK.16
+
+**Krav:** API-nycklar SKALL inkluderas i HTTP-headern eftersom querysträngar kan sparas av klienten eller servern i okrypterat format av webbläsaren eller serverapplikationen.
+
+**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' endast vara satt till 'header'.
+
+**Exempel:**
+
+![alt text](images/sak16.png)
+
+I exemplet ovan ger regeln ett positivt utfall, eftersom det definierade säkerhetsschemat 'ApiKeyQuery' har typen 'apiKey' och parametern 'in' är satt till 'header', vilket är i linje med regeln.
+
+---
+
 ### ID: SAK.18
 
 **Krav:** OAuth version 2.0 eller senare BÖR användas för auktorisation.

REUSE.toml

@@ -31,7 +31,11 @@ path = [
     "images/dok19.png",
     "images/dok20.png",
     "images/dok3.png",
+    "images/dok6-1.png",
+    "images/dok6-2.png",
     "images/dok7.png",
+    "images/dok8.png",
+    "images/dok9.png",
     "images/dot1-2.png",
     "images/dot1.png",
     "images/dot4.png",
@@ -51,9 +55,11 @@ path = [
     "images/res06-1.png",
     "images/res06-2.png",
     "images/rest-api-profil.png",
+    "images/sak01.png",
     "images/sak09.png",
     "images/sak10.png",
     "images/sak15.png",
+    "images/sak16.png",
     "images/sak18.png",
     "images/ufn1-2.png",
     "images/ufn1.png",

apis/dok-api.yaml

@@ -6,7 +6,14 @@ openapi: '3.0.0'
 info:
   version: 1.0.0
   title: AME
-  description: API message
+  description: >
+    När dokumentationen består av flera stycken kan också större än-tecknet användas.
+    Då ersätts radbrytningar med mellanslag.
+    Tomma rader bevaras däremot som styckeavgränsare.
+
+    When the documentation consists of multiple paragraphs, the greater-than operator can be used.
+    This converts line breaks into spaces.
+    However, empty lines are preserved as paragraph separators.
   termsOfService: http://swagger.io/terms/
   contact:
     name: Swagger API Team

apis/sak-api.yaml

@@ -120,6 +120,11 @@ components:
       type: apiKey
       in: query
       name: api_key
+    #Test for invalid types in security schemes
+    ApiKeyQuery2: 
+      type: apiKey
+      in: header
+      name: api_key2
 
 
   schemas:

development/code_quality.sh

@@ -48,7 +48,7 @@ store_exit_code() {
 lint_and_format() {
   export MEGALINTER_DEF_WORKSPACE='/repo'
   print_header 'LINTER HEALTH (MEGALINTER)'
-  podman run --rm --volume "$(pwd)":/repo -e MEGALINTER_CONFIG='development/megalinter.yml' -e DEFAULT_WORKSPACE=${MEGALINTER_DEF_WORKSPACE} -e LOG_LEVEL=INFO ghcr.io/oxsecurity/megalinter-javascript:v8.7.0
+  podman run --rm --volume "$(pwd)":/repo -e MEGALINTER_CONFIG='development/megalinter.yml' -e DEFAULT_WORKSPACE=${MEGALINTER_DEF_WORKSPACE} -e LOG_LEVEL=INFO ghcr.io/oxsecurity/megalinter-javascript:v8.8.0
   store_exit_code "$?" "Lint" "${MISSING} ${RED}Lint check failed, see logs (std out and/or ./megalinter-reports) and fix problems.${NC}\n" "${GREEN}${CHECKMARK}${CHECKMARK} Lint check passed${NC}\n"
   printf '\n\n'
 }
@@ -70,6 +70,13 @@ commit() {
   printf '\n\n'
 }
 
+license() {
+  print_header 'LICENSE HEALTH (REUSE)'
+  podman run --rm --volume "$(pwd)":/data docker.io/fsfe/reuse:5.0.2-debian lint
+  store_exit_code "$?" "License" "${MISSING} ${RED}License check failed, see logs and fix problems.${NC}\n" "${GREEN}${CHECKMARK}${CHECKMARK} License check passed${NC}\n"
+  printf '\n\n'
+}
+
 check_exit_codes() {
   printf '%b********* CODE QUALITY RUN SUMMARY ******%b\n\n' "${YELLOW}" "${NC}"
 
@@ -98,5 +105,6 @@ is_command_available 'npm' 'https://nodejs.org/'
 
 lint_and_format
 commit
+license
 
 check_exit_codes