Skip to content

Commit 40d6f44

Browse files
docs: improve docs with more line breaks
Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>
1 parent 2e02bb1 commit 40d6f44

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ SPDX-License-Identifier: CC0-1.0
1717

1818
**Beskrivning**:
1919

20-
RAP-LP är ett kommandoradsverktyg för att linta OpenAPI v3-definitioner med hjälp av [Spectral](https://github.com/stoplightio/spectral). Verktyget är specifikt utvecklat för att linta OpenAPI-definitioner enligt den svenska REST API-profilens specifikation [REST API-profil](https://dev.dataportal.se/rest-api-profil).
20+
RAP-LP är ett kommandoradsverktyg för att linta OpenAPI v3-definitioner med hjälp av [Spectral](https://github.com/stoplightio/spectral).<br>
21+
Verktyget är specifikt utvecklat för att linta OpenAPI-definitioner enligt den svenska REST API-profilens specifikation [REST API-profil](https://dev.dataportal.se/rest-api-profil).
2122

2223
## Innehållsförteckning
2324

@@ -121,9 +122,10 @@ npm start -- -f apis/dok-api.yaml -d logDiagnostic.log
121122

122123
För att spara information om regelutfall från diagnostiseringen till en avstämningsfil i Excel, lägg till --dex.
123124

124-
Om en specifik sökväg till avstämningsfilen ska anges, kan denna läggas till. Om ingen sökväg anges, genererar verktyget automatiskt en ny avstämningsfil i den katalog där det körs.
125+
Om en specifik sökväg till avstämningsfilen ska anges, kan denna läggas till.<br>
126+
Om ingen sökväg anges, genererar verktyget automatiskt en ny avstämningsfil i den katalog där det körs.
125127

126-
Avstämningsfilen i Excel har ett fast format. Om en egen version av filen ska användas, måste den utpekade resursen hämtas med en kompatibel version av REST API-profilen.
128+
Avstämningsfilen i Excel har ett fast format, om en egen version av filen ska användas måste den utpekade resursen hämtas med en kompatibel version av REST API-profilen.
127129

128130
**Exempel utan sökväg till avstämningsfil i Excel**
129131

@@ -191,7 +193,8 @@ Exempel
191193
podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/rap-lp.log --dex example/avstamning.xlsx
192194
```
193195

194-
Vid eventuella fel och du inte hittar rap-lp-error.log kan du behöva köra kommandot via containern enligt den alternativa instruktionen nedan. Se till att containern har rättigheter att skriva till den katalog som du mountar, se [Skrivåtkomst till mount från container](#skrivåtkomst-till-mount-från-container).
196+
Vid eventuella fel och du inte hittar rap-lp-error.log kan du behöva köra kommandot via containern enligt den alternativa instruktionen nedan.<br>
197+
Se till att containern har rättigheter att skriva till den katalog som du mountar, se [Skrivåtkomst till mount från container](#skrivåtkomst-till-mount-från-container).
195198

196199
#### Alternativ att köra ifrån containern
197200
1. Starta en podman container:
@@ -242,7 +245,8 @@ Vill du veta mer om de specifika reglerna som verktyget tillämpar, se avsnittet
242245

243246
### Förklaring av översikt för regelutfall
244247

245-
Om man väljer att köra verktyget i console läge, så kommer diagnostiseringsinformationen på stdout. I denna så kommer en sammanställning av det totala regelutfallet att visas.
248+
Om man väljer att köra verktyget i console läge, så kommer diagnostiseringsinformationen på stdout.<br>
249+
I denna så kommer en sammanställning av det totala regelutfallet att visas.
246250

247251
- Verkställda och godkända regler:
248252
- OK = Krav bedömt och hanterat för att möta kravet
@@ -255,7 +259,9 @@ Om man väljer att köra verktyget i console läge, så kommer diagnostiseringsi
255259

256260
![alt text](document/instructions/images/regelutfall.png)
257261

258-
I exemplet ovan framgår det att kraven för reglerna AME.05 och VER.05 är godkända och att det aktuella API:et uppfyller dessa. Däremot är kravet för regeln DOK.03 inte godkänt, vilket innebär att API:et inte möter detta krav. Dessutom framgår det att reglerna SAK.10 och DOK.01 inte är tillämpade för det aktuella API:et.
262+
I exemplet ovan framgår det att kraven för reglerna AME.05 och VER.05 är godkända och att det aktuella API:et uppfyller dessa.<br>
263+
Däremot är kravet för regeln DOK.03 inte godkänt, vilket innebär att API:et inte möter detta krav.<br>
264+
Dessutom framgår det att reglerna SAK.10 och DOK.01 inte är tillämpade för det aktuella API:et.
259265

260266
**Förklaring av detaljering för regelutfall:**
261267

@@ -272,9 +278,13 @@ Tillsammans med diagnostiseringsinformationen följer en detaljerad beskrivning
272278

273279
![alt text](document/instructions/images/regelutfall-2.png)
274280

275-
I exemplet ovan framgår det att kravet för regeln DOK.01 inte är godkänt och att det aktuella API:et inte uppfyller detta. Kravet har bedömts ha allvarlighetsgraden Error eftersom API:et bryter mot ett SKALL/SKALL INTE-krav i REST API-profilen. Det finns också information om var i den aktuella OpenAPI-specifikationen problemet återfinns.
281+
I exemplet ovan framgår det att kravet för regeln DOK.01 inte är godkänt och att det aktuella API:et inte uppfyller detta.<br>
282+
Kravet har bedömts ha allvarlighetsgraden Error eftersom API:et bryter mot ett SKALL/SKALL INTE-krav i REST API-profilen.<br>
283+
Det finns också information om var i den aktuella OpenAPI-specifikationen problemet återfinns.
276284

277-
Vidare framgår det att kravet för regeln DOK.03 inte är godkänt och att det aktuella API:et inte möter detta krav. Kravet har bedömts ha allvarlighetsgraden Warning eftersom API:et bryter mot ett BÖR/BÖR INTE-krav i REST API-profilen. Även här finns information om var i den aktuella OpenAPI-specifikationen problemet återfinns.
285+
Vidare framgår det att kravet för regeln DOK.03 inte är godkänt och att det aktuella API:et inte möter detta krav.<br>
286+
Kravet har bedömts ha allvarlighetsgraden Warning eftersom API:et bryter mot ett BÖR/BÖR INTE-krav i REST API-profilen.<br>
287+
Även här finns information om var i den aktuella OpenAPI-specifikationen problemet återfinns.
278288

279289
## Begränsningar
280290

0 commit comments

Comments
 (0)