Skip to content

Commit 522dd42

Browse files
committed
doc
1 parent 303df6e commit 522dd42

File tree

2 files changed

+58
-6
lines changed

2 files changed

+58
-6
lines changed

doc/API_documentation/v3/_compiled.yaml

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -400,10 +400,36 @@ paths:
400400
401401
### results.records.technical_informations
402402
always included
403-
403+
404404
_nb:_ since stories are not related to a document, there is no technical_informations for stories.
405-
406-
### results.records.children
405+
406+
### results.records.stories
407+
Include a list of stories that contains the record
408+
409+
stories is an array of small objects containing only the `story_id` (= `record_id`) of the story.
410+
```
411+
"response": {
412+
"results": {
413+
"records": [
414+
{
415+
"stories": [
416+
{
417+
"story_id": 100
418+
},
419+
{
420+
"story_id": 102
421+
},
422+
...
423+
],
424+
...
425+
},
426+
...
427+
]
428+
}
429+
}
430+
```
431+
432+
### results.stories.children
407433
In story search mode, will publish a children[] array for each result. See _story_children_limit_ parameter.
408434
409435
children is an array of records, with same structure as a result record.

doc/API_documentation/v3/api.yaml

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -443,10 +443,36 @@ paths:
443443
444444
### results.records.technical_informations
445445
always included
446-
446+
447447
_nb:_ since stories are not related to a document, there is no technical_informations for stories.
448-
449-
### results.records.children
448+
449+
### results.records.stories
450+
Include a list of stories that contains the record
451+
452+
stories is an array of small objects containing only the `story_id` (= `record_id`) of the story.
453+
```
454+
"response": {
455+
"results": {
456+
"records": [
457+
{
458+
"stories": [
459+
{
460+
"story_id": 100
461+
},
462+
{
463+
"story_id": 102
464+
},
465+
...
466+
],
467+
...
468+
},
469+
...
470+
]
471+
}
472+
}
473+
```
474+
475+
### results.stories.children
450476
In story search mode, will publish a children[] array for each result. See _story_children_limit_ parameter.
451477
452478
children is an array of records, with same structure as a result record.

0 commit comments

Comments
 (0)