Skip to content

Commit 567bef7

Browse files
dabrtdabrt
committed
IBX-9452: Describe segment and segment group REST endpoints (#2624)
* IBX-9452: Describe segment and segment group endpoints
1 parent 28624a6 commit 567bef7

23 files changed

+4110
-273
lines changed

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/POST/SegmentGroup.json.example‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"SegmentGroup": {
3+
"_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
4+
"_href": "/api/ibexa/v2/segment_groups/segment_group_identifier",
5+
"id": 3,
6+
"identifier": "segment_group_identifier",
7+
"name": "Segment Group Name"
8+
}
9+
}

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/POST/SegmentGroup.xml.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/segment_group_identifier">
3+
<id>3</id>
4+
<identifier>segment_group_identifier</identifier>
5+
<name>Segment Group Name</name>
6+
</SegmentGroup>

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/POST/SegmentGroupCreate.json.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"SegmentGroupCreate": {
3+
"identifier": "segment_group_identifier",
4+
"name": "Segment Group Name"
5+
}
6+
}

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/POST/SegmentGroupCreate.xml.example‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<SegmentGroupCreate>
3+
<identifier>segment_group_identifier</identifier>
4+
<name>Segment Group Name</name>
5+
</SegmentGroupCreate>

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/identifier/PATCH/SegmentGroup.json.example‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"SegmentGroup": {
3+
"_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
4+
"_href": "/api/ibexa/v2/segment_groups/modified_segment_group_identifier",
5+
"id": 3,
6+
"identifier": "modified_segment_group_identifier",
7+
"name": "Modified Segment Group Name"
8+
}
9+
}

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/identifier/PATCH/SegmentGroup.xml.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/modified_segment_group_identifier">
3+
<id>4</id>
4+
<identifier>modified_segment_group_identifier</identifier>
5+
<name>Modified Segment Group Name</name>
6+
</SegmentGroup>

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/identifier/PATCH/SegmentGroupUpdate.json.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"SegmentGroupUpdate": {
3+
"identifier": "modified_segment_group_identifier",
4+
"name": "Modified Segment Group Name"
5+
}
6+
}

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/identifier/PATCH/SegmentGroupUpdate.xml.example‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<SegmentGroupUpdate>
3+
<identifier>modified_segment_group_identifier</identifier>
4+
<name>Modified Segment Group Name</name>
5+
</SegmentGroupUpdate>

‎docs/api/rest_api/rest_api_reference/input/examples/segment_groups/identifier/segments/GET/SegmentList.json.example‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
"_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts\/segments",
55
"Segment": []
66
}
7-
}
7+
}

‎docs/api/rest_api/rest_api_reference/input/examples/segments/POST/Segment.json.example‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"Segment": {
3+
"_media-type": "application/vnd.ibexa.api.Segment+json",
4+
"_href": "/api/ibexa/v2/segments/segment_identifier",
5+
"id": 3,
6+
"identifier": "segment_identifier",
7+
"name": "Segment Name",
8+
"SegmentGroup": {
9+
"_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
10+
"_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
11+
}
12+
}
13+
}

0 commit comments

Comments
 (0)