[DOCU-1335] Overhaul "Filters" section on the Delivery endpoint API page Created: 20/Feb/18  Updated: 15/Mar/18  Resolved: 12/Mar/18

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to DOCU-1378 Update the examples in the Filters se... Closed
is related to DOCU-1310 Reflect changes of REST-2.0.2 Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Sprint: Docu Sprint 44, Docu Sprint 45
Story Points: 1

 Description   

We should provide more examples which work. (E.g. against the endpoint-prefix tourFinder)

Explain the thing with the like operator - its value must start and end with % - or in its encoded form %25 (and it also may contain the % within the value.
Example:

https://demo.magnolia-cms.com/.rest/delivery/tours/v1?location[like]=%25Vietnam%25

The sections "Format and operators" and "Property filter" look distinct - but actually belong together. Hence - Let's refine the structure



 Comments   
Comment by Martin Drápela [ 07/Mar/18 ]

TASK "The sections "Format and operators" and "Property filter" look distinct - but actually belong together. Hence - Let's refine the structure"
done as part of https://jira.magnolia-cms.com/browse/DOCU-1310

Comment by Christoph Meier [ 08/Mar/18 ]

I close this - since the task has been resolved in the context of DOCU-1310

Comment by Christoph Meier [ 08/Mar/18 ]

mdrapela, since I have closed DOCU-1335 - let's cover all from there on this ticket.

I like the restructuring on the filters section, but I would like to add more examples for:
like, e.g.

https://demo.magnolia-cms.com/.rest/delivery/tours/v1?location[like]=%25Vietnam%25

(emphasize that the value must start and end with a (URL encoded)%)
and at least one from lt, gt, lte, gte.
As far as I understand it, these 4 operators above deal with dates. Since I have never tried them out, I don't know whether they work.
If they fail - we may add there the link to MGNLREST-170

Edit: Removed my comment concerning the error-handling page. All fine there. The error handling indeed applies to all our endpoints.

Generated at Mon Feb 12 01:17:14 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.