hazza/Phraseanet
1
0
Fork 0
mirror of https://github.com/alchemy-fr/Phraseanet.git synced 2025-10-07 01:54:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
jygaulier
2025-05-15 19:26:51 +02:00
parent 303df6e199
commit 522dd4237b
2 changed files with 58 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/API_documentation/v3/_compiled.yaml
View File

@@ -400,10 +400,36 @@ paths:
### results.records.technical_informations
always included
_nb:_ since stories are not related to a document, there is no technical_informations for stories.
### results.records.children
### results.records.stories
Include a list of stories that contains the record
stories is an array of small objects containing only the `story_id` (= `record_id`) of the story.
```
"response": {
"results": {
"records": [
{
"stories": [
{
"story_id": 100
},
{
"story_id": 102
},
...
],
...
},
...
]
}
}
```
### results.stories.children
In story search mode, will publish a children[] array for each result. See _story_children_limit_ parameter.
children is an array of records, with same structure as a result record.

32
doc/API_documentation/v3/api.yaml
View File

@@ -443,10 +443,36 @@ paths:
### results.records.technical_informations
always included
_nb:_ since stories are not related to a document, there is no technical_informations for stories.
### results.records.children
### results.records.stories
Include a list of stories that contains the record
stories is an array of small objects containing only the `story_id` (= `record_id`) of the story.
```
"response": {
"results": {
"records": [
{
"stories": [
{
"story_id": 100
},
{
"story_id": 102
},
...
],
...
},
...
]
}
}
```
### results.stories.children
In story search mode, will publish a children[] array for each result. See _story_children_limit_ parameter.
children is an array of records, with same structure as a result record.