mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-17 15:03:25 +00:00
135 lines
3.1 KiB
YAML
135 lines
3.1 KiB
YAML
RecordPatch_metadata:
|
|
type: object
|
|
properties:
|
|
field_name:
|
|
type: string
|
|
meta_struct_id:
|
|
$ref: 'common.yaml#/ID'
|
|
action:
|
|
type: string
|
|
enum:
|
|
- set
|
|
- add
|
|
- delete
|
|
- replace
|
|
value:
|
|
# todo : change to string, int, number, array
|
|
type: string
|
|
|
|
|
|
RecordPatch_status:
|
|
type: object
|
|
required:
|
|
- bit
|
|
- state
|
|
properties:
|
|
bit:
|
|
type: integer
|
|
minimum: 4
|
|
maximum: 31
|
|
state:
|
|
type: boolean
|
|
RecordPatch:
|
|
description: 'Metadata, status, collection, etc to be set for a record'
|
|
type: object
|
|
properties:
|
|
metadatas:
|
|
type: array
|
|
items:
|
|
$ref: '#/RecordPatch_metadata'
|
|
status:
|
|
type: array
|
|
items:
|
|
$ref: '#/RecordPatch_status'
|
|
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
|
|
ApiResponse_record:
|
|
type: object
|
|
properties:
|
|
meta:
|
|
$ref: '#/ApiResponse_meta'
|
|
response:
|
|
$ref: 'record.yaml#/Record'
|
|
ApiResponse_story:
|
|
type: object
|
|
properties:
|
|
meta:
|
|
$ref: '#/ApiResponse_meta'
|
|
response:
|
|
$ref: 'record.yaml#/Story'
|
|
|
|
# -------------------- searchraw ---------------
|
|
|
|
# -------------------- search ---------------
|
|
ApiResponse_search:
|
|
type: object
|
|
properties:
|
|
meta:
|
|
$ref: '#/ApiResponse_meta'
|
|
response:
|
|
$ref: '#/ApiResponse_search_response'
|
|
ApiResponse_search_response:
|
|
type: object
|
|
properties:
|
|
offset:
|
|
type: integer
|
|
description: 'Pagination offset as passed (or computed from "page/per_page") in request'
|
|
limit:
|
|
type: integer
|
|
description: 'Pagination limit as passed in request'
|
|
count:
|
|
type: integer
|
|
description: 'Number of results in this page [0...limit]'
|
|
total:
|
|
type: integer
|
|
description: 'Total number of results'
|
|
minimum: 1
|
|
results:
|
|
type: object
|
|
properties:
|
|
stories:
|
|
type: array
|
|
items:
|
|
$ref: 'record.yaml#/Story'
|
|
records:
|
|
type: array
|
|
items:
|
|
$ref: 'record.yaml#/Record'
|
|
facets:
|
|
$ref: 'common.yaml#/FacetsArray'
|
|
|
|
|
|
|
|
RecordUri:
|
|
type: string
|
|
example:
|
|
'/api/v3/records/1/48'
|
|
RecordsUriArray:
|
|
type: array
|
|
items:
|
|
$ref: '#/RecordUri'
|
|
|
|
ApiResponse_RecordsUriArray:
|
|
type: object
|
|
properties:
|
|
meta:
|
|
$ref: '#/ApiResponse_meta'
|
|
response:
|
|
$ref: '#/RecordsUriArray'
|
|
|