Skip to content

doc: Fix paths in RADAR OpenAPI definition #2806

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

Open
panaaj wants to merge 3 commits into
base: master
Choose a base branch
from
Open

doc: Fix paths in RADAR OpenAPI definition #2806

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
698ea8a
update routes
panaaj Jun 18, 2026
f3b1c04
radar openAPI fixes
panaaj Jun 26, 2026
4311415
use typebox schemas
panaaj Jun 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 27 additions & 65 deletions src/api/radar/openApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,17 @@ const radarApiDoc = {
tags: [
{ name: 'Radars', description: 'Radar discovery and capabilities' },
{ name: 'Controls', description: 'Read and modify radar control settings' },
{ name: 'Targets', description: 'ARPA target acquisition and tracking' },
{
name: 'Configuration',
description: 'Server and network configuration'
},
{
name: 'Stream',
description: 'Real-time WebSocket stream for control updates'
}
{ name: 'Targets', description: 'ARPA target acquisition and tracking' }
],
components: {
schemas: {
RadarInfo: {
type: 'object',
properties: {
id: {
type: 'string',
description: 'Radar identifier.'
},
name: {
type: 'string',
description: 'User-defined name or auto-detected model name'
Expand All @@ -50,27 +46,16 @@ const radarApiDoc = {
type: 'string',
description: 'Radar model name if detected'
},
spokeDataUrl: {
type: 'string',
description:
'WebSocket URL for receiving raw radar spoke data (binary)'
},
streamUrl: {
type: 'string',
description: 'WebSocket URL for Signal K control stream (JSON)'
spokesPerRevolution: {
type: 'integer',
description: 'Number of spokes per full rotation'
},
radarIpAddress: {
type: 'string',
description: 'IP address of the radar unit on the network'
maxSpokeLength: {
type: 'integer',
description: 'Maximum number of samples per spoke'
}
},
required: [
'name',
'brand',
'spokeDataUrl',
'streamUrl',
'radarIpAddress'
]
required: ['id', 'name', 'brand']
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
},
Capabilities: {
type: 'object',
Expand Down Expand Up @@ -389,7 +374,7 @@ const radarApiDoc = {
}
},
paths: {
'/signalk/v2/api/vessels/self/radars': {
'/': {
get: {
tags: ['Radars'],
summary: 'List all active radars',
Expand All @@ -412,49 +397,26 @@ const radarApiDoc = {
}
}
},
'/signalk/v2/api/vessels/self/radars/interfaces': {
'/{radar_id}': {
get: {
tags: ['Configuration'],
summary: 'List network interfaces',
description:
'Returns network interfaces and which radar brands are listening on each.',
tags: ['Radars'],
summary: 'Get radar information',
description: 'Returns static information about a radar.',
parameters: [radarIdParam],
responses: {
'200': {
description: 'Network interfaces with radar brands',
description: 'Radar information',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
brands: {
type: 'array',
items: { type: 'string' },
description: 'Radar brands compiled into this server'
},
interfaces: {
type: 'object',
additionalProperties: {
type: 'object',
properties: {
status: { type: 'string' },
ip: { type: 'string' },
netmask: { type: 'string' },
listeners: {
type: 'object',
additionalProperties: { type: 'string' }
}
}
}
}
}
}
schema: { $ref: '#/components/schemas/RadarInfo' }
}
}
}
},
'404': { description: 'Radar not found' }
}
}
},
'/signalk/v2/api/vessels/self/radars/{radar_id}/capabilities': {
'/{radar_id}/capabilities': {
get: {
tags: ['Radars'],
summary: 'Get radar capabilities',
Expand All @@ -474,7 +436,7 @@ const radarApiDoc = {
}
}
},
'/signalk/v2/api/vessels/self/radars/{radar_id}/controls': {
'/{radar_id}/controls': {
get: {
tags: ['Controls'],
summary: 'Get all control values',
Expand All @@ -499,7 +461,7 @@ const radarApiDoc = {
}
}
},
'/signalk/v2/api/vessels/self/radars/{radar_id}/controls/{control_id}': {
'/controls/{control_id}': {
get: {
tags: ['Controls'],
summary: 'Get a single control value',
Expand Down Expand Up @@ -556,7 +518,7 @@ const radarApiDoc = {
}
}
},
'/signalk/v2/api/vessels/self/radars/{radar_id}/targets': {
'/{radar_id}/targets': {
get: {
tags: ['Targets'],
summary: 'Get tracked targets',
Expand Down Expand Up @@ -611,7 +573,7 @@ const radarApiDoc = {
}
}
},
'/signalk/v2/api/vessels/self/radars/{radar_id}/targets/{target_id}': {
'/{radar_id}/targets/{target_id}': {
delete: {
tags: ['Targets'],
summary: 'Cancel target tracking',
Expand Down