Added JSON /views example
#1857
Conversation
| "offset": 0, | ||
| "SortClauses": { | ||
| "ContentName": "ascending" | ||
| } |
There was a problem hiding this comment.
Can we have the contentTypeFacetBuilder like in the XML example?
There was a problem hiding this comment.
So, the thing is, Facet Builders were supposed to be removed in 4.x. While I can construct a query in JSON that creates those facet builder objects internally, I'm not sure if they will work properly.
When reading through the code related to search engine (Ibexa\Contracts\Core\Repository\SearchService::findContent) facet builders appear to be unused and therefore silently discarded.
Needs confirmation from @alongosz / @Nattfarinn / @adamwojs: The first two placed the deprecation notice, while Adam is knowledgeable regarding how facet builders / aggregations should behave in context of REST API, or at least could point us in the right direction.
There was a problem hiding this comment.
So, the thing is, Facet Builders were supposed to be removed in 4.x. While I can construct a query in JSON that creates those facet builder objects internally, I'm not sure if they will work properly.
When reading through the code related to search engine (
Ibexa\Contracts\Core\Repository\SearchService::findContent) facet builders appear to be unused and therefore silently discarded.Needs confirmation from @alongosz / @Nattfarinn / @adamwojs: The first two placed the deprecation notice, while Adam is knowledgeable regarding how facet builders / aggregations should behave in context of REST API, or at least could point us in the right direction.
Aggregations should be used instead of Facet builders.
There was a problem hiding this comment.
@alongosz That is plain. I'll provide concrete questions:
- Do facet builders still work in context of REST API?
- Do aggregation work in context of REST API (as I haven't found direct reference to their property in
ViewInputclass yet)? - Do you know the structure of XML/JSON that should be used for REST API to make it work (I'm looking for tests that might cover this case and / or directly looking into code at this very moment, but maybe you have some samples on hand)?
There was a problem hiding this comment.
@alongosz That is plain. I'll provide concrete questions:
- Do facet builders still work in context of REST API?
- Do aggregation work in context of REST API (as I haven't found direct reference to their property in
ViewInputclass yet)?- Do you know the structure of XML/JSON that should be used for REST API to make it work (I'm looking for tests that might cover this case and / or directly looking into code at this very moment, but maybe you have some samples on hand)?
It doesn't matter whether it works or not, it shouldn't be advocated in the doc.
To fully answer these questions 1 and 3 I need to spend significant amount of time, so you'll need to wait once I have such time slot available. Question 2 is for Adam, I have no knowledge of Aggregations.
There was a problem hiding this comment.
@alongosz Then do not worry about 1 & 3. We will simply drop the FacetBuilders property from the REST API doc and I'll look into the structure for aggregations, as I have all the files related to REST open atm.
There was a problem hiding this comment.
@adriendupuis added samples with Aggregations, and added a reference to our Search Criteria reference page - to do this I also added markdown dependency on the raml builder tool (which I think would be a nice improvement over trying to squeeze pure HTML into method description, which is also an option).
A few things I've discovered when testing those, so I'll be pushing PRs into rest package, and cross-link them here.
…tBuilder part for JSON.
Steveb-p
force-pushed
the
add-views-search-sample
branch
from
9cc8fda to
8972ca1
Compare
| "ramsey/uuid": "^3.9" | ||
| "ramsey/uuid": "^3.9", | ||
| "twig/markdown-extra": "^3.5", | ||
| "league/commonmark": "^2.3" |
There was a problem hiding this comment.
Your requirements could not be resolved to an installable set of packages.
Problem 1
- Root composer.json requires league/commonmark ^2.3 -> satisfiable by league/commonmark[2.3.0, ..., 2.3.8].
- league/commonmark[2.3.0, ..., 2.3.8] require php ^7.4 || ^8.0 -> your php version (7.2.34) does not satisfy that requirement.
So, this addition is not fully compatible with "php": "^7.2", above.
There was a problem hiding this comment.
@adriendupuis we will need to take the raml parser and everything else related to it under our organization, because that library is in practice abandoned.
4 participants
Added JSON sample for
/viewsroute, similar to the XML one.Additional changes
Markdown library and Twig extension has been added to facilitate writing longer descriptions for routes, including paragraphs and links specifically.
Checklist