Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improvements for API v1.2 #1727

Merged
merged 10 commits into from
Apr 30, 2022
Merged

Improvements for API v1.2 #1727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f77d4a4
add routes for starring/unstarring items by id
powerpaul17 Apr 11, 2022
c8fec7c
add tests for starring/unstarring items by id
powerpaul17 Apr 11, 2022
2e5dcf2
document new starring api methods in changelog
powerpaul17 Apr 11, 2022
f4917ed
fix indentation of function description
powerpaul17 Apr 11, 2022
35d921a
remove duplicate function
powerpaul17 Apr 11, 2022
498a934
rename documentation for api v1.2
powerpaul17 Apr 12, 2022
39306e2
create copies of v1.2 api routes for v1.3 api
powerpaul17 Apr 12, 2022
f901d28
also allow starring/unstarring multiple items by id
powerpaul17 Apr 12, 2022
da637b1
add documentation for API v1.3 & fix parameter description
powerpaul17 Apr 12, 2022
545a210
rename parameter for read/unread api call
powerpaul17 Apr 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The format is mostly based on [Keep a Changelog](https://keepachangelog.com/en/1
# Unreleased
## [18.x.x]
### Changed
- Add routes for starring/unstarring items by id

### Fixed

Expand Down
38 changes: 38 additions & 0 deletions appinfo/routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,44 @@
['name' => 'folder_api_v2#update', 'url' => '/api/v2/folders/{folderId}', 'verb' => 'PATCH'],
['name' => 'folder_api_v2#delete', 'url' => '/api/v2/folders/{folderId}', 'verb' => 'DELETE'],

// API 1.3
powerpaul17 marked this conversation as resolved.
Show resolved Hide resolved
['name' => 'utility_api#version', 'url' => '/api/v1-3/version', 'verb' => 'GET'],
['name' => 'utility_api#status', 'url' => '/api/v1-3/status', 'verb' => 'GET'],
['name' => 'utility_api#before_update', 'url' => '/api/v1-3/cleanup/before-update', 'verb' => 'GET'],
['name' => 'utility_api#after_update', 'url' => '/api/v1-3/cleanup/after-update', 'verb' => 'GET'],
['name' => 'utility_api#preflighted_cors', 'url' => '/api/v1-3/{path}', 'verb' => 'OPTIONS', 'requirements' => ['path' => '.+']],

// folders
['name' => 'folder_api#index', 'url' => '/api/v1-3/folders', 'verb' => 'GET'],
['name' => 'folder_api#create', 'url' => '/api/v1-3/folders', 'verb' => 'POST'],
['name' => 'folder_api#update', 'url' => '/api/v1-3/folders/{folderId}', 'verb' => 'PUT'],
['name' => 'folder_api#delete', 'url' => '/api/v1-3/folders/{folderId}', 'verb' => 'DELETE'],
['name' => 'folder_api#read', 'url' => '/api/v1-3/folders/{folderId}/read', 'verb' => 'POST'],

// feeds
['name' => 'feed_api#index', 'url' => '/api/v1-3/feeds', 'verb' => 'GET'],
['name' => 'feed_api#create', 'url' => '/api/v1-3/feeds', 'verb' => 'POST'],
['name' => 'feed_api#update', 'url' => '/api/v1-3/feeds/{feedId}', 'verb' => 'PUT'],
['name' => 'feed_api#delete', 'url' => '/api/v1-3/feeds/{feedId}', 'verb' => 'DELETE'],
['name' => 'feed_api#from_all_users', 'url' => '/api/v1-3/feeds/all', 'verb' => 'GET'],
['name' => 'feed_api#move', 'url' => '/api/v1-3/feeds/{feedId}/move', 'verb' => 'POST'],
['name' => 'feed_api#rename', 'url' => '/api/v1-3/feeds/{feedId}/rename', 'verb' => 'POST'],
['name' => 'feed_api#read', 'url' => '/api/v1-3/feeds/{feedId}/read', 'verb' => 'POST'],
['name' => 'feed_api#update', 'url' => '/api/v1-3/feeds/update', 'verb' => 'GET'],

// items
['name' => 'item_api#index', 'url' => '/api/v1-3/items', 'verb' => 'GET'],
['name' => 'item_api#updated', 'url' => '/api/v1-3/items/updated', 'verb' => 'GET'],
['name' => 'item_api#read', 'url' => '/api/v1-3/items/{itemId}/read', 'verb' => 'POST'],
['name' => 'item_api#unread', 'url' => '/api/v1-3/items/{itemId}/unread', 'verb' => 'POST'],
['name' => 'item_api#read_all', 'url' => '/api/v1-3/items/read', 'verb' => 'POST'],
['name' => 'item_api#read_multiple_by_ids', 'url' => '/api/v1-3/items/read/multiple', 'verb' => 'POST'],
['name' => 'item_api#unread_multiple_by_ids', 'url' => '/api/v1-3/items/unread/multiple', 'verb' => 'POST'],
['name' => 'item_api#star_by_item_id', 'url' => '/api/v1-3/items/{itemId}/star', 'verb' => 'POST'],
['name' => 'item_api#unstar_by_item_id', 'url' => '/api/v1-3/items/{itemId}/unstar', 'verb' => 'POST'],
['name' => 'item_api#star_multiple_by_item_ids', 'url' => '/api/v1-3/items/star/multiple', 'verb' => 'POST'],
['name' => 'item_api#unstar_multiple_by_item_ids', 'url' => '/api/v1-3/items/unstar/multiple', 'verb' => 'POST'],

// API 1.2
['name' => 'utility_api#version', 'url' => '/api/v1-2/version', 'verb' => 'GET'],
['name' => 'utility_api#status', 'url' => '/api/v1-2/status', 'verb' => 'GET'],
Expand Down
0 docs/api/api-v1.md → docs/api/api-v1-2.md
View file
Open in desktop
File renamed without changes.