Skip to content

Commit 08937a6

Browse files
committed
docs: add documentation for rule MOG.01
Signed-off-by: Mats Johansson <extern.mats.johansson@digg.se>
1 parent 48dae50 commit 08937a6

File tree

3 files changed

+44
-14
lines changed

3 files changed

+44
-14
lines changed

GUIDELINES.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,38 +54,40 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
5454
- [ID: UFN.07](#id-ufn07)
5555
- [ID: UFN.08](#id-ufn08)
5656
- [ID: UFN.09](#id-ufn09)
57-
5. [Område: API Message](#område-api-message)
57+
5. [Område: Mognad](#område-mognad)
58+
- [ID: MOG.01](#id-mod01)
59+
6. [Område: API Message](#område-api-message)
5860
- [ID: AME.01](#id-ame01)
5961
- [ID: AME.02](#id-ame02)
6062
- [ID: AME.04](#id-ame04)
6163
- [ID: AME.05](#id-ame05)
6264
- [ID: AME.07](#id-ame07)
63-
6. [Område: API Request](#område-api-request)
65+
7. [Område: API Request](#område-api-request)
6466
- [ID: ARQ.01](#id-arq01)
6567
- [ID: ARQ.03](#id-arq03)
6668
- [ID: ARQ.05](#id-arq05)
67-
7. [Område: Felhantering](#område-felhantering)
69+
8. [Område: Felhantering](#område-felhantering)
6870
- [ID: FEL.01](#id-fel01)
6971
- [ID: FEL.02](#id-fel02)
70-
8. [Område: Versionhantering](#område-versionhantering)
72+
9. [Område: Versionhantering](#område-versionhantering)
7173
- [ID: VER.05](#id-ver05)
7274
- [ID: VER.06](#id-ver06)
73-
9. [Område: Filtrering, paginering och sökparametrar](#område-filtrering-paginering-och-sökparametrar)
74-
- [ID: FNS.01](#id-fns01)
75-
- [ID: FNS.03](#id-fns03)
76-
- [ID: FNS.05](#id-fns05)
77-
- [ID: FNS.06](#id-fns06)
78-
- [ID: FNS.07](#id-fns07)
79-
- [ID: FNS.08](#id-fns08)
80-
- [ID: FNS.09](#id-fns09)
81-
10. [Område: Säkerhet](#område-säkerhet)
75+
10. [Område: Filtrering, paginering och sökparametrar](#område-filtrering-paginering-och-sökparametrar)
76+
- [ID: FNS.01](#id-fns01)
77+
- [ID: FNS.03](#id-fns03)
78+
- [ID: FNS.05](#id-fns05)
79+
- [ID: FNS.06](#id-fns06)
80+
- [ID: FNS.07](#id-fns07)
81+
- [ID: FNS.08](#id-fns08)
82+
- [ID: FNS.09](#id-fns09)
83+
11. [Område: Säkerhet](#område-säkerhet)
8284
- [ID: SAK.01](#id-sak01)
8385
- [ID: SAK.09](#id-sak09)
8486
- [ID: SAK.10](#id-sak10)
8587
- [ID: SAK.15](#id-sak15)
8688
- [ID: SAK.16](#id-sak16)
8789
- [ID: SAK.18](#id-sak18)
88-
11. [Område: Förutsättningar](#område-förutsättningar)
90+
12. [Område: Förutsättningar](#område-förutsättningar)
8991
- [ID: FOR.02](#id-for02)
9092

9193
## Område: Dokumentation
@@ -665,6 +667,33 @@ I exemplet ovan, så utgör fältet `url` under serverobjektet, samt objektet `p
665667

666668
---
667669

670+
## Område: Mognad
671+
672+
**Täckningsgrad: 33%**
673+
674+
### ID: MOG.01
675+
676+
**Krav:** Alla API:er SKALL designas för att uppnå nivå 2 enligt Richardson Maturity Model.
677+
678+
**Typ:** SKALL
679+
680+
**JSON Path Plus-uttryck:**
681+
682+
```
683+
$.paths[*]
684+
```
685+
686+
**Förklaring:**
687+
Regeln går igenom alla paths och kontrollerar så att minst en av metoderna GET, POST, PUT, DELETE eller PATCH finns definerade per path.
688+
689+
**Exempel:**
690+
691+
![Exempelbild på en resurs med en GET-metod definierad i en OpenAPI description.](images/mog01.png)
692+
693+
_Exemplet ovan är giltigt då `GET` är en av metoderna som listades ovan._
694+
695+
---
696+
668697
## Område: API Message
669698

670699
**Täckningsgrad: 71%**

REUSE.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ path = [
5252
"images/fns07.png",
5353
"images/fns08.png",
5454
"images/fns09.png",
55+
"images/mog01.png",
5556
"images/res02.png",
5657
"images/res06-1.png",
5758
"images/res06-2.png",

images/mog01.png

19.3 KB
Loading

0 commit comments

Comments
 (0)