chylex/Nextcloud-News
1
0
Fork 0
mirror of https://github.com/chylex/Nextcloud-News.git synced 2025-05-04 10:34:06 +02:00
Code

fix headers in API v1

Browse Source 
only one h1 is allowed with the material theme

Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
This commit is contained in:
Benjamin Brahmer 2022-03-07 19:49:32 +01:00
parent adccd81db6
commit 4f44cfcd15
1 changed files with 41 additions and 39 deletions

80
docs/api/api-v1.md
View File

@ -151,8 +151,10 @@ It is recommended though that you use the following convention:
## Output ## Output
The output is JSON. The output is JSON.
# Folders ## API Endpoints
## Get all folders
### Folders
#### Get all folders
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
@ -170,7 +172,7 @@ The output is JSON.
} }
``` ```
## Create a folder #### Create a folder
Creates a new folder and returns a new folder object Creates a new folder and returns a new folder object
* **Status**: Implemented * **Status**: Implemented
@ -197,7 +199,7 @@ Creates a new folder and returns a new folder object
} }
``` ```
## Delete a folder #### Delete a folder
Deletes a folder with the id folderId and all the feeds it contains Deletes a folder with the id folderId and all the feeds it contains
* **Status**: Implemented * **Status**: Implemented
@ -208,7 +210,7 @@ Deletes a folder with the id folderId and all the feeds it contains
* **HTTP 404**: If the folder does not exist * **HTTP 404**: If the folder does not exist
* **Returns**: nothing * **Returns**: nothing
## Rename a folder #### Rename a folder
Only the name can be updated Only the name can be updated
* **Status**: Implemented * **Status**: Implemented
@ -226,7 +228,7 @@ Only the name can be updated
* **HTTP 422**: If the folder name is invalid (for instance empty) * **HTTP 422**: If the folder name is invalid (for instance empty)
* **Returns**: nothing * **Returns**: nothing
## Mark items of a folder as read #### Mark items of a folder as read
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
@ -243,16 +245,16 @@ Only the name can be updated
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
# Feeds ### Feeds
## Sanitation #### Sanitation
The following attributes are **not sanitized** meaning: including them in your web application can lead to XSS: The following attributes are **not sanitized** meaning: including them in your web application can lead to XSS:
* **title** * **title**
* **link** * **link**
## Get all feeds #### Get all feeds
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
@ -287,7 +289,7 @@ The following attributes are **not sanitized** meaning: including them in your w
} }
``` ```
## Create a feed #### Create a feed
Creates a new feed and returns the feed Creates a new feed and returns the feed
* **Status**: Implemented * **Status**: Implemented
@ -324,7 +326,7 @@ Creates a new feed and returns the feed
} }
``` ```
## Delete a feed #### Delete a feed
Deletes a feed with the id feedId and all of its items Deletes a feed with the id feedId and all of its items
* **Status**: Implemented * **Status**: Implemented
@ -335,7 +337,7 @@ Deletes a feed with the id feedId and all of its items
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
## Move a feed to a different folder #### Move a feed to a different folder
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
@ -350,7 +352,7 @@ Deletes a feed with the id feedId and all of its items
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
## Rename a feed #### Rename a feed
* **Status**: Implemented in 1.807 * **Status**: Implemented in 1.807
* **Method**: PUT * **Method**: PUT
@ -365,7 +367,7 @@ Deletes a feed with the id feedId and all of its items
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
## Mark items of a feed as read #### Mark items of a feed as read
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
@ -383,9 +385,9 @@ Deletes a feed with the id feedId and all of its items
* **Returns**: nothing * **Returns**: nothing
# Items ### Items
## Sanitation #### Sanitation
The following attributes are **not sanitized** meaning: including them in your web application can lead to XSS: The following attributes are **not sanitized** meaning: including them in your web application can lead to XSS:
@ -397,7 +399,7 @@ The following attributes are **not sanitized** meaning: including them in your w
* **mediaThumbnail** * **mediaThumbnail**
* **mediaDescription** * **mediaDescription**
## Get items #### Get items
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
* **Route**: /items * **Route**: /items
@ -440,7 +442,7 @@ The following attributes are **not sanitized** meaning: including them in your w
} }
``` ```
### Example ##### Example
Autopaging would work like this: Autopaging would work like this:
* Get the **first 20** items from a feed with **id 12** * Get the **first 20** items from a feed with **id 12**
@ -471,7 +473,7 @@ The item with the lowest item id is 43.
``` ```
## Get updated items #### Get updated items
This is used to stay up to date. This is used to stay up to date.
* **Status**: Implemented * **Status**: Implemented
@ -512,7 +514,7 @@ This is used to stay up to date.
} }
``` ```
## Mark an item as read #### Mark an item as read
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{itemId}/read * **Route**: /items/{itemId}/read
@ -521,7 +523,7 @@ This is used to stay up to date.
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
## Mark multiple items as read #### Mark multiple items as read
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/read/multiple * **Route**: /items/read/multiple
@ -533,7 +535,7 @@ This is used to stay up to date.
``` ```
* **Returns**: nothing * **Returns**: nothing
## Mark an item as unread #### Mark an item as unread
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{itemId}/unread * **Route**: /items/{itemId}/unread
@ -542,7 +544,7 @@ This is used to stay up to date.
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
## Mark multiple items as unread #### Mark multiple items as unread
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/unread/multiple * **Route**: /items/unread/multiple
@ -554,7 +556,7 @@ This is used to stay up to date.
``` ```
* **Returns**: nothing * **Returns**: nothing
## Mark an item as starred #### Mark an item as starred
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{feedId}/{guidHash}/star * **Route**: /items/{feedId}/{guidHash}/star
@ -563,7 +565,7 @@ This is used to stay up to date.
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
## Mark multiple items as starred #### Mark multiple items as starred
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/star/multiple * **Route**: /items/star/multiple
@ -580,7 +582,7 @@ This is used to stay up to date.
``` ```
* **Returns**: nothing * **Returns**: nothing
## Mark an item as unstarred #### Mark an item as unstarred
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{feedId}/{guidHash}/unstar * **Route**: /items/{feedId}/{guidHash}/unstar
@ -589,7 +591,7 @@ This is used to stay up to date.
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
## Mark multiple items as unstarred #### Mark multiple items as unstarred
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/unstar/multiple * **Route**: /items/unstar/multiple
@ -606,7 +608,7 @@ This is used to stay up to date.
``` ```
* **Returns**: nothing * **Returns**: nothing
## Mark all items as read #### Mark all items as read
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
@ -624,7 +626,7 @@ This is used to stay up to date.
* **Returns**: nothing * **Returns**: nothing
# Updater ### Updater
To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created. To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created.
@ -637,7 +639,7 @@ Updating should be done in the following fashion:
This [implementation in Python](https://github.com/nextcloud/news-updater) should give you a good idea how to design and run it. This [implementation in Python](https://github.com/nextcloud/news-updater) should give you a good idea how to design and run it.
## Trigger cleanup before update #### Trigger cleanup before update
This is used to clean up the database. It deletes folders and feeds that are marked for deletion This is used to clean up the database. It deletes folders and feeds that are marked for deletion
* **Status**: Implemented in 1.601 * **Status**: Implemented in 1.601
@ -650,7 +652,7 @@ This is used to clean up the database. It deletes folders and feeds that are mar
php -f nextcloud/occ news:updater:before-update php -f nextcloud/occ news:updater:before-update
## Get feed ids and usernames for all feeds #### Get feed ids and usernames for all feeds
* **Status**: Implemented in 1.203 * **Status**: Implemented in 1.203
* **Authentication**: Requires admin user * **Authentication**: Requires admin user
@ -674,7 +676,7 @@ This is used to clean up the database. It deletes folders and feeds that are mar
php -f nextcloud/occ news:updater:all-feeds php -f nextcloud/occ news:updater:all-feeds
## Trigger a feed update #### Trigger a feed update
* **Status**: Implemented in 1.601 * **Status**: Implemented in 1.601
* **Authentication**: Requires admin user * **Authentication**: Requires admin user
@ -695,7 +697,7 @@ This is used to clean up the database. It deletes folders and feeds that are mar
php -f nextcloud/occ news:updater:update-feed 3 john php -f nextcloud/occ news:updater:update-feed 3 john
## Trigger cleanup after update #### Trigger cleanup after update
This is used to clean up the database. It removes old read articles which are not starred This is used to clean up the database. It removes old read articles which are not starred
* **Status**: Implemented in 1.601 * **Status**: Implemented in 1.601
@ -708,9 +710,9 @@ This is used to clean up the database. It removes old read articles which are no
php -f nextcloud/occ news:updater:after-update php -f nextcloud/occ news:updater:after-update
# Version ### Version
## Get the version #### Get the version
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
@ -723,11 +725,11 @@ This is used to clean up the database. It removes old read articles which are no
} }
``` ```
# Status ### Status
This API can be used to display warnings and errors in your client if the web app is improperly configured or not working. It is a good idea to call this route on like every 10th update and after the server connection parameters have been changed since it's likely that the user set up a new instance and configured the app improperly. This API can be used to display warnings and errors in your client if the web app is improperly configured or not working. It is a good idea to call this route on like every 10th update and after the server connection parameters have been changed since it's likely that the user set up a new instance and configured the app improperly.
## Get the status #### Get the status
* **Status**: Implemented in 5.2.4 * **Status**: Implemented in 5.2.4
* **Method**: GET * **Method**: GET
@ -755,7 +757,7 @@ You should show the following warning and the link should be clickable:
If **incorrectDbCharset** is true you should display a warning that database charset is set up incorrectly and updates with unicode characters might fail If **incorrectDbCharset** is true you should display a warning that database charset is set up incorrectly and updates with unicode characters might fail
# User ### User
This API can be used to retrieve metadata about the current user. This API can be used to retrieve metadata about the current user.
@ -763,7 +765,7 @@ DEPRECATED: This API is deprecated, use the Nextcloud APIs instead.
- https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata for user data - https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata for user data
- `https://nc.url/avatar/{userid}/{size}?v={1|2}` for the avatar - `https://nc.url/avatar/{userid}/{size}?v={1|2}` for the avatar
## Get the status #### Get the status
* **Status**: Implemented in 6.0.5 * **Status**: Implemented in 6.0.5
* **Method**: GET * **Method**: GET