[MGNLREST-337] DOC: Operator OR needs to be encoded Created: 18/Nov/21  Updated: 09/Jun/23  Resolved: 26/May/23

Status: Closed
Project: Magnolia REST Framework
Component/s: delivery
Affects Version/s: 2.2.9
Fix Version/s: None

Type: Bug Priority: Neutral
Reporter: Roberto Gaona Assignee: Martin Drápela
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Problem/Incident
causes MGNLREST-718 DOC: Harmonize all the url encoding t... Accepted
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLREST-716 DOCSub: Operator OR needs to be encod... Sub-task Completed Martin Drápela  
MGNLREST-717 DOCSub: Operator OR needs to be encod... Sub-task Completed Javier Benito  
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled
Date of First Response:
Epic Link: Support
Sprint: DevX 38
Story Points: 0.5
Team: DeveloperX
Work Started:
Approved:
Yes

 Description   

Reproduce
Perform a REST request using the OR ("|") operator such as:

https://demoauthor.magnolia-cms.com/.rest/delivery/pagesWithComponents/v1?@name=tour|basel

Expected
Operator works as described on the documentation and values are returned. But the pipe character is illegal.

Actual
Error message is returned:

{"error":\{"code":"unknown","message":"Illegal character in query at index 84: https://demoauthor.magnolia-cms.com/.rest/delivery/pagesWithComponents/v1?@name=tour|basel"}}

The docs should indicate that a pipe | character needs to be encoded to work properly.

https://demoauthor.magnolia-cms.com/.rest/delivery/pagesWithComponents/v1?@name=tour%7Cbasel


 Comments   
Comment by Christopher Zimmermann [ 03/May/23 ]

Here - lets just add another short sentance that | must be encoded. 

https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html#_properties
If a filter can take multiple possible values which must match, use | (OR):

Generated at Mon Feb 12 06:58:55 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.