Skip to content

Commit 809a1dc

Browse files
committed
docs: add documentation for rule DOK.10
Signed-off-by: Mats Johansson <extern.mats.johansson@digg.se>
1 parent c866e7f commit 809a1dc

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

GUIDELINES.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
3636
- [ID: DOK.07](#id-dok07)
3737
- [ID: DOK.08](#id-dok08)
3838
- [ID: DOK.09](#id-dok09)
39+
- [ID: DOK.10](#id-dok10)
3940
- [ID: DOK.11](#id-dok11)
4041
- [ID: DOK.15](#id-dok15)
4142
- [ID: DOK.17](#id-dok17)
@@ -92,7 +93,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
9293

9394
## Område: Dokumentation
9495

95-
**Täckningsgrad: 46%**
96+
**Täckningsgrad: 50%**
9697

9798
### ID: DOK.01
9899

@@ -271,6 +272,29 @@ _Ett av objekten räcker för att uppfylla regeln, men "limit", "begränsning" e
271272

272273
---
273274

275+
### ID: DOK.10
276+
277+
**Krav:** Om det är känt SKALL tidpunkt för när API:et tas ur bruk anges i dokumentationen.
278+
279+
**Typ:** SKALL
280+
281+
**JSON Path Plus-uttryck:**
282+
283+
```
284+
$.paths[*][*]
285+
```
286+
287+
**Förklaring:**
288+
Om en resurs innehåller attributet `deprecated` med värde `true`, så behöver det även finnas en förekomst av antingen `description` eller `x-deprecationDate` innehållandes ett datum. Datum kontrolleras genom en översättning till engelska av vissa keywords (t.ex. månadernas namn) och biblioteket [Chrono (v2)](https://www.npmjs.com/package/chrono-node).
289+
290+
**Exempel:**
291+
292+
![Exempelbild på en deprecated resurs som har ett datum för att tas ur bruk satt](images/dok10.png)
293+
294+
_Det är tillräckligt om antingen description eller x-deprecationDate innehåller ett datum._
295+
296+
---
297+
274298
### ID: DOK.11
275299

276300
**Krav:** Avsikten och beteendet hos API:et SKALL beskrivas så utförligt och tydligt som möjligt.

REUSE.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ path = [
3636
"images/dok7.png",
3737
"images/dok8.png",
3838
"images/dok9.png",
39+
"images/dok10.png",
3940
"images/dok11.png",
4041
"images/dot1-2.png",
4142
"images/dot1.png",

images/dok10.png

24.3 KB
Loading

0 commit comments

Comments
 (0)