Skip to content

Commit 826f5c9

Browse files
committed
docs: add MogRules to README.md
Signed-off-by: Mats Johansson <extern.mats.johansson@digg.se>
1 parent 02c730c commit 826f5c9

File tree

1 file changed

+45
-16
lines changed

1 file changed

+45
-16
lines changed

README.md

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!--
22
SPDX-FileCopyrightText: 2025 diggsweden/rest-api-profil-lint-processor
33
4-
SPDX-License-Identifier: CC0-1.0
4+
SPDX-License-Identifier: CC0-1.0
55
-->
66

77
# REST API-profil - Lint Processor (RAP-LP)
8-
[![Tag](https://img.shields.io/github/v/tag/diggsweden/rest-api-profil-lint-processor?style=for-the-badge&sort=semver&filter=%21*-*&color=green)](https://github.com/diggsweden/rest-api-profil-lint-processor/tags)
98

9+
[![Tag](https://img.shields.io/github/v/tag/diggsweden/rest-api-profil-lint-processor?style=for-the-badge&sort=semver&filter=%21*-*&color=green)](https://github.com/diggsweden/rest-api-profil-lint-processor/tags)
1010

1111
[![License: EUPL 1.2](https://img.shields.io/badge/License-European%20Union%20Public%20Licence%201.2-library?style=for-the-badge&&color=lightblue)](LICENSE)
1212
[![REUSE](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.reuse.software%2Fstatus%2Fgithub.com%2Fdiggsweden%2Frest-api-profil-lint-processor&query=status&style=for-the-badge&label=REUSE&color=lightblue)](https://api.reuse.software/info/github.com/diggsweden/rest-api-profil-lint-processor)
@@ -41,18 +41,21 @@ Verktyget är specifikt utvecklat för att linta OpenAPI-definitioner enligt den
4141
Förutsätter att det finns en `openapi.yaml` att validera i den aktuella katalogen och beroende på hur man önskar att nyttja verktyget måste det finns installerade versioner av `Node.js`,`npm`, `Podman` eller `Docker`.
4242

4343
### NPM
44+
4445
> Notera: Att GitHub Packages (npm) kräver authentisering.<br>
4546
> Konfigurera `.npmrc` mot rätt registry och scope, antingen globalt eller lokalt för enskilda projekt - `@diggsweden:registry=https://npm.pkg.github.com`<br>
4647
> Om du saknar inloggning med GitHub Personal access token (PAT), se [FAQ](#hur-skapar-jag-ett-github-personal-access-token-pat).
4748
4849
> Notera: Att `<version>` byts ut mot önskad version av verktyget, oftast senaste release tag. För mer information se [versioner](#versioner).
4950
5051
#### Installera globalt med npm:
52+
5153
```bash
5254
npm i -g @diggsweden/rest-api-profil-lint-processor@<version>
5355
raplp -f openapi.yaml
5456
```
55-
> Notera: Att en omstart av terminal kan behövas för att `raplp` ska kunna användas som kommando.
57+
58+
> Notera: Att en omstart av terminal kan behövas för att `raplp` ska kunna användas som kommando.
5659
5760
#### Installera lokalt som `npm run` script
5861

@@ -75,48 +78,60 @@ Lägg till ett [`npm run` script](https://docs.npmjs.com/cli/run-script) i din `
7578
Nu kan du använda `npm run lint-processor`.
7679

7780
### NPX
81+
7882
Kör utan installation och package.json:
83+
7984
```bash
8085
npx @diggsweden/rest-api-profil-lint-processor@<version> -f openapi.yaml
8186
```
8287

8388
> Notera: Att npx laddar ned paketet till en tillfällig cache-mapp om det inte redan finns en version i node_modules/.bin
8489
8590
### Podman
91+
8692
Kör med podman:
93+
8794
```bash
8895
podman run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml
8996
```
9097

9198
### Docker
99+
92100
Kör med docker:
101+
93102
```bash
94103
docker run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml
95104
```
105+
96106
> Notera: Sökvägar kan hanteras olika beroende på miljö:
107+
>
97108
> - Podman (Linux/macOS/WSL): -v $(pwd):/app/example
98109
> - Docker (PowerShell): -v "${PWD}:/app/example"
99110
> - Docker (CMD): -v %cd%:/app/example
100111
101112
### Bygga från källkod
113+
102114
1. Klona ned projektet, gärna från senaste release tag.
103115
2. Installera alla beroenden:
104116

105117
```bash
106118
npm install
107119
npm start -- -f openapi.yaml
108120
```
121+
109122
> Notera: Att alla kommandon lokalt körs med `npm start --`.
110123
111124
## Versioner
112-
Main-branchen, feature-brancher, pre-release- och testversioner används med reservation för att de kan innehålla funktionalitet som inte är garanterad att den är testad på samma sätt som en stabil version.
125+
126+
Main-branchen, feature-brancher, pre-release- och testversioner används med reservation för att de kan innehålla funktionalitet som inte är garanterad att den är testad på samma sätt som en stabil version.
113127

114128
**Stabila versioner**<br>
115129
[Release](https://github.com/diggsweden/rest-api-profil-lint-processor/releases) ska alltid vara stabil och testad, vilket gör den till den föredragna versionen för att nyttja verktyget.<br>
116130
Dessa versioner är taggade med `vX.X.X` utan något suffix.
117131

118132
**Pre-release- och testversioner**<br>
119133
Pre-release-versioner är taggade med följande suffix:
134+
120135
- alpha → tidig testversion, ofta instabil
121136
- beta → mer testad, men fortfarande pre-release
122137
- rc → nära färdigställande, stabil release candidate
@@ -125,35 +140,40 @@ Rena testversioner är taggade med `vX.X.X-dev` följt av namnet på den branche
125140
Dessa versioner är byggda för att testa funktionalitet som är under utveckling.
126141

127142
Alla versioner av verktyget hittar du här:
143+
128144
- [Container Image](https://github.com/diggsweden/rest-api-profil-lint-processor/pkgs/container/rest-api-profil-lint-processor)
129145
- [NPM Package](https://github.com/diggsweden/rest-api-profil-lint-processor/pkgs/npm/rest-api-profil-lint-processor)
130146

131147
## Användning
148+
132149
Här beskrivs vilka användningsområden verktyget har med diverse flaggor som kan sättas för att nyttja verktygets funktionalitet.
133150

134151
### Tillgängliga flaggor
135152

136-
| Flagga | Beskrivning | Typ | Standard | Obligatorisk |
137-
|---|---|---|---|---|
138-
| `-f, --file` | Sökväg till OpenAPI-specifikation (YAML/JSON). | string || Ja |
139-
| `-c, --categories` | Regelkategorier separerade med kommatecken. Tillgängliga: `UfnRules, SakRules, VerRules, FnsRules, ArqRules, DokRules, AmeRules, ForRules, DotRules, FelRules`. | string || Nej |
140-
| `-l, --logError` | Sökväg till fil för felloggning från RAP-LP. Om inte angiven skrivs loggen till stdout. | string | stdout (om ej satt) | Nej |
141-
| `-a, --append` | Append—utökar loggen i befintlig felloggningsfil (om `--logError` används). | boolean | `false` | Nej |
142-
| `-d, --logDiagnostic` | Sökväg till fil för diagnostiseringsinformation från RAP-LP i JSON-format. | string || Nej |
143-
| `--dex` | Sökväg till fil för diagnostiseringsinformation från RAP-LP i Excel-format. | string || Nej |
144-
153+
| Flagga | Beskrivning | Typ | Standard | Obligatorisk |
154+
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------- | ------------ |
155+
| `-f, --file` | Sökväg till OpenAPI-specifikation (YAML/JSON). | string || Ja |
156+
| `-c, --categories` | Regelkategorier separerade med kommatecken. Tillgängliga: `UfnRules, SakRules, VerRules, FnsRules, ArqRules, DokRules, AmeRules, ForRules, DotRules, FelRules, MogRules`. | string || Nej |
157+
| `-l, --logError` | Sökväg till fil för felloggning från RAP-LP. Om inte angiven skrivs loggen till stdout. | string | stdout (om ej satt) | Nej |
158+
| `-a, --append` | Append—utökar loggen i befintlig felloggningsfil (om `--logError` används). | boolean | `false` | Nej |
159+
| `-d, --logDiagnostic` | Sökväg till fil för diagnostiseringsinformation från RAP-LP i JSON-format. | string || Nej |
160+
| `--dex` | Sökväg till fil för diagnostiseringsinformation från RAP-LP i Excel-format. | string || Nej |
145161

146162
> Notera: Att `raplp` i alla kommandon nedan ersätts med respektive miljös sätt att köra verktyget (npm, docker eller podman).
147163
148164
### Validering med alla regler
165+
149166
För att validera en openapi-definition med verktyget, lägg till `-f <YAML_FILE>`
167+
150168
```bash
151169
raplp -f openapi.yaml
152170
```
153171

154172
### Validering med utvalda regler
173+
155174
För att validera mot en specifik kategori av regler, lägg till `-c <CategoryName>`.<br>
156-
>Notera: Att du kan lägga till flera regler som en kommaseparerad lista.
175+
176+
> Notera: Att du kan lägga till flera regler som en kommaseparerad lista.
157177
158178
```bash
159179
# Validera mot en specifik regel
@@ -172,24 +192,30 @@ raplp -f openapi.yaml -c DokRules,AmeRules,SakRules
172192
- FelRules
173193
- FnsRules
174194
- ForRules
195+
- MogRules
175196
- ResRules
176197
- SakRules
177198
- UfnRules
178199
- VerRules
179200

180201
### Validering som skriver felmeddelanden till en valfri loggfil
202+
181203
För att skriva felmeddelanden till en valfri loggfil, lägg till `-l <FILE>`
204+
182205
```bash
183206
raplp -f openapi.yaml -l raplp.log
184207
```
208+
185209
> Notera: Att varje körning skriver över den tidigare loggfilen.
186210
187211
För att lägga till loggning i samma fil, lägg till `-a`
212+
188213
```bash
189214
raplp -f openapi.yaml -l raplp.log -a
190215
```
191216

192217
### Validering som sparar loggdiagnostik i en fil
218+
193219
För att spara loggdiagnostik i en fil, lägg till `-d <FILE>`
194220

195221
```bash
@@ -217,6 +243,7 @@ raplp -f openapi.yaml --dex <PATH>
217243
```
218244

219245
### Visa information version
246+
220247
För att visa aktuell version av verktyget, lägg till `--version`
221248

222249
```bash
@@ -230,8 +257,8 @@ raplp --help
230257
```
231258

232259
### Riktlinjer och förklaringar
233-
Vill du veta mer om de specifika reglerna som verktyget tillämpar, se avsnittet [GUIDELINES](GUIDELINES.md) för detaljer.
234260

261+
Vill du veta mer om de specifika reglerna som verktyget tillämpar, se avsnittet [GUIDELINES](GUIDELINES.md) för detaljer.
235262

236263
### Förklaring av översikt för regelutfall
237264

@@ -285,7 +312,9 @@ Kravet har bedömts ha allvarlighetsgraden Warning eftersom API:et bryter mot et
285312
Om du har frågor, funderingar, buggrapporter etc, vänligen kontakta [Digg - Agency for Digital Government](https://www.digg.se/)
286313

287314
## FAQ
315+
288316
### Hur skapar jag ett GitHub Personal Access Token (PAT)?
317+
289318
1. Gå till GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic) → Generate new token → Generate new token (classic).
290319
2. Sätt en beskrivning för ditt token under `Note` och ett utgångsdatum under `Expiration` (ha utgångsdatum!).
291320
3. Select scopes → read:packages
@@ -329,4 +358,4 @@ Licens: [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)
329358

330359
Speciellt tack till
331360

332-
- [Arbetsförmedlingen – The Swedish Public Employment Service](https://arbetsformedlingen.se/)
361+
- [Arbetsförmedlingen – The Swedish Public Employment Service](https://arbetsformedlingen.se/)

0 commit comments

Comments
 (0)