VE7UWU
/
sdrangel
mirror of https://github.com/f4exb/sdrangel.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Ewb API: updated swagger.yaml documentation

This commit is contained in:
f4exb 2017-12-15 19:10:45 +01:00
parent 6de0e20ceb
commit bf1771f8d6
3 changed files with 2748 additions and 2707 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
sdrbase/resources/index.html
View File

@ -1641,7 +1641,21 @@ margin-bottom: 20px;
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
<div class="app-desc">Version: 4.0.0</div>
<hr>
<div>This is the web API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube</div>
<div><p>This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube</p>
<hr />
<p>Limitations:</p>
<ul>
<li>In SDRangel GUI version there is no support for channel deletion. As a consequence the call to the API /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} returns with a status code of 501 (not implemented)</li>
<li>The following channels are not implemented (status 501 is returned): ATV demodulator, Channel Analyzer, Channel Analyzer NG, LoRa demodulator, TCP source</li>
<li>The content type returned is always application/json except in the following cases:
<ul>
<li>An incorrect URL was specified: this document is returned as text/html with a status 400</li>
<li>There is no API adapter in the targeted instance: message &quot;Service not available&quot; as text/plain is returned with a status 500. This should not happen with released code.</li>
</ul>
</li>
</ul>
<hr />
</div>
</div>
</div>
<div id="sections">
@ -13767,7 +13781,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2017-12-14T23:27:25.824+01:00
Generated 2017-12-15T18:29:32.547+01:00
</div>
</div>
</div>

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

@ -1,6 +1,19 @@
swagger: "2.0"
info:
description: "This is the web API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube"
description: >
This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube
---
Limitations:
* In SDRangel GUI version there is no support for channel deletion. As a consequence the call to the API /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} returns with a status code of 501 (not implemented)
* The following channels are not implemented (status 501 is returned): ATV demodulator, Channel Analyzer, Channel Analyzer NG, LoRa demodulator, TCP source
* The content type returned is always application/json except in the following cases:
* An incorrect URL was specified: this document is returned as text/html with a status 400
* There is no API adapter in the targeted instance: message "Service not available" as text/plain is returned with a status 500. This should not happen with released code.
---
version: "4.0.0"
title: SDRangel
contact:

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

@ -1641,7 +1641,21 @@ margin-bottom: 20px;
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
<div class="app-desc">Version: 4.0.0</div>
<hr>
<div>This is the web API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube</div>
<div><p>This is the web REST/JSON API of SDRangel SDR software. SDRangel is an Open Source Qt5/OpenGL 3.0+ (4.3+ in Windows) GUI and server Software Defined Radio and signal analyzer in software. It supports Airspy, BladeRF, HackRF, LimeSDR, PlutoSDR, RTL-SDR, SDRplay RSP1 and FunCube</p>
<hr />
<p>Limitations:</p>
<ul>
<li>In SDRangel GUI version there is no support for channel deletion. As a consequence the call to the API /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} returns with a status code of 501 (not implemented)</li>
<li>The following channels are not implemented (status 501 is returned): ATV demodulator, Channel Analyzer, Channel Analyzer NG, LoRa demodulator, TCP source</li>
<li>The content type returned is always application/json except in the following cases:
<ul>
<li>An incorrect URL was specified: this document is returned as text/html with a status 400</li>
<li>There is no API adapter in the targeted instance: message &quot;Service not available&quot; as text/plain is returned with a status 500. This should not happen with released code.</li>
</ul>
</li>
</ul>
<hr />
</div>
</div>
</div>
<div id="sections">
@ -13767,7 +13781,7 @@ except ApiException as e:
</div>
<div id="generator">
<div class="content">
Generated 2017-12-14T23:27:25.824+01:00
Generated 2017-12-15T18:29:32.547+01:00
</div>
</div>
</div>