mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-08 02:24:26 +00:00
PHRAS-3607 : apiv3 doc : add bases[]
fix mismatch record_id / story_id
This commit is contained in:
jygaulier
@@ -92,15 +92,19 @@ components:
|
||||
type: integer
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
bases:
|
||||
name: bases
|
||||
in: query
|
||||
description: |
|
||||
'bases_id s to search on as seen in `Collection id ("base_id" API side)` in _admin > Databases > ... collection_
|
||||
If not set: search all collections'
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
uniqueItems: false
|
||||
items:
|
||||
type: integer
|
||||
paths:
|
||||
/me:
|
||||
get:
|
||||
description: todo
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
default:
|
||||
description: Any error
|
||||
/search:
|
||||
post:
|
||||
tags:
|
||||
@@ -450,6 +454,17 @@ paths:
|
||||
search for records or stories
|
||||
* `0` - search for records
|
||||
* `1` - search for stories
|
||||
- name: bases
|
||||
in: query
|
||||
description: |
|
||||
'bases_id s to search on as seen in `Collection id ("base_id" API side)` in _admin > Databases > ... collection_
|
||||
If not set: search all collections'
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
uniqueItems: false
|
||||
items:
|
||||
type: integer
|
||||
- name: page
|
||||
in: query
|
||||
description: 'page number, from 1. Use along with "per_page"'
|
||||
@@ -502,7 +517,21 @@ paths:
|
||||
type: string
|
||||
enum:
|
||||
- facets
|
||||
- suggestions
|
||||
- result.stories.children
|
||||
- results.records.subdefs
|
||||
- results.stories.subdefs
|
||||
- results.records.caption
|
||||
- results.stories.caption
|
||||
- results.records.metadata
|
||||
- results.stories.metadata
|
||||
- results.records.status
|
||||
- results.stories.status
|
||||
- results.records.children
|
||||
- results.records.children.subdefs
|
||||
- results.records.children.caption
|
||||
- results.records.children.metadata
|
||||
- results.records.children.status
|
||||
responses:
|
||||
'200':
|
||||
description: ok
|
||||
@@ -563,14 +592,17 @@ paths:
|
||||
type: array
|
||||
items:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
story_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
- allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -662,9 +694,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
story_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
cover_record_id:
|
||||
type: integer
|
||||
description: id of the record chosen as "cover" (or null)
|
||||
@@ -705,12 +734,14 @@ paths:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -802,9 +833,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
@@ -844,12 +872,14 @@ paths:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -941,9 +971,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
@@ -1044,6 +1071,17 @@ paths:
|
||||
search for records or stories
|
||||
* `0` - search for records
|
||||
* `1` - search for stories
|
||||
- name: bases
|
||||
in: query
|
||||
description: |
|
||||
'bases_id s to search on as seen in `Collection id ("base_id" API side)` in _admin > Databases > ... collection_
|
||||
If not set: search all collections'
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
uniqueItems: false
|
||||
items:
|
||||
type: integer
|
||||
- name: page
|
||||
in: query
|
||||
description: 'page number, from 1. Use along with "per_page"'
|
||||
@@ -1403,12 +1441,14 @@ paths:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -1500,9 +1540,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
@@ -1574,12 +1611,14 @@ paths:
|
||||
- allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -1671,9 +1710,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
@@ -2266,12 +2302,14 @@ paths:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -2363,9 +2401,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
@@ -2623,14 +2658,23 @@ paths:
|
||||
example: UTF-8
|
||||
response:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
- allOf:
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
- allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -2722,9 +2766,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
story_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
cover_record_id:
|
||||
type: integer
|
||||
description: id of the record chosen as "cover" (or null)
|
||||
@@ -2765,12 +2806,14 @@ paths:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -2862,9 +2905,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
@@ -2933,15 +2973,23 @@ paths:
|
||||
example: UTF-8
|
||||
response:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
- allOf:
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
- allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -3033,9 +3081,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
story_id:
|
||||
type: integer
|
||||
example: 1400
|
||||
cover_record_id:
|
||||
type: integer
|
||||
description: id of the record chosen as "cover" (or null)
|
||||
@@ -3076,12 +3121,14 @@ paths:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
- type: object
|
||||
properties:
|
||||
databox_id:
|
||||
type: integer
|
||||
example: 2
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -3173,9 +3220,6 @@ paths:
|
||||
example: 5b079f33-0851-4aec-a978-b7f8d7204e5a
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example: 34
|
||||
mime_type:
|
||||
type: string
|
||||
example: image/jpeg
|
||||
|
||||
@@ -110,6 +110,21 @@ components:
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
# default:
|
||||
|
||||
bases:
|
||||
name: bases
|
||||
in: query
|
||||
description: >
|
||||
'bases_id s to search on as seen in `Collection id ("base_id" API side)` in _admin > Databases > ... collection_
|
||||
|
||||
If not set: search all collections'
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
uniqueItems: false
|
||||
items:
|
||||
type: integer
|
||||
|
||||
# securitySchemes:
|
||||
# api_key:
|
||||
# type: apiKey
|
||||
@@ -123,14 +138,14 @@ components:
|
||||
# tokenUrl: azea
|
||||
|
||||
paths:
|
||||
'/me':
|
||||
get:
|
||||
description: 'todo'
|
||||
responses:
|
||||
200:
|
||||
description: successful operation
|
||||
default:
|
||||
description: Any error
|
||||
# '/me':
|
||||
# get:
|
||||
# description: 'todo'
|
||||
# responses:
|
||||
# 200:
|
||||
# description: successful operation
|
||||
# default:
|
||||
# description: Any error
|
||||
|
||||
# ---------------- search ----------------
|
||||
'/search':
|
||||
@@ -464,6 +479,7 @@ paths:
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/query'
|
||||
- $ref: '#/components/parameters/search_type'
|
||||
- $ref: '#/components/parameters/bases'
|
||||
- $ref: '#/components/parameters/page'
|
||||
- $ref: '#/components/parameters/per_page'
|
||||
- $ref: '#/components/parameters/offset'
|
||||
@@ -488,7 +504,21 @@ paths:
|
||||
type: string
|
||||
enum:
|
||||
- facets
|
||||
- suggestions
|
||||
- result.stories.children
|
||||
- results.records.subdefs
|
||||
- results.stories.subdefs
|
||||
- results.records.caption
|
||||
- results.stories.caption
|
||||
- results.records.metadata
|
||||
- results.stories.metadata
|
||||
- results.records.status
|
||||
- results.stories.status
|
||||
- results.records.children
|
||||
- results.records.children.subdefs
|
||||
- results.records.children.caption
|
||||
- results.records.children.metadata
|
||||
- results.records.children.status
|
||||
responses:
|
||||
200:
|
||||
description: ok
|
||||
@@ -513,6 +543,7 @@ paths:
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/query'
|
||||
- $ref: '#/components/parameters/search_type'
|
||||
- $ref: '#/components/parameters/bases'
|
||||
- $ref: '#/components/parameters/page'
|
||||
- $ref: '#/components/parameters/per_page'
|
||||
- $ref: '#/components/parameters/offset'
|
||||
|
||||
@@ -5,10 +5,6 @@
|
||||
type: integer
|
||||
example:
|
||||
2
|
||||
record_id:
|
||||
type: integer
|
||||
example:
|
||||
34
|
||||
updated_on:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -80,13 +76,19 @@
|
||||
|
||||
Record:
|
||||
allOf: # Combines the basic _Record_ and the records-only properties
|
||||
- $ref: '#/_Record_'
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example:
|
||||
34
|
||||
- $ref: '#/_Record_'
|
||||
- type: object
|
||||
properties:
|
||||
# record_id:
|
||||
# type: integer
|
||||
# example:
|
||||
# 34
|
||||
mime_type:
|
||||
type: string
|
||||
example:
|
||||
@@ -133,15 +135,15 @@
|
||||
- $ref: '#/_record_extension_'
|
||||
|
||||
|
||||
Story:
|
||||
_Story_:
|
||||
allOf: # Combines the basic _Record_ and the stories-only properties
|
||||
- $ref: '#/_Record_'
|
||||
- type: object
|
||||
properties:
|
||||
story_id:
|
||||
type: integer
|
||||
example:
|
||||
1400
|
||||
# story_id:
|
||||
# type: integer
|
||||
# example:
|
||||
# 1400
|
||||
cover_record_id:
|
||||
$ref: 'common.yaml#/ID'
|
||||
description: 'id of the record chosen as "cover" (or null)'
|
||||
@@ -182,13 +184,37 @@
|
||||
items:
|
||||
$ref: '#/Record'
|
||||
|
||||
StoryWithStoryId:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
story_id:
|
||||
type: integer
|
||||
example:
|
||||
1400
|
||||
- $ref: '#/_Story_'
|
||||
|
||||
StoryWithRecordId:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
record_id:
|
||||
type: integer
|
||||
example:
|
||||
1400
|
||||
- $ref: '#/_Story_'
|
||||
|
||||
Story_extended:
|
||||
allOf:
|
||||
- $ref: '#/Story'
|
||||
- type: object
|
||||
properties:
|
||||
record_id: # on route /stories, the story has a record_id !!!
|
||||
type: integer
|
||||
example:
|
||||
1400
|
||||
- $ref: '#/StoryWithRecordId'
|
||||
- $ref: '#/_record_extension_'
|
||||
|
||||
|
||||
|
||||
TechnicalInformation:
|
||||
type: object
|
||||
additionalProperties:
|
||||
@@ -289,7 +315,14 @@
|
||||
meta:
|
||||
$ref: 'common.yaml#/ApiResponse_meta'
|
||||
response:
|
||||
$ref: '#/Story'
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
record_id: # on route /stories, the story has a record_id !!!
|
||||
type: integer
|
||||
example:
|
||||
1400
|
||||
- $ref: '#/StoryWithRecordId'
|
||||
|
||||
ApiResponse_story_extended:
|
||||
type: object
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
stories:
|
||||
type: array
|
||||
items:
|
||||
$ref: 'record.yaml#/Story'
|
||||
$ref: 'record.yaml#/StoryWithStoryId'
|
||||
records:
|
||||
type: array
|
||||
items:
|
||||
|
||||
Reference in New Issue
Block a user