mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-15 22:13:13 +00:00
80 lines
1.8 KiB
YAML
80 lines
1.8 KiB
YAML
ApiResponse_meta:
|
|
type: object
|
|
properties:
|
|
api_version:
|
|
type: string
|
|
request:
|
|
type: string
|
|
response_time:
|
|
type: string
|
|
format: date-time
|
|
http_code:
|
|
type: integer
|
|
format: int32
|
|
error_type:
|
|
type: string
|
|
error_message:
|
|
type: string
|
|
|
|
Facet:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: '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'
|
|
|
|
PermalinkObject:
|
|
type: object
|
|
properties:
|
|
created_on:
|
|
type: string
|
|
format: date-time
|
|
id:
|
|
$ref: '#/ID'
|
|
is_activated:
|
|
type: boolean
|
|
label:
|
|
type: string
|
|
updated_on:
|
|
type: string
|
|
format: date-time
|
|
page_url:
|
|
type: string
|
|
download_url:
|
|
type: string
|
|
url:
|
|
type: string
|
|
|
|
FacetsArray:
|
|
type: array
|
|
items:
|
|
$ref: '#/Facet'
|
|
|
|
ID:
|
|
type: integer
|