Swagger: updated model (2)

This commit is contained in:
f4exb 2017-11-16 08:42:34 +01:00
parent 4151e33e80
commit 01bed02000
1 changed files with 57 additions and 8 deletions

View File

@ -337,6 +337,46 @@ paths:
description: Invalid frequency description: Invalid frequency
"404": "404":
description: Preset not found description: Preset not found
/sdrangel/devicesets:
x-swagger-router-controller: instance
get:
description: Get summary information about device sets opened in the instance
operationId: instanceDeviceSetsGet
responses:
"200":
description: On success return device set list
schema:
$ref: "#/definitions/DeviceSetList"
default:
description: Error
schema:
$ref: "#/definitions/ErrorResponse"
post:
description: Add (append) a new device set
operationId: instanceDeviceSetsPost
responses:
"200":
description: On success return new device set
schema:
$ref: "#/definitions/DeviceSet"
default:
description: Error
schema:
$ref: "#/definitions/ErrorResponse"
delete:
description: "Remove last device set"
operationId: instanceDeviceSetsDelete
responses:
"200":
description: On success return new list of device sets
schema:
$ref: "#/definitions/DeviceSetList"
"404":
description: "No more device sets opened in this instance"
default:
description: Error
schema:
$ref: "#/definitions/ErrorResponse"
/swagger: /swagger:
x-swagger-pipe: swagger_raw x-swagger-pipe: swagger_raw
# complex objects have schema definitions # complex objects have schema definitions
@ -345,20 +385,15 @@ definitions:
description: "Summarized information about this SDRangel instance" description: "Summarized information about this SDRangel instance"
required: required:
- version - version
- devicesetcount - devicesetlist
properties: properties:
version: version:
description: "Current software version" description: "Current software version"
type: string type: string
logging: logging:
$ref: "#/definitions/LoggingInfo" $ref: "#/definitions/LoggingInfo"
devicesetcount: devicesetlist:
description: "Number of device sets currently opened" $ref: "#/definitions/DeviceSetList"
type: integer
devicesets:
type: array
items:
$ref: "#/definitions/DeviceSet"
user: user:
$ref: "http://localhost:8081/User.yaml#/User" $ref: "http://localhost:8081/User.yaml#/User"
InstanceDevicesResponse: InstanceDevicesResponse:
@ -469,6 +504,19 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/Channel" $ref: "#/definitions/Channel"
DeviceSetList:
description: "List of device sets opened in this instance"
required:
- devicesetcount
properties:
devicesetcount:
description: "Number of device sets opened in this instance"
type: integer
deviceSets:
type: array
items:
$ref: "#/definitions/DeviceSet"
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:
@ -481,6 +529,7 @@ definitions:
- bandwidth - bandwidth
properties: properties:
index: index:
description: "Index in the list of device sets opened in this instance"
type: integer type: integer
hwType: hwType:
description: "Key to identify the type of hardware device" description: "Key to identify the type of hardware device"