-
-
Notifications
You must be signed in to change notification settings - Fork 160
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.
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
[superceded by #1477]: Course and Resources API #1381
Conversation
@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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd be bold enough to put this under v2
. What do you think? @sbender9 ?
58e391c
to
c181568
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed calling clearDestination()
on setActiveRoute()
/ setDestination()
error
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 PR is based on server v1.41 and superscedes #1361 to implement the following:
./api/resources
path for both defined resource types (routes
,waypoints
,notes
,regions
andcharts
) and user defined types../api/resources/set/<resource_type>
)Features:
/signalk/v1/api/resources
and/signalk/v1/api/resources/*
pathsgetResource(type, id)
)courseGreatCircle
andcourseRhumbline
attributes./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