[MGNLREST-707] Delivery API query should not use characters that require url encoding Created: 22/May/23  Updated: 23/Oct/23

Status: Open
Project: Magnolia REST Framework
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

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)
Epic Link: Headless Backlog
Team: DeveloperX

 Description   

Currently, several of the query parameters for the delivery endpoint require the use of characters that are not valid in a url and therefore must be encoded.

This makes the feature harder to use for developers. It is a pain to need to url encode the characters. 

it also makes code less transparent and harder to understand.

It also makes the documentation more complicated.

Here are the allowed characters: (PLEASE DOUBLE CHECK THIS)

 - _ ~ .

Are these usable?

$ - _ . + ! * ' ( ) , 

 


For discovery - check the Delivery endpoint - identify all cases where non-valid characters are used - and propose some replacements. 

Example:
[like]=something% → ENCODED → %5Blike%5D=something%25

Proposal: (like)=something*


Generated at Mon Feb 12 07:02:25 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.