Web API: re-organize online documentation and integrate Swagger-UI

sdrbase/resources/webapi/doc/swagger/include/CWKeyer.yaml

@@ -0,0 +1,12 @@
+CWKeyerSettings:
+  properties:
+    sampleRate:
+      type: integer
+    wpm:
+      type: integer
+    mode:
+      type: integer
+    text:
+      type: string
+    loop:
+      type: integer

sdrbase/resources/webapi/doc/swagger/include/FileSource.yaml

@@ -0,0 +1,5 @@
+FileSourceSettings:
+  description: FileSource
+  properties:
+    fileName:
+      type: string

sdrbase/resources/webapi/doc/swagger/include/HackRF.yaml

@@ -0,0 +1,52 @@
+HackRFInputSettings:
+  description: HackRF
+  properties:  
+    centerFrequency:
+      type: integer
+      format: int64
+    LOppmTenths:
+      type: integer
+    bandwidth:
+      type: integer
+    lnaGain:
+      type: integer
+    vgaGain:
+      type: integer
+    log2Decim:              
+      type: integer
+    fcPos:
+      description: 0=Infra 1=Supra 2=Center
+      type: integer
+    devSampleRate:
+      type: integer
+    biasT:
+      type: integer
+    lnaExt:
+      type: integer
+    dcBlock:
+      type: integer
+    iqCorrection:
+      type: integer
+    linkTxFrequency:
+      type: integer
+
+HackRFOutputSettings:
+  description: HackRF
+  properties:
+    centerFrequency:
+      type: integer
+      format: int64
+    LOppmTenths:
+      type: integer
+    bandwidth:
+      type: integer
+    vgaGain:
+      type: integer
+    log2Interp:              
+      type: integer
+    devSampleRate:
+      type: integer
+    biasT:
+      type: integer
+    lnaExt:
+      type: integer

sdrbase/resources/webapi/doc/swagger/include/LimeSdr.yaml

@@ -0,0 +1,74 @@
+LimeSdrInputSettings:
+  description: LimeSDR
+  properties:  
+    centerFrequency:
+      type: integer
+      format: int64
+    devSampleRate:
+      type: integer
+    log2HardDecim:
+      type: integer
+    dcBlock:
+      type: integer
+    iqCorrection:
+      type: integer
+    log2SoftDecim:
+      type: integer
+    lpfBW:        
+      type: integer
+    lpfFIREnable: 
+      type: integer
+    lpfFIRBW:     
+      type: integer
+    gain:         
+      type: integer
+    ncoEnable:    
+      type: integer
+    ncoFrequency: 
+      type: integer
+    antennaPath:
+      type: integer
+    gainMode:     
+      type: integer
+    lnaGain:      
+      type: integer
+    tiaGain:      
+      type: integer
+    pgaGain:      
+      type: integer
+    extClock:     
+      type: integer
+    extClockFreq: 
+      type: integer
+      
+LimeSdrOutputSettings:
+  description: LimeSDR
+  properties:  
+    centerFrequency:
+      type: integer
+      format: int64
+    devSampleRate:
+      type: integer
+    log2HardInterp:
+      type: integer
+    log2SoftInterp:
+      type: integer
+    lpfBW:        
+      type: integer
+    lpfFIREnable: 
+      type: integer
+    lpfFIRBW:     
+      type: integer
+    gain:         
+      type: integer
+    ncoEnable:    
+      type: integer
+    ncoFrequency: 
+      type: integer
+    antennaPath:
+      type: integer
+    extClock:     
+      type: integer
+    extClockFreq: 
+      type: integer
+            

sdrbase/resources/webapi/doc/swagger/include/NFMDemod.yaml

@@ -0,0 +1,43 @@
+NFMDemodSettings:
+  description: NFMDemod
+  properties:
+    inputFrequencyOffset:
+      type: integer
+      format: int64
+    rfBandwidth:
+      type: number
+      format: float
+    afBandwidth:
+      type: number
+      format: float
+    fmDeviation:
+      type: integer
+    squelchGate:
+      type: integer
+    deltaSquelch:
+      type: integer
+    squelch:
+      type: number
+      format: float
+    volume:
+      type: number
+      format: float
+    ctcssOn:
+      type: integer
+    audioMute:
+      type: integer
+    ctcssIndex:
+      type: integer
+    audioSampleRate:
+      type: integer
+    copyAudioToUDP:
+      type: integer
+    udpAddress:
+      type: string
+    udpPort:
+      type: integer
+    rgbColor:
+      type: integer
+    title:
+      type: string
+    

sdrbase/resources/webapi/doc/swagger/include/NFMMod.yaml

@@ -0,0 +1,40 @@
+NFMModSettings:
+  description: NFMMod
+  properties:
+    inputFrequencyOffset:
+      type: integer
+      format: int64
+    rfBandwidth:
+      type: number
+      format: float
+    afBandwidth:
+      type: number
+      format: float
+    fmDeviation:
+      type: number
+      format: float
+    toneFrequency:
+      type: number
+      format: float
+    volumeFactor:
+      type: number
+      format: float
+    audioSampleRate:
+      type: integer
+    channelMute:
+      type: integer
+    playLoop:
+      type: integer
+    ctcssOn:
+      type: integer
+    ctcssIndex:
+      type: integer
+    rgbColor:
+      type: integer
+    title:
+      type: string
+    modAFInput:
+      type: integer
+    cwKeyer:
+      $ref: "/doc/swagger/include/CWKeyer.yaml#/CWKeyerSettings"
+    

sdrbase/resources/webapi/doc/swagger/include/RtlSdr.yaml

@@ -0,0 +1,34 @@
+RtlSdrSettings:
+  description: RTLSDR
+  properties:
+    devSampleRate:
+      type: integer
+    lowSampleRate:
+      type: integer
+    centerFrequency:
+      type: integer
+      format: int64
+    gain:
+      type: integer
+    loPpmCorrection:
+      type: integer
+    log2Decim:
+      type: integer
+    fcPos:
+      type: integer
+    dcBlock:
+      type: integer
+    iqImbalance:
+      type: integer
+    agc:
+      type: integer
+    noModMode:
+      type: integer
+    transverterMode:
+      type: integer
+    transverterDeltaFrequency:
+      type: integer
+      format: int64      
+    rfBandwidth:
+      type: integer
+    

sdrbase/resources/webapi/doc/swagger/include/User.yaml

@@ -0,0 +1,9 @@
+User:
+  required:
+    - index
+    - name
+  properties:
+    index:
+      type: integer
+    name:
+      type: string