[superceded by #1477]: Course and Resources API#1381
Closed
Conversation
Member
Author
|
@tkurki I have created this new branch / PR which is based on v1.41 release. The one issue I encountered is that with the changes to some of the type definitions I can no longer define the passed I'm not sure if this was intended or just a side-effect of the type refinement? Extending declarations. I have worked around it for now by having the declarations in the local file. |
0466c5b to
abcbfbd
Compare
tkurki
reviewed
Jan 29, 2022
RESOURCE_PROVIDER_PLUGINS.md
Outdated
|
|
||
| ## Overview | ||
|
|
||
| The SignalK specification defines the path `/signalk/v1/api/resources` for accessing resources to aid in navigation and operation of the vessel. |
Member
There was a problem hiding this comment.
I'd be bold enough to put this under v2. What do you think? @sbender9 ?
tkurki
reviewed
Jan 30, 2022
58e391c to
c181568
Compare
panaaj
commented
Feb 10, 2022
panaaj
commented
Feb 10, 2022
387bb5f to
5f3fae8
Compare
a9af401 to
417de95
Compare
Now that the plugin is in the same repo ts compilation should happen from the root of the project (server), as project references are not available in leaf projects.
build --all fails on this.
417de95 to
d333532
Compare
…nalk-server into resources_course_api
Chart id should be meaningful.
Instead of the fixed servers in openApi.json files we can serve servers relative to the host used in the request. Introduce ts OpenApiRecord to keep metadata, keeping the openapi.json files schema compliant. I tried first adding the metadata there, but the schema based validation did not like extra properties there."
setDestination, activateRoute throw errors with appropriate message.
Special notifications outlined in specification Notifications used by apps/plugins included in server distro.
To allow plugins to correctly test for server version.
to course definition
Ability to represent route details originating from external device
Base url is defined in opemapi.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is based on server v1.41 and superscedes #1361 to implement the following:
./api/resourcespath for both defined resource types (routes,waypoints,notes,regionsandcharts) and user defined types../api/resources/set/<resource_type>)Features:
/signalk/v1/api/resourcesand/signalk/v1/api/resources/*pathsgetResource(type, id))courseGreatCircleandcourseRhumblineattributes./navigation/course)Resource Provider Plugins:
The persistance of resource data to a storage device is performed by a resource provider plugin.
In this way plugins can be written to support different storage types i.e. filesystem files, database or remote storage.
Example: Filesystem based Resource Provider plugin