Skip to content

Commit 8687bb2

Browse files
committed
docs: add documentation for rule MOG.02
Signed-off-by: Mats Johansson <extern.mats.johansson@digg.se>
1 parent ea10a14 commit 8687bb2

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

GUIDELINES.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ I exemplet ovan, så utgör fältet `url` under serverobjektet, samt objektet `p
669669

670670
## Område: Mognad
671671

672-
**Täckningsgrad: 33%**
672+
**Täckningsgrad: 66%**
673673

674674
### ID: MOG.01
675675

@@ -694,6 +694,33 @@ _Exemplet ovan är giltigt då `GET` är en av metoderna som listades ovan._
694694

695695
---
696696

697+
### ID: MOG.02
698+
699+
**Krav:** Alla API:er BÖR samtidigt designas för att uppnå nivå 3 enligt Richardson Maturity Model.
700+
701+
**Typ:** BÖR
702+
703+
**JSON Path Plus-uttryck:**
704+
705+
```
706+
$.paths
707+
```
708+
709+
**Förklaring:**
710+
Regeln går igenom alla paths och kontrollerar följande:
711+
712+
1. att de är minst två till antalet
713+
2. att varje path innehåller minst två metoder
714+
3. att varje path innehåller minst en av metoderna GET, POST, PUT, DELETE eller PATCH
715+
716+
**Exempel:**
717+
718+
![Exempelbild på en resurs som innehåller allt som krävs för att uppfylla regeln.](images/mog02.png)
719+
720+
_Exemplet ovan är giltigt då det uppfyller samtliga krav._
721+
722+
---
723+
697724
## Område: API Message
698725

699726
**Täckningsgrad: 71%**

REUSE.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ path = [
5353
"images/fns08.png",
5454
"images/fns09.png",
5555
"images/mog01.png",
56+
"images/mog02.png",
5657
"images/res02.png",
5758
"images/res06-1.png",
5859
"images/res06-2.png",

images/mog02.png

38.4 KB
Loading

0 commit comments

Comments
 (0)