[DOCS] Test examples in Graph API #31447
Conversation
|
Pinging @elastic/es-search-aggs |
| type: keyword | ||
| query_time: | ||
| type: date | ||
| ''' |
There was a problem hiding this comment.
Needs some data adding in here?
| @@ -204,6 +208,7 @@ POST clicklogs/_xpack/graph/_explore | |||
| } | |||
| -------------------------------------------------- | |||
| // CONSOLE | |||
| // TEST[setup:clicklogs_index] | |||
| <1> Seed the exploration with a query. This example is searching | |||
| clicklogs for people who searched for the term "midi". | |||
| <2> Identify the vertices to include in the graph. This example is looking for | |||
There was a problem hiding this comment.
I see this query refers to a "query.raw" which is a field not likely to be in the clicklogs index mapping as it is currently defined in the build.gradle file
|
I saw a couple of things in the setup - missing data and fields |
| @@ -56,7 +56,7 @@ Elasticsearch query. For example: | |||
| } | |||
| } | |||
| -------------------------------------------------- | |||
|
|
|||
| // NOTCONSOLE | |||
There was a problem hiding this comment.
I think we'd be much better off writing a real request with just the query part in it or something like that. We had a lot of "unrooted" JSON in our docs before we had the docs tests and removing it all made the docs a ton more clear. No more wondering "where does this go"? Also, the way this is it doesn't get any test coverage.
There was a problem hiding this comment.
I recall the response parts were tricky to test given the scores produced and how they might change with Lucene versions etc. and the difficulty involved in masking them from any "actual vs expected" result comparisons.
There was a problem hiding this comment.
It is possible to ignore the numbers with tricks like // TESTRESPONSE[s/12.3/$body.$_path/].
|
@markharwood @lcawl Is this still something we want to do? If so what do we need to do to progress it? |
I can take a closer look at Nik's suggestion for masking scores but the elements returned are also liable to change order too. I'm not sure the path expressions for string replacements would be expressive enough to cope with this. |
Related to #30665
This PR enables testing of the examples in the Graph API reference.