self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-06-30 23:44:55 +02:00
Code Issues Releases Activity

Plugins: Added support app_min_version property and made it required

Browse Source
This commit is contained in:
Laurent Cozic
2020-11-15 14:18:46 +00:00
parent fb5f20b308
commit ce59d29bb3
176 changed files with 5335 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
readme/api/references/plugin_manifest.md
View File

@ -2,11 +2,15 @@
The manifest file is a JSON file that describes various properties of the plugin. If you use the Yeoman generator, it should be automatically generated based on the answers you've provided. The supported properties are:
- `manifest_version`: For now should always be "1"
- `name`: Name of the plugin
- `description`: Additional information about the plugin
- `version`: Version number such as "1.0.0"
- `homepage_url`: Homepage URL of the plugin (can also be, for example, a link to a GitHub repository)
Name | Required? | Description
--- | --- | ---
`manifest_version` | **Yes** | For now should always be "1".
`name` | **Yes** | Name of the plugin. Should be a user-friendly string, as it will be displayed in the UI.
`version` | **Yes** | Version number such as "1.0.0".
`app_min_version` | **Yes** | Minimum version of Joplin that the plugin is compatible with. In general it should be whatever version you are using to develop the plugin.
`description` | No | Detailed description of the plugin.
`author` | No | Plugin author name.
`homepage_url` | No | Homepage URL of the plugin. It can also be, for example, a link to a GitHub repository.
Here's a complete example:
@ -14,8 +18,10 @@ Here's a complete example:
{
"manifest_version": 1,
"name": "Joplin Simple Plugin",
"version": "1.0.0",
"description": "To test loading and running a plugin",
"version": "1.0.0",
"author": "John Smith",
"app_min_version": "1.4",
"homepage_url": "https://joplinapp.org"
}
```

4
readme/api/references/rest_api.md
View File

@ -57,14 +57,14 @@ To get the IDs only of all the tags:
By default API results will contain the following fields: **id**, **parent_id**, **title**
# Pagination
All API calls that return multiple results will be paginated and will have the following structure:
All API calls that return multiple results will be paginated and will return the following structure:
Key | Always present? | Description
--- | --- | ---
`items` | Yes | The array of items you have requested.
`has_more` | Yes | If `true`, there are more items after this page. If `false`, it means you have reached the end of the data set.
You can specify how the results should be sorted using the `order_by` and `order_dir` query parameters, and you can specify the number of items to be returned using the `limit` parameter (the maximum being 100 items).
You can specify how the results should be sorted using the `order_by` and `order_dir` query parameters, and which page to retrieve using the `page` parameter (starts at and defaults to 1). You can specify the number of items to be returned using the `limit` parameter (the maximum being 100 items).
The following call for example will initiate a request to fetch all the notes, 10 at a time, and sorted by "updated_time" ascending: