diff options
| author | Benjamin Brahmer <info@b-brahmer.de> | 2022-08-06 12:02:48 +0200 |
|---|---|---|
| committer | Benjamin Brahmer <info@b-brahmer.de> | 2022-08-19 09:14:27 +0200 |
| commit | 932b88a39c3e258c66f2a742f44d8467af2137f6 (patch) | |
| tree | b1b7f8e72e45065cbb10f97247363216fd083fef /docs | |
| parent | a66d62d1d70932efb7ac4871882974e528f1e139 (diff) | |
add item types to api docs
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/api-v1-2.md | 24 | ||||
| -rw-r--r-- | docs/api/api-v1-3.md | 24 |
2 files changed, 48 insertions, 0 deletions
diff --git a/docs/api/api-v1-2.md b/docs/api/api-v1-2.md index 0665bba72..3d8b22426 100644 --- a/docs/api/api-v1-2.md +++ b/docs/api/api-v1-2.md @@ -399,6 +399,30 @@ The following attributes are **not sanitized** meaning: including them in your w * **mediaThumbnail** * **mediaDescription** +#### Types +| Name | Default | Types | +|------------------|---------|--------------| +| author | null | string\|null | +| body | | string\|null | +| contentHash | | string\|null | +| enclosureLink | | string\|null | +| enclosureMime | | string\|null | +| feedId | | int | +| fingerprint | | string\|null | +| guid | | string | +| guidHash | | string | +| id | | int | +| lastModified | \"0\" | string\|null | +| mediaDescription | | string\|null | +| mediaThumbnail | | string\|null | +| pubDate | | int\|null | +| rtl | false | bool | +| starred | false | bool | +| title | | string\|null | +| unread | false | bool | +| updatedDate | | string\|null | +| url | | string\|null | + #### Get items * **Status**: Implemented * **Method**: GET diff --git a/docs/api/api-v1-3.md b/docs/api/api-v1-3.md index 98e09b622..7464efb09 100644 --- a/docs/api/api-v1-3.md +++ b/docs/api/api-v1-3.md @@ -399,6 +399,30 @@ The following attributes are **not sanitized** meaning: including them in your w * **mediaThumbnail** * **mediaDescription** +#### Types +| Name | Default | Types | +|------------------|---------|--------------| +| author | null | string\|null | +| body | | string\|null | +| contentHash | | string\|null | +| enclosureLink | | string\|null | +| enclosureMime | | string\|null | +| feedId | | int | +| fingerprint | | string\|null | +| guid | | string | +| guidHash | | string | +| id | | int | +| lastModified | \"0\" | string\|null | +| mediaDescription | | string\|null | +| mediaThumbnail | | string\|null | +| pubDate | | int\|null | +| rtl | false | bool | +| starred | false | bool | +| title | | string\|null | +| unread | false | bool | +| updatedDate | | string\|null | +| url | | string\|null | + #### Get items * **Status**: Implemented * **Method**: GET |