Commit Graph

16 Commits

Author SHA1 Message Date
jygaulier
c10cfed00e [skip ci]
PHRAS-3153_Doc-to-Swagger
- fix bad route "setmetadatas" (not needed for "PATCH")
2021-03-09 10:56:44 +01:00
jygaulier
298882354b PHRAS-3153_Doc-to-Swagger
- add extended mode to /record and /story
- fix compilation in 1 file
- better examples
- todo : extended mode for /search
- todo : check "include[]" available keys (compare with extended mode)
- todo : remove 'id' type ?
2021-02-15 15:23:13 +01:00
jygaulier
7a2482c56e PHRAS-3153_Doc-to-Swagger
- fix to comply with phpstorm AND swagger
2021-02-15 15:23:13 +01:00
jygaulier
2f7b7dcea1 PHRAS-3153_Doc-to-Swagger
- big refacto, split in multiple files
2021-02-15 15:23:13 +01:00
jygaulier
63018e417e PHRAS-3153_Doc-to-Swagger
- add: json examples for post/patch record
[ci skip]
2021-02-15 15:23:13 +01:00
jygaulier
58f303547a PHRAS-3153_Doc-to-Swagger
- add: finished searchraw
- change : using "additionalproperties" for key->values
[ci skip]
2021-02-15 15:23:13 +01:00
jygaulier
38d2639fca PHRAS-3153_Doc-to-Swagger
- add: searchraw (wip)
[ci skip]
2021-02-15 15:23:13 +01:00
jygaulier
9c3718ec72 alchemy-fr/phraseanet.api.v3:1.0.0-oas3 2021-01-19 20:10:35 +01:00
jygaulier
7ee9909ebc alchemy-fr/phraseanet.api.v3:1.0.0-oas3 2021-01-19 20:01:24 +01:00
jygaulier
a754015142 push from github to swagger tryout 1 2021-01-19 19:31:15 +01:00
jygaulier
2ddff337ee PHRAS-3347_Doc-to-Swagger
- fix api doc (removed servers, ...)
- add howto push to swagger
[ci skip]
2021-01-19 19:07:08 +01:00
jygaulier
82a8998cb0 wip doc
- add facets structure
- fix record/story differences
2020-09-23 20:03:02 +02:00
jygaulier
e79f2cb4f2 add:
- multiple pagination methods
- "include" parameter in /search route :
-- facets : facets are no more returned by default
-- results.stories.children : to populate the children of stories
- "story_children_limit" parameter in /search route
  will limit the number of children populated by story
- "count" (for results) and "children_count" (for stories in results) is the number of items in the current page
- "total" (for results) and "children_total" (for stories in results) is the total number of items

todo: swagger doc (but impossible to describe related/excluded parameters (like pagination methods in /search)
2020-09-22 21:30:19 +02:00
jygaulier
f9fa3e0802 - add : doc of stories/children
- fix : limiting the number of children with search stories (story_max_records=N in url) respects coll/mask rights
2020-09-17 18:57:13 +02:00
jygaulier
4d4b163def - fix : invalid syntax (ref) for phpstorm openapi plugin (was ok with swaggerhub ?) 2020-09-17 18:57:13 +02:00
jygaulier
0fb8c4bf8e - add : API documentation in openapi format (first drop) 2020-09-17 18:57:13 +02:00