Resources provider plugin for Signal K server.
npm install @signalk/resources-providerSignal K server plugin that implements the Resource Provider API.
_Note: This plugin requires Signal K Server v2.0 or later!_
---
This plugin is a resource provider, facilitating the storage and retrieval of the following resource types defined by the Signal K specification:
- resources/routes
- resources/waypoints
- resources/notes
- resources/regions
as well as providing the capability to serve custom resource types provisioned as additional paths under /signalk/v2/api/resources.
- _example:_ /signalk/v2/api/resources/fishingZones
Each path is provisioned with GET, PUT, POST and DELETE operations enabled.
Operation of all paths is as set out in the OpenAPI resources definition available in the Signal K server Admin console.
---
Signal K server v2 includes this plugin as part of the installation / upgrade process.
By default the plugin is enabled with all standdard resource types enabled.
1. (optional) De-select any resource types you want to disable.
1. (optional) Specify any custom resource paths you require.
1. Click Submit
The following API endpoints are made available to configure the plugin programatically.
> See OpenApi documentaion in the Signal K Server admin console for details.
>
> _NOTE: You must be authenticated to the Signal K Server to access these endpoints!_
- Retrieve configured resource collections:
``bash`
HTTP GET "/plugins/resources-provider/_config"
- Add a resource collection:
`
HTTP POST "/plugins/resources-provider/_config/:name" {
"description": "My custom collection"
}
WHERE :name is the name of the collection to createdescription
AND the request body contains the collection .
- Remove a resource collection:
`bash`
HTTP DELETE "/plugins/resources-provider/_config/:name"
WHERE :name is the name of the collection to remove.
---
Resources are stored in the server's filesystem under the path ~/.signalk/plugin-config-data/resources-provider/resources.
A separate file is created for each resource with a name that reflects the resources id.
Each resource is created within a folder allocated to that specific resource type.
_Example:_
`
~/.signalk
/resources
/routes
...
/waypoints
...
/notes
...
/regions
...
/charts
...
/my_custom_type
...
---
Once configured, the plugin registers itself as the resource provider for each of the enabled resource types and the Signal K server will pass all _HTTP GET, POST, PUT and DELETE_ requests to the plugin.
---
_For further information about working with resources please refer to the Signal K specification and Signal K Server documentation._