From 88e56d1a379e1c6e1521eec1904a9df6db0ef907 Mon Sep 17 00:00:00 2001 From: f4exb Date: Thu, 21 Dec 2017 00:50:58 +0100 Subject: [PATCH] Web API: renamed /sdrangel/preset GET to /sdrangel/presets GET as this returns the list of presets --- sdrbase/resources/index.html | 6 +++--- sdrbase/webapi/webapiadapterinterface.cpp | 1 + sdrbase/webapi/webapiadapterinterface.h | 5 +++-- sdrbase/webapi/webapirequestmapper.cpp | 15 ++++++++++++--- sdrbase/webapi/webapirequestmapper.h | 1 + sdrgui/webapi/webapiadaptergui.cpp | 2 +- sdrgui/webapi/webapiadaptergui.h | 2 +- sdrsrv/webapi/webapiadaptersrv.cpp | 2 +- sdrsrv/webapi/webapiadaptersrv.h | 2 +- swagger/sdrangel/api/swagger/swagger.yaml | 4 +++- swagger/sdrangel/code/html2/index.html | 6 +++--- .../sdrangel/code/qt5/client/SWGInstanceApi.cpp | 2 +- 12 files changed, 31 insertions(+), 17 deletions(-) diff --git a/sdrbase/resources/index.html b/sdrbase/resources/index.html index b0bf4ac9c..b8ac59edc 100644 --- a/sdrbase/resources/index.html +++ b/sdrbase/resources/index.html @@ -13052,7 +13052,7 @@ $(document).ready(function() {

List all presets in the instance


- 
/sdrangel/preset
+ 
/sdrangel/presets

Usage and SDK Samples

@@ -13072,7 +13072,7 @@ $(document).ready(function() {
- 
curl -X GET "http://localhost:8091/sdrangel/preset"
+ 
curl -X GET "http://localhost:8091/sdrangel/presets"
import SWGSDRangel.*;
@@ -15011,7 +15011,7 @@ except ApiException as e:
- Generated 2017-12-20T14:24:11.587+01:00 + Generated 2017-12-21T00:41:40.926+01:00
diff --git a/sdrbase/webapi/webapiadapterinterface.cpp b/sdrbase/webapi/webapiadapterinterface.cpp index 36c507b27..3096754d5 100644 --- a/sdrbase/webapi/webapiadapterinterface.cpp +++ b/sdrbase/webapi/webapiadapterinterface.cpp @@ -25,6 +25,7 @@ QString WebAPIAdapterInterface::instanceLoggingURL = "/sdrangel/logging"; QString WebAPIAdapterInterface::instanceAudioURL = "/sdrangel/audio"; QString WebAPIAdapterInterface::instanceLocationURL = "/sdrangel/location"; QString WebAPIAdapterInterface::instanceDVSerialURL = "/sdrangel/dvserial"; +QString WebAPIAdapterInterface::instancePresetsURL = "/sdrangel/presets"; QString WebAPIAdapterInterface::instancePresetURL = "/sdrangel/preset"; QString WebAPIAdapterInterface::instancePresetFileURL = "/sdrangel/preset/file"; QString WebAPIAdapterInterface::instanceDeviceSetsURL = "/sdrangel/devicesets"; diff --git a/sdrbase/webapi/webapiadapterinterface.h b/sdrbase/webapi/webapiadapterinterface.h index 3b7f44e96..1749af9ef 100644 --- a/sdrbase/webapi/webapiadapterinterface.h +++ b/sdrbase/webapi/webapiadapterinterface.h @@ -200,10 +200,10 @@ public: } /** - * Handler of /sdrangel/preset (GET) swagger/sdrangel/code/html2/index.html#api-Default-instanceChannels + * Handler of /sdrangel/presets (GET) swagger/sdrangel/code/html2/index.html#api-Default-instanceChannels * returns the Http status code (default 501: not implemented) */ - virtual int instancePresetGet( + virtual int instancePresetsGet( SWGSDRangel::SWGPresets& response __attribute__((unused)), SWGSDRangel::SWGErrorResponse& error) { @@ -502,6 +502,7 @@ public: static QString instanceAudioURL; static QString instanceLocationURL; static QString instanceDVSerialURL; + static QString instancePresetsURL; static QString instancePresetURL; static QString instancePresetFileURL; static QString instanceDeviceSetsURL; diff --git a/sdrbase/webapi/webapirequestmapper.cpp b/sdrbase/webapi/webapirequestmapper.cpp index 218e7b6a4..a3c65bf6e 100644 --- a/sdrbase/webapi/webapirequestmapper.cpp +++ b/sdrbase/webapi/webapirequestmapper.cpp @@ -82,6 +82,8 @@ void WebAPIRequestMapper::service(qtwebapp::HttpRequest& request, qtwebapp::Http instanceLocationService(request, response); } else if (path == WebAPIAdapterInterface::instanceDVSerialURL) { instanceDVSerialService(request, response); + } else if (path == WebAPIAdapterInterface::instancePresetsURL) { + instancePresetsService(request, response); } else if (path == WebAPIAdapterInterface::instancePresetURL) { instancePresetService(request, response); } else if (path == WebAPIAdapterInterface::instancePresetFileURL) { @@ -422,7 +424,7 @@ void WebAPIRequestMapper::instanceDVSerialService(qtwebapp::HttpRequest& request } } -void WebAPIRequestMapper::instancePresetService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response) +void WebAPIRequestMapper::instancePresetsService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response) { SWGSDRangel::SWGErrorResponse errorResponse; response.setHeader("Content-Type", "application/json"); @@ -430,7 +432,7 @@ void WebAPIRequestMapper::instancePresetService(qtwebapp::HttpRequest& request, if (request.getMethod() == "GET") { SWGSDRangel::SWGPresets normalResponse; - int status = m_adapter->instancePresetGet(normalResponse, errorResponse); + int status = m_adapter->instancePresetsGet(normalResponse, errorResponse); response.setStatus(status); if (status == 200) { @@ -439,7 +441,14 @@ void WebAPIRequestMapper::instancePresetService(qtwebapp::HttpRequest& request, response.write(errorResponse.asJson().toUtf8()); } } - else if (request.getMethod() == "PATCH") +} + +void WebAPIRequestMapper::instancePresetService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response) +{ + SWGSDRangel::SWGErrorResponse errorResponse; + response.setHeader("Content-Type", "application/json"); + + if (request.getMethod() == "PATCH") { SWGSDRangel::SWGPresetTransfer query; SWGSDRangel::SWGPresetIdentifier normalResponse; diff --git a/sdrbase/webapi/webapirequestmapper.h b/sdrbase/webapi/webapirequestmapper.h index 14e8b3bc3..dec8004b0 100644 --- a/sdrbase/webapi/webapirequestmapper.h +++ b/sdrbase/webapi/webapirequestmapper.h @@ -52,6 +52,7 @@ private: void instanceAudioService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); void instanceLocationService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); void instanceDVSerialService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); + void instancePresetsService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); void instancePresetService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); void instancePresetFileService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); void instanceDeviceSetsService(qtwebapp::HttpRequest& request, qtwebapp::HttpResponse& response); diff --git a/sdrgui/webapi/webapiadaptergui.cpp b/sdrgui/webapi/webapiadaptergui.cpp index 239e3006f..4c2a15f02 100644 --- a/sdrgui/webapi/webapiadaptergui.cpp +++ b/sdrgui/webapi/webapiadaptergui.cpp @@ -326,7 +326,7 @@ int WebAPIAdapterGUI::instanceDVSerialPatch( return 200; } -int WebAPIAdapterGUI::instancePresetGet( +int WebAPIAdapterGUI::instancePresetsGet( SWGSDRangel::SWGPresets& response, SWGSDRangel::SWGErrorResponse& error __attribute__((unused))) { diff --git a/sdrgui/webapi/webapiadaptergui.h b/sdrgui/webapi/webapiadaptergui.h index 8343a71df..8242228ef 100644 --- a/sdrgui/webapi/webapiadaptergui.h +++ b/sdrgui/webapi/webapiadaptergui.h @@ -74,7 +74,7 @@ public: SWGSDRangel::SWGDVSeralDevices& response, SWGSDRangel::SWGErrorResponse& error); - virtual int instancePresetGet( + virtual int instancePresetsGet( SWGSDRangel::SWGPresets& response, SWGSDRangel::SWGErrorResponse& error); diff --git a/sdrsrv/webapi/webapiadaptersrv.cpp b/sdrsrv/webapi/webapiadaptersrv.cpp index 88049134a..c47f9b013 100644 --- a/sdrsrv/webapi/webapiadaptersrv.cpp +++ b/sdrsrv/webapi/webapiadaptersrv.cpp @@ -441,7 +441,7 @@ int WebAPIAdapterSrv::instancePresetFilePost( } } -int WebAPIAdapterSrv::instancePresetGet( +int WebAPIAdapterSrv::instancePresetsGet( SWGSDRangel::SWGPresets& response, SWGSDRangel::SWGErrorResponse& error __attribute__((unused))) { diff --git a/sdrsrv/webapi/webapiadaptersrv.h b/sdrsrv/webapi/webapiadaptersrv.h index 688fdce1d..4053cf2d7 100644 --- a/sdrsrv/webapi/webapiadaptersrv.h +++ b/sdrsrv/webapi/webapiadaptersrv.h @@ -89,7 +89,7 @@ public: SWGSDRangel::SWGPresetIdentifier& response, SWGSDRangel::SWGErrorResponse& error); - virtual int instancePresetGet( + virtual int instancePresetsGet( SWGSDRangel::SWGPresets& response, SWGSDRangel::SWGErrorResponse& error); diff --git a/swagger/sdrangel/api/swagger/swagger.yaml b/swagger/sdrangel/api/swagger/swagger.yaml index 60a3e8fc0..ffc16a049 100644 --- a/swagger/sdrangel/api/swagger/swagger.yaml +++ b/swagger/sdrangel/api/swagger/swagger.yaml @@ -285,7 +285,7 @@ paths: $ref: "#/definitions/ErrorResponse" "501": description: Function not implemented - /sdrangel/preset: + /sdrangel/presets: x-swagger-router-controller: instance get: description: List all presets in the instance @@ -303,6 +303,8 @@ paths: $ref: "#/definitions/ErrorResponse" "501": description: Function not implemented + /sdrangel/preset: + x-swagger-router-controller: instance patch: description: Load a preset in a device set operationId: instancePresetPatch diff --git a/swagger/sdrangel/code/html2/index.html b/swagger/sdrangel/code/html2/index.html index b0bf4ac9c..b8ac59edc 100644 --- a/swagger/sdrangel/code/html2/index.html +++ b/swagger/sdrangel/code/html2/index.html @@ -13052,7 +13052,7 @@ $(document).ready(function() {

List all presets in the instance


- 
/sdrangel/preset
+ 
/sdrangel/presets

Usage and SDK Samples

@@ -13072,7 +13072,7 @@ $(document).ready(function() {
- 
curl -X GET "http://localhost:8091/sdrangel/preset"
+ 
curl -X GET "http://localhost:8091/sdrangel/presets"
import SWGSDRangel.*;
@@ -15011,7 +15011,7 @@ except ApiException as e:
- Generated 2017-12-20T14:24:11.587+01:00 + Generated 2017-12-21T00:41:40.926+01:00
diff --git a/swagger/sdrangel/code/qt5/client/SWGInstanceApi.cpp b/swagger/sdrangel/code/qt5/client/SWGInstanceApi.cpp index 3c0e13bc4..8065cc4ab 100644 --- a/swagger/sdrangel/code/qt5/client/SWGInstanceApi.cpp +++ b/swagger/sdrangel/code/qt5/client/SWGInstanceApi.cpp @@ -843,7 +843,7 @@ SWGInstanceApi::instancePresetFilePutCallback(HttpRequestWorker * worker) { void SWGInstanceApi::instancePresetGet() { QString fullPath; - fullPath.append(this->host).append(this->basePath).append("/sdrangel/preset"); + fullPath.append(this->host).append(this->basePath).append("/sdrangel/presets");