-
Notifications
You must be signed in to change notification settings - Fork 2
/
driftsmelding-api.json
87 lines (87 loc) · 3.57 KB
/
driftsmelding-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
"openapi": "3.0.0",
"info": {"title": "Sosialhjelp driftsmeldinger", "version": "1.0"},
"servers": [{"url": "/sosialhjelp/driftsmeldinger", "description": "next-js"}],
"paths": {
"/api/status": {
"get": {
"description": "Hent liste med aktive driftsmeldinger",
"parameters": [
{
"in": "query",
"name": "audience",
"schema": {"type": "string", "enum": ["soknad", "innsyn", "modia"]},
"required": true,
"description": "Publikum for driftsmeldinger"
}
],
"responses": {
"200": {
"description": "En liste av aktive driftsmeldinger",
"content": {
"application/json": {
"schema": {"type": "array", "items": {"$ref": "#/components/schemas/Driftsmelding"}}
}
}
},
"400": {"description": "Ugyldig eller manglende målgruppeparameter"}
}
}
}
},
"components": {
"schemas": {
"Driftsmelding": {
"type": "object",
"required": [
"id",
"text",
"severity",
"createdAt",
"visibleInSoknad",
"visibleInInnsyn",
"visibleInModia"
],
"properties": {
"id": {"type": "integer"},
"severity": {"$ref": "#/components/schemas/Severity"},
"text": {
"description": "Teksten som skal vises i driftsmeldingen, i Markdown-format",
"type": "string"
},
"createdAt": {"type": "string", "format": "date-time"},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Driftsmeldingen utløper (blir usynlig) etter dato"
},
"publishedAt": {
"type": "string",
"format": "date-time",
"description": "Driftsmeldingen blir først synlig etter dato"
},
"visibleInSoknad": {"description": "Driftsmeldingen skal vises i søknad", "type": "boolean"},
"visibleInInnsyn": {"description": "Driftsmeldingen skal vises i innsyn", "type": "boolean"},
"visibleInModia": {"description": "Driftsmeldingen skal vises i modia", "type": "boolean"}
},
"example": {
"id": 1,
"severity": "info",
"text": "Dette er en driftsmelding",
"createdAt": "2021-09-01T12:00:00Z",
"expiresAt": "2022-09-01T12:00:00Z",
"visibleInSoknad": true,
"visibleInInnsyn": true,
"visibleInModia": true
}
},
"Severity": {
"description": "Hvordan driftsmeldingen skal vises; samsvarer med Aksel sin Alert-komponent",
"type": "string",
"enum": ["info", "success", "error", "warning"],
"example": "info"
}
}
},
"tags": []
}