VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-26 01:39:05 -05:00
Code Issues Projects Releases Wiki Activity

Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501

Browse Source
This commit is contained in:
f4exb 2017-12-21 18:48:24 +01:00
parent 41e18eefd2
commit 5d0fafdfe6
3 changed files with 2519 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1195
sdrbase/resources/index.html
View File

File diff suppressed because it is too large Load Diff

274
swagger/sdrangel/api/swagger/swagger.yaml
View File

@ -36,7 +36,9 @@ consumes:
# format of the responses to the client (Accepts) # format of the responses to the client (Accepts)
produces: produces:
- application/json - application/json
paths: paths:
/sdrangel: /sdrangel:
# binds a127 app logic to a route # binds a127 app logic to a route
x-swagger-router-controller: instance x-swagger-router-controller: instance
@ -52,13 +54,10 @@ paths:
schema: schema:
# a pointer to a definition # a pointer to a definition
$ref: "#/definitions/InstanceSummaryResponse" $ref: "#/definitions/InstanceSummaryResponse"
# responses may fall through to errors
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
delete: delete:
description: Stop SDRangel instance (server only) description: Stop SDRangel instance (server only)
# used as the method name of the controller # used as the method name of the controller
@ -71,13 +70,11 @@ paths:
schema: schema:
# a pointer to a definition # a pointer to a definition
$ref: "#/definitions/InstanceSummaryResponse" $ref: "#/definitions/InstanceSummaryResponse"
# responses may fall through to errors
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/devices: /sdrangel/devices:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -97,11 +94,10 @@ paths:
schema: schema:
$ref: "#/definitions/InstanceDevicesResponse" $ref: "#/definitions/InstanceDevicesResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/channels: /sdrangel/channels:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -121,11 +117,10 @@ paths:
schema: schema:
$ref: "#/definitions/InstanceChannelsResponse" $ref: "#/definitions/InstanceChannelsResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/logging: /sdrangel/logging:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -139,11 +134,9 @@ paths:
schema: schema:
$ref: "#/definitions/LoggingInfo" $ref: "#/definitions/LoggingInfo"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
put: put:
description: Change logging parmeters for this instance description: Change logging parmeters for this instance
operationId: instanceLoggingPut operationId: instanceLoggingPut
@ -168,11 +161,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/audio: /sdrangel/audio:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -186,11 +178,9 @@ paths:
schema: schema:
$ref: "#/definitions/AudioDevices" $ref: "#/definitions/AudioDevices"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
patch: patch:
description: Set audio devices description: Set audio devices
operationId: instanceAudioPatch operationId: instanceAudioPatch
@ -211,11 +201,10 @@ paths:
schema: schema:
$ref: "#/definitions/AudioDevicesSelect" $ref: "#/definitions/AudioDevicesSelect"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/location: /sdrangel/location:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -229,11 +218,9 @@ paths:
schema: schema:
$ref: "#/definitions/LocationInformation" $ref: "#/definitions/LocationInformation"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
put: put:
description: Set instance geolocation information description: Set instance geolocation information
operationId: instanceLocationPut operationId: instanceLocationPut
@ -256,11 +243,10 @@ paths:
"400": "400":
description: Location invalid description: Location invalid
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/dvserial: /sdrangel/dvserial:
x-swagger-router-controller: instance x-swagger-router-controller: instance
patch: patch:
@ -280,11 +266,10 @@ paths:
schema: schema:
$ref: "#/definitions/DVSeralDevices" $ref: "#/definitions/DVSeralDevices"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/presets: /sdrangel/presets:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -298,11 +283,10 @@ paths:
schema: schema:
$ref: "#/definitions/Presets" $ref: "#/definitions/Presets"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/preset: /sdrangel/preset:
x-swagger-router-controller: instance x-swagger-router-controller: instance
patch: patch:
@ -333,11 +317,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
put: put:
description: Update an existing preset with device set settings. description: Update an existing preset with device set settings.
operationId: instancePresetPut operationId: instancePresetPut
@ -366,11 +348,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
post: post:
description: Create a new preset from a device set settings. Frequency and type is ignored and taken from the the device set values. description: Create a new preset from a device set settings. Frequency and type is ignored and taken from the the device set values.
operationId: instancePresetPost operationId: instancePresetPost
@ -403,11 +383,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
delete: delete:
description: Deletes a preset description: Deletes a preset
operationId: instancePresetDelete operationId: instancePresetDelete
@ -436,11 +414,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/preset/file: /sdrangel/preset/file:
x-swagger-router-controller: instance x-swagger-router-controller: instance
put: put:
@ -471,11 +448,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
post: post:
description: export a preset to file (server only). description: export a preset to file (server only).
operationId: instancePresetFilePost operationId: instancePresetFilePost
@ -504,11 +479,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/devicesets: /sdrangel/devicesets:
x-swagger-router-controller: instance x-swagger-router-controller: instance
get: get:
@ -522,11 +496,9 @@ paths:
schema: schema:
$ref: "#/definitions/DeviceSetList" $ref: "#/definitions/DeviceSetList"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
post: post:
description: Add (append) a new device set with default values description: Add (append) a new device set with default values
operationId: instanceDeviceSetsPost operationId: instanceDeviceSetsPost
@ -544,11 +516,9 @@ paths:
schema: schema:
$ref: "#/definitions/SuccessResponse" $ref: "#/definitions/SuccessResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
delete: delete:
description: Remove last device set. The GUI version does not remove the first device. description: Remove last device set. The GUI version does not remove the first device.
operationId: instanceDeviceSetsDelete operationId: instanceDeviceSetsDelete
@ -564,11 +534,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}: /sdrangel/deviceset/{deviceSetIndex}:
x-swagger-router-controller: deviceset x-swagger-router-controller: deviceset
get: get:
@ -592,11 +561,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}/device: /sdrangel/deviceset/{deviceSetIndex}/device:
x-swagger-router-controller: deviceset x-swagger-router-controller: deviceset
put: put:
@ -630,11 +598,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}/device/settings: /sdrangel/deviceset/{deviceSetIndex}/device/settings:
x-swagger-router-controller: deviceset x-swagger-router-controller: deviceset
get: get:
@ -658,11 +625,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
put: put:
description: Apply all settings unconditionally (force) description: Apply all settings unconditionally (force)
operationId: devicesetDeviceSettingsPut operationId: devicesetDeviceSettingsPut
@ -690,11 +655,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
patch: patch:
description: Apply settings differentially (no force) description: Apply settings differentially (no force)
operationId: devicesetDeviceSettingsPatch operationId: devicesetDeviceSettingsPatch
@ -722,11 +685,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}/device/run: /sdrangel/deviceset/{deviceSetIndex}/device/run:
x-swagger-router-controller: deviceset x-swagger-router-controller: deviceset
get: get:
@ -754,11 +716,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
post: post:
description: start device description: start device
operationId: devicesetDeviceRunPost operationId: devicesetDeviceRunPost
@ -784,11 +744,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
delete: delete:
description: stop device description: stop device
operationId: devicesetDeviceRunDelete operationId: devicesetDeviceRunDelete
@ -814,11 +772,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}/channel: /sdrangel/deviceset/{deviceSetIndex}/channel:
x-swagger-router-controller: deviceset x-swagger-router-controller: deviceset
post: post:
@ -852,11 +809,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}:
delete: delete:
description: delete channel (server only) description: delete channel (server only)
@ -888,11 +844,10 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings:
x-swagger-router-controller: deviceset x-swagger-router-controller: deviceset
get: get:
@ -925,11 +880,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
put: put:
description: apply all settings unconditionally (force) description: apply all settings unconditionally (force)
operationId: devicesetChannelSettingsPut operationId: devicesetChannelSettingsPut
@ -960,11 +913,9 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
patch: patch:
description: apply settings differentially (no force) description: apply settings differentially (no force)
operationId: devicesetChannelSettingsPatch operationId: devicesetChannelSettingsPatch
@ -995,15 +946,16 @@ paths:
schema: schema:
$ref: "#/definitions/ErrorResponse" $ref: "#/definitions/ErrorResponse"
"500": "500":
description: Error $ref: "#/responses/Response_500"
schema:
$ref: "#/definitions/ErrorResponse"
"501": "501":
description: Function not implemented $ref: "#/responses/Response_501"
/swagger: /swagger:
x-swagger-pipe: swagger_raw x-swagger-pipe: swagger_raw
# complex objects have schema definitions # complex objects have schema definitions
definitions: definitions:
InstanceSummaryResponse: InstanceSummaryResponse:
description: "Summarized information about this SDRangel instance" description: "Summarized information about this SDRangel instance"
required: required:
@ -1021,6 +973,7 @@ definitions:
$ref: "#/definitions/LoggingInfo" $ref: "#/definitions/LoggingInfo"
devicesetlist: devicesetlist:
$ref: "#/definitions/DeviceSetList" $ref: "#/definitions/DeviceSetList"
InstanceDevicesResponse: InstanceDevicesResponse:
description: "Summarized information about logical devices from hardware devices attached to this SDRangel instance" description: "Summarized information about logical devices from hardware devices attached to this SDRangel instance"
required: required:
@ -1033,6 +986,7 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/DeviceListItem" $ref: "#/definitions/DeviceListItem"
InstanceChannelsResponse: InstanceChannelsResponse:
description: "Summarized information about channel plugins available in this SDRangel instance" description: "Summarized information about channel plugins available in this SDRangel instance"
required: required:
@ -1045,18 +999,22 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/ChannelListItem" $ref: "#/definitions/ChannelListItem"
ErrorResponse: ErrorResponse:
required: required:
- message - message
properties: properties:
message: message:
type: string type: string
example: "KO"
SuccessResponse: SuccessResponse:
required: required:
- message - message
properties: properties:
message: message:
type: string type: string
LoggingInfo: LoggingInfo:
description: "Logging parameters setting" description: "Logging parameters setting"
properties: properties:
@ -1072,6 +1030,7 @@ definitions:
fileName: fileName:
description: "Name of the log file" description: "Name of the log file"
type: string type: string
DeviceListItem: DeviceListItem:
description: "Summarized information about attached hardware device" description: "Summarized information about attached hardware device"
required: required:
@ -1104,6 +1063,7 @@ definitions:
index: index:
description: "Index of the device in the list of registered devices" description: "Index of the device in the list of registered devices"
type: integer type: integer
ChannelListItem: ChannelListItem:
description: "Summarized information about channel plugin" description: "Summarized information about channel plugin"
required: required:
@ -1127,6 +1087,7 @@ definitions:
index: index:
description: "Index of the channel in the list of registered channels" description: "Index of the channel in the list of registered channels"
type: integer type: integer
DeviceSet: DeviceSet:
description: "Sampling device and its associated channels" description: "Sampling device and its associated channels"
required: required:
@ -1155,6 +1116,7 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/DeviceSet" $ref: "#/definitions/DeviceSet"
DeviceState: DeviceState:
description: "Device running state" description: "Device running state"
required: required:
@ -1163,6 +1125,7 @@ definitions:
state: state:
description: "State: notStarted, idle, ready, running, error" description: "State: notStarted, idle, ready, running, error"
type: string type: string
SamplingDevice: SamplingDevice:
description: "Information about a logical device available from an attached hardware device that can be used as a sampling device" description: "Information about a logical device available from an attached hardware device that can be used as a sampling device"
required: required:
@ -1206,6 +1169,7 @@ definitions:
state: state:
description: "State: notStarted, idle, ready, running, error" description: "State: notStarted, idle, ready, running, error"
type: string type: string
Channel: Channel:
description: "Channel summarized information" description: "Channel summarized information"
required: required:
@ -1231,6 +1195,7 @@ definitions:
deltaFrequency: deltaFrequency:
description: "Channel shift frequency in Hz from the center of baseband" description: "Channel shift frequency in Hz from the center of baseband"
type: integer type: integer
AudioDevices: AudioDevices:
description: "List of audio devices available in the system" description: "List of audio devices available in the system"
required: required:
@ -1265,13 +1230,15 @@ definitions:
description: "List of output devices" description: "List of output devices"
type: array type: array
items: items:
$ref: "#/definitions/AudioDevice" $ref: "#/definitions/AudioDevice"
AudioDevice: AudioDevice:
description: "Audio device" description: "Audio device"
properties: properties:
name: name:
description: "Displayable name of the device" description: "Displayable name of the device"
type: string type: string
AudioDevicesSelect: AudioDevicesSelect:
description: "Audio devices selected" description: "Audio devices selected"
required: required:
@ -1289,6 +1256,7 @@ definitions:
outputIndex: outputIndex:
description: "Index of the audio output device (-1 for default)" description: "Index of the audio output device (-1 for default)"
type: integer type: integer
LocationInformation: LocationInformation:
description: "Instance geolocation information" description: "Instance geolocation information"
required: required:
@ -1303,6 +1271,7 @@ definitions:
description: "Longitude in decimal degrees positive to the east" description: "Longitude in decimal degrees positive to the east"
type: number type: number
format: float format: float
DVSeralDevices: DVSeralDevices:
description: "List of DV serial devices available in the system" description: "List of DV serial devices available in the system"
required: required:
@ -1316,12 +1285,14 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/DVSerialDevice" $ref: "#/definitions/DVSerialDevice"
DVSerialDevice: DVSerialDevice:
description: "DV serial device details" description: "DV serial device details"
properties: properties:
deviceName: deviceName:
description: "Name of the serial device in the system" description: "Name of the serial device in the system"
type: string type: string
Presets: Presets:
description: "Settings presets" description: "Settings presets"
required: required:
@ -1333,7 +1304,8 @@ definitions:
groups: groups:
type: array type: array
items: items:
$ref: "#/definitions/PresetGroup" $ref: "#/definitions/PresetGroup"
PresetGroup: PresetGroup:
description: "Group of presets" description: "Group of presets"
required: required:
@ -1349,7 +1321,8 @@ definitions:
presets: presets:
type: array type: array
items: items:
$ref: "#/definitions/PresetItem" $ref: "#/definitions/PresetItem"
PresetIdentifier: PresetIdentifier:
description: "Settings preset item" description: "Settings preset item"
required: required:
@ -1371,6 +1344,7 @@ definitions:
name: name:
description: "Descriptive name of the preset" description: "Descriptive name of the preset"
type: string type: string
PresetItem: PresetItem:
description: "Settings preset item" description: "Settings preset item"
required: required:
@ -1388,6 +1362,7 @@ definitions:
name: name:
description: "Descriptive name of the preset" description: "Descriptive name of the preset"
type: string type: string
PresetTransfer: PresetTransfer:
description: "Preset transfer to or from a device set" description: "Preset transfer to or from a device set"
required: required:
@ -1399,6 +1374,7 @@ definitions:
type: integer type: integer
preset: preset:
$ref: "#/definitions/PresetIdentifier" $ref: "#/definitions/PresetIdentifier"
PresetImport: PresetImport:
description: "Details to import preset from file in preset list" description: "Details to import preset from file in preset list"
required: required:
@ -1413,6 +1389,7 @@ definitions:
filePath: filePath:
description: "Path of the import file" description: "Path of the import file"
type: string type: string
PresetExport: PresetExport:
description: "Details to export a preset to file" description: "Details to export a preset to file"
properties: properties:
@ -1421,6 +1398,7 @@ definitions:
type: string type: string
preset: preset:
$ref: "#/definitions/PresetIdentifier" $ref: "#/definitions/PresetIdentifier"
DeviceSettings: DeviceSettings:
description: Base device settings description: Base device settings
discriminator: deviceHwType discriminator: deviceHwType
@ -1442,6 +1420,7 @@ definitions:
$ref: "http://localhost:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrInputSettings" $ref: "http://localhost:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrInputSettings"
limeSdrOutputSettings: limeSdrOutputSettings:
$ref: "http://localhost:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrOutputSettings" $ref: "http://localhost:8081/api/swagger/include/LimeSdr.yaml#/LimeSdrOutputSettings"
ChannelSettings: ChannelSettings:
description: Base channel settings description: Base channel settings
discriminator: channelType discriminator: channelType
@ -1459,3 +1438,16 @@ definitions:
$ref: "http://localhost:8081/api/swagger/include/NFMDemod.yaml#/NFMDemodSettings" $ref: "http://localhost:8081/api/swagger/include/NFMDemod.yaml#/NFMDemodSettings"
NFMModSettings: NFMModSettings:
$ref: "http://localhost:8081/api/swagger/include/NFMMod.yaml#/NFMModSettings" $ref: "http://localhost:8081/api/swagger/include/NFMMod.yaml#/NFMModSettings"
responses:
Response_500:
description: Error
schema:
$ref: "#/definitions/ErrorResponse"
Response_501:
description: Function not implemented
schema:
$ref: "#/definitions/ErrorResponse"

1195
swagger/sdrangel/code/html2/index.html
View File

File diff suppressed because it is too large Load Diff