mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-08 10:34:34 +00:00
wip doc
- add facets structure - fix record/story differences
This commit is contained in:
jygaulier
@@ -70,8 +70,10 @@ paths:
|
||||
post:
|
||||
tags:
|
||||
- search
|
||||
description: 'Fulltext search for records or stories.
|
||||
pagination: use (offset/limit) OR (page/per_page)'
|
||||
description: |
|
||||
Fulltext search for records or stories.
|
||||
|
||||
- pagination: use (offset/limit) OR (page/per_page)
|
||||
parameters:
|
||||
- name: query
|
||||
in: query
|
||||
@@ -87,26 +89,10 @@ paths:
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 1
|
||||
enum:
|
||||
- 0
|
||||
- 1
|
||||
default: 0
|
||||
- name: offset
|
||||
in: query
|
||||
description: offset in records count, from 0. Use along with "limit"
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
default: 0
|
||||
- name: limit
|
||||
in: query
|
||||
description: number of results. Use along with "offset"
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
default: 10
|
||||
- name: page
|
||||
in: query
|
||||
description: page number, from 1. Use along with "per_page"
|
||||
@@ -124,26 +110,44 @@ paths:
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
default: 10
|
||||
- name: offset
|
||||
in: query
|
||||
description: offset in records count, from 0. Use along with "limit"
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
# default: 0
|
||||
- name: limit
|
||||
in: query
|
||||
description: number of results. Use along with "offset"
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
# default: 10
|
||||
- name: story_children_limit
|
||||
in: query
|
||||
description: For stories, include N children
|
||||
description: For each story in result, include N children
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 10
|
||||
default: 0
|
||||
default: '0'
|
||||
- name: include
|
||||
in: query
|
||||
description: Elements to be included in response
|
||||
description: Suplemental elements to be included in response
|
||||
required: false
|
||||
schema:
|
||||
|
||||
anyOf:
|
||||
- enum:
|
||||
- facets
|
||||
- result.stories.children
|
||||
explode: true
|
||||
type: array
|
||||
uniqueItems: false
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- facets
|
||||
- result.stories.children
|
||||
responses:
|
||||
200:
|
||||
description: ok
|
||||
|
||||
@@ -77,27 +77,63 @@ ApiResponse_search_response:
|
||||
properties:
|
||||
offset:
|
||||
type: integer
|
||||
description: 'The pagination offset as passed in request'
|
||||
description: 'The pagination offset as passed (or computed from "page/per_page") in request'
|
||||
limit:
|
||||
type: integer
|
||||
description: 'The pagination limit as passed in request'
|
||||
page_result_count:
|
||||
count:
|
||||
type: integer
|
||||
description: 'The number of results in this page [0...limit]'
|
||||
total_result_count:
|
||||
total:
|
||||
type: integer
|
||||
description: 'The total number of results request'
|
||||
description: 'The total number of results'
|
||||
minimum: 1
|
||||
results:
|
||||
type: object
|
||||
properties:
|
||||
stories:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/Record'
|
||||
$ref: '#/Story'
|
||||
records:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/Record'
|
||||
facets:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: 'The unique internal name (=key) for the facet'
|
||||
example: '_base'
|
||||
field:
|
||||
type: string
|
||||
description: 'Source field (from db structure). Can be also virtual field like "database" '
|
||||
example: 'database'
|
||||
values:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
description: 'Human readable value for the value'
|
||||
example: 'Demo'
|
||||
raw_value:
|
||||
type: string
|
||||
description: 'Real value, to be used to query'
|
||||
example: 'db_demo'
|
||||
count:
|
||||
type: integer
|
||||
description: 'Number of items matching this value'
|
||||
query:
|
||||
type: string
|
||||
description: 'Formulated query to search items matching this facet'
|
||||
example: 'database:db_demo'
|
||||
|
||||
|
||||
|
||||
|
||||
ID:
|
||||
@@ -168,15 +204,13 @@ TechnicalInformation:
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
Record:
|
||||
_Record_:
|
||||
type: object
|
||||
properties:
|
||||
databox_id:
|
||||
$ref: '#/ID'
|
||||
record_id:
|
||||
$ref: '#/ID'
|
||||
mime_type:
|
||||
type: string
|
||||
title:
|
||||
type: string
|
||||
original_name:
|
||||
@@ -191,21 +225,55 @@ Record:
|
||||
$ref: '#/ID'
|
||||
base_id:
|
||||
$ref: '#/ID'
|
||||
sha256:
|
||||
type: string
|
||||
thumbnail:
|
||||
$ref: '#/Subdef'
|
||||
technical_informations:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/TechnicalInformation'
|
||||
phrasea_type:
|
||||
type: string
|
||||
enum:
|
||||
- image
|
||||
- video
|
||||
uuid:
|
||||
type: string
|
||||
|
||||
Record:
|
||||
allOf: # Combines the basic _Record_ and the records-only properties
|
||||
- $ref: '#/_Record_'
|
||||
- type: object
|
||||
properties:
|
||||
mime_type:
|
||||
type: string
|
||||
technical_informations:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/TechnicalInformation'
|
||||
sha256:
|
||||
type: string
|
||||
phrasea_type:
|
||||
type: string
|
||||
enum:
|
||||
- image
|
||||
- video
|
||||
|
||||
Story:
|
||||
allOf: # Combines the basic _Record_ and the stories-only properties
|
||||
- $ref: '#/_Record_'
|
||||
- type: object
|
||||
properties:
|
||||
children_offset:
|
||||
type: integer
|
||||
description: 'The children pagination offset ; Always 0'
|
||||
children_limit:
|
||||
type: integer
|
||||
description: 'The children pagination limit ; Equal to "story_children_limit" passed in request'
|
||||
children_count:
|
||||
type: integer
|
||||
description: 'The number of children in "children" array ; [0...limit]'
|
||||
children_total:
|
||||
type: integer
|
||||
description: 'The total number of -visibles for user- children in this story'
|
||||
children:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
items:
|
||||
$ref: '#/Record'
|
||||
|
||||
|
||||
RecordUri:
|
||||
type: string
|
||||
example:
|
||||
|
||||
Reference in New Issue
Block a user