mirror of
https://github.com/wallabag/wallabag.git
synced 2024-11-25 18:41:05 +00:00
update entry api documents
Signed-off-by: EINDEX <snowstarlbk@gmail.com>
This commit is contained in:
EINDEX
parent
89db5690a0
commit
3305a08ae2
1 changed files with 141 additions and 215 deletions
|
|
@ -558,124 +558,81 @@ class EntryRestController extends WallabagRestController
|
||||||
* @Operation(
|
* @Operation(
|
||||||
* tags={"Entries"},
|
* tags={"Entries"},
|
||||||
* summary="Create an entry.",
|
* summary="Create an entry.",
|
||||||
* @OA\Parameter(
|
* @OA\RequestBody(
|
||||||
* name="url",
|
|
||||||
* in="query",
|
|
||||||
* description="Url for the entry.",
|
|
||||||
* required=true,
|
* required=true,
|
||||||
* @OA\Schema(
|
* @OA\JsonContent(
|
||||||
* type="string",
|
* required={"url"},
|
||||||
* example="http://www.test.com/article.html"
|
* @OA\Property(
|
||||||
* )
|
* property="url",
|
||||||
* ),
|
* type="string",
|
||||||
* @OA\Parameter(
|
* description="Url for the entry",
|
||||||
* name="title",
|
* example="http://www.test.com/article.html"
|
||||||
* in="query",
|
* ),
|
||||||
* description="Optional, we'll get the title from the page.",
|
* @OA\Property(
|
||||||
* required=false,
|
* property="title",
|
||||||
* @OA\Schema(
|
* type="string",
|
||||||
* type="string",
|
* description="Optional, we'll get the title from the page"
|
||||||
* )
|
* ),
|
||||||
* ),
|
* @OA\Property(
|
||||||
* @OA\Parameter(
|
* property="tags",
|
||||||
* name="tags",
|
* type="string",
|
||||||
* in="query",
|
* description="A comma-separated list of tags",
|
||||||
* description="a comma-separated list of tags.",
|
* example="tag1,tag2,tag3"
|
||||||
* required=false,
|
* ),
|
||||||
* @OA\Schema(
|
* @OA\Property(
|
||||||
* type="string",
|
* property="archive",
|
||||||
* example="tag1,tag2,tag3"
|
* type="integer",
|
||||||
* )
|
* enum={0,1},
|
||||||
* ),
|
* default=0,
|
||||||
* @OA\Parameter(
|
* description="Entry already archived"
|
||||||
* name="archive",
|
* ),
|
||||||
* in="query",
|
* @OA\Property(
|
||||||
* description="entry already archived",
|
* property="starred",
|
||||||
* required=false,
|
* type="integer",
|
||||||
* @OA\Schema(
|
* enum={0,1},
|
||||||
* type="integer",
|
* default=0,
|
||||||
* enum={"1", "0"},
|
* description="Entry already starred"
|
||||||
* default="0"
|
* ),
|
||||||
* )
|
* @OA\Property(
|
||||||
* ),
|
* property="content",
|
||||||
* @OA\Parameter(
|
* type="string",
|
||||||
* name="starred",
|
* description="Content of the entry"
|
||||||
* in="query",
|
* ),
|
||||||
* description="entry already starred",
|
* @OA\Property(
|
||||||
* required=false,
|
* property="language",
|
||||||
* @OA\Schema(
|
* type="string",
|
||||||
* type="integer",
|
* description="Language of the entry"
|
||||||
* enum={"1", "0"},
|
* ),
|
||||||
* default="0"
|
* @OA\Property(
|
||||||
* )
|
* property="preview_picture",
|
||||||
* ),
|
* type="string",
|
||||||
* @OA\Parameter(
|
* description="Preview picture of the entry"
|
||||||
* name="content",
|
* ),
|
||||||
* in="query",
|
* @OA\Property(
|
||||||
* description="Content of the entry",
|
* property="published_at",
|
||||||
* required=false,
|
* type="string",
|
||||||
* @OA\Schema(
|
* format="YYYY-MM-DDTHH:II:SS+TZ or a timestamp (integer)",
|
||||||
* type="string"
|
* description="Published date of the entry"
|
||||||
* )
|
* ),
|
||||||
* ),
|
* @OA\Property(
|
||||||
* @OA\Parameter(
|
* property="authors",
|
||||||
* name="language",
|
* type="string",
|
||||||
* in="query",
|
* description="Authors of the entry",
|
||||||
* description="Language of the entry",
|
* example="Name Firstname,author2,author3"
|
||||||
* required=false,
|
* ),
|
||||||
* @OA\Schema(
|
* @OA\Property(
|
||||||
* type="string"
|
* property="public",
|
||||||
* )
|
* type="integer",
|
||||||
* ),
|
* enum={0,1},
|
||||||
* @OA\Parameter(
|
* default=0,
|
||||||
* name="preview_picture",
|
* description="Will generate a public link for the entry"
|
||||||
* in="query",
|
* ),
|
||||||
* description="Preview picture of the entry",
|
* @OA\Property(
|
||||||
* required=false,
|
* property="origin_url",
|
||||||
* @OA\Schema(
|
* type="string",
|
||||||
* type="string"
|
* description="Origin url for the entry (from where you found it)",
|
||||||
* )
|
* example="http://www.test.com/article.html"
|
||||||
* ),
|
* )
|
||||||
* @OA\Parameter(
|
|
||||||
* name="published_at",
|
|
||||||
* in="query",
|
|
||||||
* description="Published date of the entry",
|
|
||||||
* required=false,
|
|
||||||
*
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="string",
|
|
||||||
* format="YYYY-MM-DDTHH:II:SS+TZ or a timestamp (integer)",
|
|
||||||
* )
|
|
||||||
* ),
|
|
||||||
* @OA\Parameter(
|
|
||||||
* name="authors",
|
|
||||||
* in="query",
|
|
||||||
* description="Authors of the entry",
|
|
||||||
* required=false,
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="string",
|
|
||||||
* example="Name Firstname,author2,author3"
|
|
||||||
* )
|
|
||||||
* ),
|
|
||||||
* @OA\Parameter(
|
|
||||||
* name="public",
|
|
||||||
* in="query",
|
|
||||||
* description="will generate a public link for the entry",
|
|
||||||
* required=false,
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="integer",
|
|
||||||
* enum={"1", "0"},
|
|
||||||
* default="0"
|
|
||||||
* )
|
|
||||||
* ),
|
|
||||||
* @OA\Parameter(
|
|
||||||
* name="origin_url",
|
|
||||||
* in="query",
|
|
||||||
* description="Origin url for the entry (from where you found it).",
|
|
||||||
* required=false,
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="string",
|
|
||||||
* example="http://www.test.com/article.html"
|
|
||||||
* )
|
* )
|
||||||
* ),
|
* ),
|
||||||
* @OA\Response(
|
* @OA\Response(
|
||||||
|
|
@ -785,105 +742,74 @@ class EntryRestController extends WallabagRestController
|
||||||
* pattern="\w+",
|
* pattern="\w+",
|
||||||
* )
|
* )
|
||||||
* ),
|
* ),
|
||||||
* @OA\Parameter(
|
* @OA\RequestBody(
|
||||||
* name="title",
|
|
||||||
* in="query",
|
|
||||||
* description="",
|
|
||||||
* required=false,
|
* required=false,
|
||||||
* @OA\Schema(type="string")
|
* @OA\JsonContent(
|
||||||
* ),
|
* @OA\Property(
|
||||||
* @OA\Parameter(
|
* property="title",
|
||||||
* name="tags",
|
* type="string",
|
||||||
* in="query",
|
* description="Title of the entry"
|
||||||
* description="a comma-separated list of tags.",
|
* ),
|
||||||
* required=false,
|
* @OA\Property(
|
||||||
* @OA\Schema(
|
* property="tags",
|
||||||
* type="string",
|
* type="string",
|
||||||
* example="tag1,tag2,tag3",
|
* description="A comma-separated list of tags",
|
||||||
* )
|
* example="tag1,tag2,tag3"
|
||||||
* ),
|
* ),
|
||||||
* @OA\Parameter(
|
* @OA\Property(
|
||||||
* name="archive",
|
* property="archive",
|
||||||
* in="query",
|
* type="integer",
|
||||||
* description="archived the entry.",
|
* enum={0,1},
|
||||||
* required=false,
|
* default=0,
|
||||||
* @OA\Schema(
|
* description="Archive the entry"
|
||||||
* type="integer",
|
* ),
|
||||||
* enum={"1", "0"},
|
* @OA\Property(
|
||||||
* default="0"
|
* property="starred",
|
||||||
* )
|
* type="integer",
|
||||||
* ),
|
* enum={0,1},
|
||||||
* @OA\Parameter(
|
* default=0,
|
||||||
* name="starred",
|
* description="Star the entry"
|
||||||
* in="query",
|
* ),
|
||||||
* description="starred the entry.",
|
* @OA\Property(
|
||||||
* required=false,
|
* property="content",
|
||||||
* @OA\Schema(
|
* type="string",
|
||||||
* type="integer",
|
* description="Content of the entry"
|
||||||
* enum={"1", "0"},
|
* ),
|
||||||
* default="0"
|
* @OA\Property(
|
||||||
* )
|
* property="language",
|
||||||
* ),
|
* type="string",
|
||||||
* @OA\Parameter(
|
* description="Language of the entry"
|
||||||
* name="content",
|
* ),
|
||||||
* in="query",
|
* @OA\Property(
|
||||||
* description="Content of the entry",
|
* property="preview_picture",
|
||||||
* required=false,
|
* type="string",
|
||||||
* @OA\Schema(type="string")
|
* description="Preview picture of the entry"
|
||||||
* ),
|
* ),
|
||||||
* @OA\Parameter(
|
* @OA\Property(
|
||||||
* name="language",
|
* property="published_at",
|
||||||
* in="query",
|
* type="string",
|
||||||
* description="Language of the entry",
|
* format="YYYY-MM-DDTHH:II:SS+TZ or a timestamp (integer)",
|
||||||
* required=false,
|
* description="Published date of the entry"
|
||||||
* @OA\Schema(type="string")
|
* ),
|
||||||
* ),
|
* @OA\Property(
|
||||||
* @OA\Parameter(
|
* property="authors",
|
||||||
* name="preview_picture",
|
* type="string",
|
||||||
* in="query",
|
* description="Authors of the entry",
|
||||||
* description="Preview picture of the entry",
|
* example="Name Firstname,author2,author3"
|
||||||
* required=false,
|
* ),
|
||||||
* @OA\Schema(type="string")
|
* @OA\Property(
|
||||||
* ),
|
* property="public",
|
||||||
* @OA\Parameter(
|
* type="integer",
|
||||||
* name="published_at",
|
* enum={0,1},
|
||||||
* in="query",
|
* default=0,
|
||||||
* description="Published date of the entry",
|
* description="Will generate a public link for the entry"
|
||||||
* required=false,
|
* ),
|
||||||
* @OA\Schema(
|
* @OA\Property(
|
||||||
* type="datetime|integer",
|
* property="origin_url",
|
||||||
* format="YYYY-MM-DDTHH:II:SS+TZ or a timestamp",
|
* type="string",
|
||||||
* )
|
* description="Origin url for the entry (from where you found it)",
|
||||||
* ),
|
* example="http://www.test.com/article.html"
|
||||||
* @OA\Parameter(
|
* )
|
||||||
* name="authors",
|
|
||||||
* in="query",
|
|
||||||
* description="Authors of the entry",
|
|
||||||
* required=false,
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="string",
|
|
||||||
* example="Name Firstname,author2,author3",
|
|
||||||
* )
|
|
||||||
* ),
|
|
||||||
* @OA\Parameter(
|
|
||||||
* name="public",
|
|
||||||
* in="query",
|
|
||||||
* description="will generate a public link for the entry",
|
|
||||||
* required=false,
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="integer",
|
|
||||||
* enum={"1", "0"},
|
|
||||||
* default="0"
|
|
||||||
* )
|
|
||||||
* ),
|
|
||||||
* @OA\Parameter(
|
|
||||||
* name="origin_url",
|
|
||||||
* in="query",
|
|
||||||
* description="Origin url for the entry (from where you found it).",
|
|
||||||
* required=false,
|
|
||||||
* @OA\Schema(
|
|
||||||
* type="string",
|
|
||||||
* example="http://www.test.com/article.html",
|
|
||||||
* )
|
* )
|
||||||
* ),
|
* ),
|
||||||
* @OA\Response(
|
* @OA\Response(
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue