Skip to content

Commit 643dc65

Browse files
committed
docs: update documentation
Signed-off-by: Mats Johansson <extern.mats.johansson@digg.se>
1 parent 19e6ea5 commit 643dc65

File tree

6 files changed

+17
-3
lines changed

6 files changed

+17
-3
lines changed

GUIDELINES.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,13 @@ Regeln förutsätter att det finns en förekomst av objektet `info` med underlig
169169

170170
**Exempel:**
171171

172-
![Exempelbild som visar var description ska finnas i en OpenAPI Description](images/dok6.png)
172+
![Exempelbild som visar att pipesymbolen kan användas för att skriva beskrivningen över flera rader i en OpenAPI Description](images/dok6-1.png)
173+
174+
_Pipesymbolen kan med fördel användas när beskrivningen sträcker sig över flera rader eller stycken._
175+
176+
![Exempelbild som visar att större än-tecknet kan använndas för att skriva beskrivningen över flera rader i en OpenAPI Description](images/dok6-2.png)
177+
178+
_Större än-tecknet kan också användas när beskrivningen sträcker sig över flera rader eller stycken._
173179

174180
---
175181

REUSE.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ path = [
3131
"images/dok19.png",
3232
"images/dok20.png",
3333
"images/dok3.png",
34-
"images/dok6.png",
34+
"images/dok6-1.png",
35+
"images/dok6-2.png",
3536
"images/dok7.png",
3637
"images/dot1-2.png",
3738
"images/dot1.png",

apis/dok-api.yaml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@ openapi: '3.0.0'
66
info:
77
version: 1.0.0
88
title: AME
9-
description: API message
9+
description: >
10+
När dokumentationen består av flera stycken kan också större än-tecknet användas.
11+
Då ersätts radbrytningar med mellanslag.
12+
Tomma rader bevaras däremot som styckeavgränsare.
13+
14+
When the documentation consists of multiple paragraphs, the greater-than operator can be used.
15+
This converts line breaks into spaces.
16+
However, empty lines are preserved as paragraph separators.
1017
termsOfService: http://swagger.io/terms/
1118
contact:
1219
name: Swagger API Team

images/dok6-1.png

93.9 KB
Loading

images/dok6-2.png

121 KB
Loading

images/dok6.png

-30 KB
Binary file not shown.

0 commit comments

Comments
 (0)