IBX-9058: Complete REST API Reference

[adriendupuis]

Question	Answer
JIRA Ticket
Versions	master (5.0), 4.6
Edition

Complete REST API Reference entries in parallel with OpenAPI

Previews:

• GET /user/users/{userId}/segments
• POST /user/users/{userId}/segments
• DELETE /user/users/{userId}/segments/{segmentIdentifier}
• PATCH /cart/{identifier}
• POST /cart/{identifier}/entry
• DELETE /cart/{identifier}/entry/{entryId}
• PATCH /cart/{identifier}/entry/{entryId}

OpenAPI equivalents:

• ibexa/segmentation#125
• ibexa/cart#124

Related

• IBX-9058: Complete REST API rest#161

Checklist

• Text renders correctly
• Text has been checked with vale
• Description metadata is up to date
• Redirects cover removed/moved pages
• Code samples are working
• PHP code samples have been fixed with PHP CS fixer
• Added link to this PR in relevant JIRA ticket or code PR

[github-actions]

Preview of modified Markdown: no Markdown change to preview.

[github-actions]

Preview of modified files: no change to preview.

[mnocon]

Thank you for taking care of this!

[mnocon]

In JSON this part is an array, how to pass multiple segments in XML?

I've tried something like this:

<UserSegmentAssignInput>
    <segments><segment>TestSegment4</segment><segment>TestSegment5</segment></segments>
</UserSegmentAssignInput>

and received:

<?xml version="1.0" encoding="UTF-8"?>
<ErrorMessage media-type="application/vnd.ibexa.api.ErrorMessage+xml">
    <errorCode>406</errorCode>
    <errorMessage>Not Acceptable</errorMessage>
    <errorDescription>Argument 'segments[segment]' is invalid: expected a string</errorDescription>
    <trace>#0 /Users/marek/Desktop/Sites/instance1/vendor/ibexa/rest/src/contracts/Input/ParsingDispatcher.php(111): Ibexa\Bundle\Segmentation\REST\Input\Parser\UserSegmentAssignInput-&gt;parse(Array, Object(Ibexa\Contracts\Rest\Input\ParsingDispatcher))
#1 /Users/marek/Desktop/Sites/instance1/vendor/ibexa/rest/src/contracts/Input/ParsingDispatcher.php(86): Ibexa\Contracts\Rest\Input\ParsingDispatcher-&gt;internalParse(Array, 'application/vnd...')
#2 /Users/marek/Desktop/Sites/instance1/vendor/ibexa/rest/src/lib/Input/Dispatcher.php(115): Ibexa\Contracts\Rest\Input\ParsingDispatcher-&gt;parse(Array, 'application/vnd...'

So maybe it's not possible?

[adriendupuis]

I have no idea.