Skip to content

Commit d8e394e

Browse files
authored
Change names to be more consistent. (#42)
Ticket: ANFEPA-3680 Changelog: changed
1 parent 8819faf commit d8e394e

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/optional-features.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Wenn das FdV einen Aufruf der Operation ``*GET* /channels/v1/{pushkey}`` durchf
5454
Die Liste kann so aussehen:
5555
[cols="1,1"]
5656
|===
57-
|event_id|Status
57+
|`id`|`status``
5858

5959
|`document.create`
6060
|`enabled`
@@ -74,15 +74,15 @@ Oder als JSON:
7474
{
7575
"channel": [
7676
{
77-
"event_id": "document.create",
77+
"id": "document.create",
7878
"status": "enabled"
7979
},
8080
{
81-
"event_id": "document.read",
81+
"id": "document.read",
8282
"status": "disabled"
8383
},
8484
{
85-
"event_id": "document.delete",
85+
"id": "document.delete",
8686
"status": "enabled"
8787
}
8888
]

docs_sources/definitions/channels_post.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ examples:
33
value: {
44
"channels": [
55
{
6-
"name": "channel1",
7-
"value": "enabled"
6+
"id": "channel1",
7+
"status": "enabled"
88
},
99
{
10-
"name": "channel2",
11-
"value": "disabled"
10+
"id": "channel2",
11+
"status": "disabled"
1212
}
1313
]
1414
}
@@ -22,12 +22,12 @@ schema:
2222
items:
2323
type: object
2424
properties:
25-
name:
25+
id:
2626
type: string
2727
description: The name of the channel
28-
value:
28+
status:
2929
type: string
3030
enum: ["enabled", "disabled", "not_set"]
3131
required:
32-
- name
33-
- value
32+
- id
33+
- status

docs_sources/optional-features-source.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Wenn das FdV einen Aufruf der Operation ``*GET* /channels/v1/{pushkey}`` durchf
3838
Die Liste kann so aussehen:
3939
[cols="1,1"]
4040
|===
41-
|event_id|Status
41+
|`id`|`status``
4242

4343
|`document.create`
4444
|`enabled`
@@ -58,15 +58,15 @@ Oder als JSON:
5858
{
5959
"channel": [
6060
{
61-
"event_id": "document.create",
61+
"id": "document.create",
6262
"status": "enabled"
6363
},
6464
{
65-
"event_id": "document.read",
65+
"id": "document.read",
6666
"status": "disabled"
6767
},
6868
{
69-
"event_id": "document.delete",
69+
"id": "document.delete",
7070
"status": "enabled"
7171
}
7272
]

0 commit comments

Comments
 (0)