VE7UWU
/
sdrangel
mirror of https://github.com/f4exb/sdrangel.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
sdrangel/sdrbase/resources/webapi/doc/html2/index.html

19803 lines
1.3 MiB
HTML
Raw Normal View History

Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>SDRangel</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8" />
<script>
/*! jQuery v3.1.0 | (c) jQuery Foundation | jquery.org/license */
!function(a,b){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){"use strict";var c=[],d=a.document,e=Object.getPrototypeOf,f=c.slice,g=c.concat,h=c.push,i=c.indexOf,j={},k=j.toString,l=j.hasOwnProperty,m=l.toString,n=m.call(Object),o={};function p(a,b){b=b||d;var c=b.createElement("script");c.text=a,b.head.appendChild(c).parentNode.removeChild(c)}var q="3.1.0",r=function(a,b){return new r.fn.init(a,b)},s=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,t=/^-ms-/,u=/-([a-z])/g,v=function(a,b){return b.toUpperCase()};r.fn=r.prototype={jquery:q,constructor:r,length:0,toArray:function(){return f.call(this)},get:function(a){return null!=a?a<0?this[a+this.length]:this[a]:f.call(this)},pushStack:function(a){var b=r.merge(this.constructor(),a);return b.prevObject=this,b},each:function(a){return r.each(this,a)},map:function(a){return this.pushStack(r.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(f.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(a<0?b:0);return this.pushStack(c>=0&&c<b?[this[c]]:[])},end:function(){return this.prevObject||this.constructor()},push:h,sort:c.sort,splice:c.splice},r.extend=r.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||r.isFunction(g)||(g={}),h===i&&(g=this,h--);h<i;h++)if(null!=(a=arguments[h]))for(b in a)c=g[b],d=a[b],g!==d&&(j&&d&&(r.isPlainObject(d)||(e=r.isArray(d)))?(e?(e=!1,f=c&&r.isArray(c)?c:[]):f=c&&r.isPlainObject(c)?c:{},g[b]=r.extend(j,f,d)):void 0!==d&&(g[b]=d));return g},r.extend({expando:"jQuery"+(q+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===r.type(a)},isArray:Array.isArray,isWindow:function(a){return null!=a&&a===a.window},isNumeric:function(a){var b=r.type(a);return("number"===b||"string"===b)&&!isNaN(a-parseFloat(a))},isPlainObject:function(a){var b,c;return!(!a||"[object Object]"!==k.call(a))&&(!(b=e(a))||(c=l.call(b,"constructor")&&b.constructor,"function"==typeof c&&m.call(c)===n))},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?j[k.call(a)]||"object":typeof a},globalEval:function(a){p(a)},camelCase:function(a){return a.replace(t,"ms-").replace(u,v)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b){var c,d=0;if(w(a)){for(c=a.length;d<c;d++)if(b.call(a[d],d,a[d])===!1)break}else for(d in a)if(b.call(a[d],d,a[d])===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(s,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(w(Object(a))?r.merge(c,"string"==typeof a?[a]:a):h.call(c,a)),c},inArray:function(a,b,c){return null==b?-1:i.call(b,a,c)},merge:function(a,b){for(var c=+b.length,d=0,e=a.length;d<c;d++)a[e++]=b[d];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;f<g;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,e,f=0,h=[];if(w(a))for(d=a.length;f<d;f++)e=b(a[f],f,c),null!=e&&h.push(e);else for(f in a)e=b(a[f],f,c),null!=e&&h.push(e);return g.apply([],h)},guid:1,proxy:function(a,b){var c,d,e;if("string"==typeof b&&(c=a[b],b=a,a=c),r.isFunction(a))return d=f.call(arguments,2),e=function(){return a.apply(b||this,d.concat(f.call(arguments)))},e.guid=a.guid=a.guid||r.guid++,e},now:Date.now,support:o}),"function"==typeof Symbol&&(r.fn[Symbol.iterator]=c[Symbol.iterator]),r.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(a,b){j["[object "+b+"]"]=b.toLowerCase()});function w(a){var b=!!a&&"length"in a&&a.length,c=r.type(a);return"function"!==c&&!r.isWindow(a)&&("array"===c||0===b||"number"
r.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(r(a),c)})),b))for(;h<i;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},T=function(a){return 1===a.nodeType||9===a.nodeType||!+a.nodeType};function U(){this.expando=r.expando+U.uid++}U.uid=1,U.prototype={cache:function(a){var b=a[this.expando];return b||(b={},T(a)&&(a.nodeType?a[this.expando]=b:Object.defineProperty(a,this.expando,{value:b,configurable:!0}))),b},set:function(a,b,c){var d,e=this.cache(a);if("string"==typeof b)e[r.camelCase(b)]=c;else for(d in b)e[r.camelCase(d)]=b[d];return e},get:function(a,b){return void 0===b?this.cache(a):a[this.expando]&&a[this.expando][r.camelCase(b)]},access:function(a,b,c){return void 0===b||b&&"string"==typeof b&&void 0===c?this.get(a,b):(this.set(a,b,c),void 0!==c?c:b)},remove:function(a,b){var c,d=a[this.expando];if(void 0!==d){if(void 0!==b){r.isArray(b)?b=b.map(r.camelCase):(b=r.camelCase(b),b=b in d?[b]:b.match(K)||[]),c=b.length;while(c--)delete d[b[c]]}(void 0===b||r.isEmptyObject(d))&&(a.nodeType?a[this.expando]=void 0:delete a[this.expando])}},hasData:function(a){var b=a[this.expando];return void 0!==b&&!r.isEmptyObject(b)}};var V=new U,W=new U,X=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,Y=/[A-Z]/g;function Z(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(Y,"-$&").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c||"false"!==c&&("null"===c?null:+c+""===c?+c:X.test(c)?JSON.parse(c):c)}catch(e){}W.set(a,b,c)}else c=void 0;return c}r.extend({hasData:function(a){return W.hasData(a)||V.hasData(a)},data:function(a,b,c){return W.access(a,b,c)},removeData:function(a,b){W.remove(a,b)},_data:function(a,b,c){return V.access(a,b,c)},_removeData:function(a,b){V.remove(a,b)}}),r.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=W.get(f),1===f.nodeType&&!V.get(f,"hasDataAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=r.camelCase(d.slice(5)),Z(f,d,e[d])));V.set(f,"hasDataAttrs",!0)}return e}return"object"==typeof a?this.each(function(){W.set(this,a)}):S(this,function(b){var c;if(f&&void 0===b){if(c=W.get(f,a),void 0!==c)return c;if(c=Z(f,a),void 0!==c)return c}else this.each(function(){W.set(this,a,b)})},null,b,arguments.length>1,null,!0)},removeData:function(a){return this.each(function(){W.remove(this,a)})}}),r.extend({queue:function(a,b,c){var d;if(a)return b=(b||"fx")+"queue",d=V.get(a,b),c&&(!d||r.isArray(c)?d=V.access(a,b,r.makeArray(c)):d.push(c)),d||[]},dequeue:function(a,b){b=b||"fx";var c=r.queue(a,b),d=c.length,e=c.shift(),f=r._queueHooks(a,b),g=function(){r.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return V.get(a,c)||V.access(a,c,{empty:r.Callbacks("once memory").add(function(){V.remove(a,[b+"queue",c])})})}}),r.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?r.queue(this[0],a):void 0===b?this:this.each(function(){var c=r.queue(this,a,b);r._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&r.dequeue(this,a)})},dequeue:function(a){return this.each(function(){r.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=r.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=V.get(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var $=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,_=new RegExp("^(?:([+-])=|)("+$+")([a-z%]*)$","i"),aa=["Top","Right","Bottom","Left"],ba=function(a,b){return a=b||a,"none"===a.style.display||""===a.style.display&&r.contains(a.ownerDocument,a)&&"none"===r.css(a,"display")},ca=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};function da(a,b,c,d){var e,f=1,g=20,h=d?function(){return d.cur()}:function(
if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),hb={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=ib[b]||r.find.attr;ib[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=ib[g],ib[g]=e,e=null!=c(a,b,d)?g:null,ib[g]=f),e}});var jb=/^(?:input|select|textarea|button)$/i,kb=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return S(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):jb.test(a.nodeName)||kb.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});var lb=/[\t\r\n\f]/g;function mb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,mb(this)))});if("string"==typeof a&&a){b=a.match(K)||[];while(c=this[i++])if(e=mb(c),d=1===c.nodeType&&(" "+e+" ").replace(lb," ")){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=r.trim(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeClass(a.call(this,b,mb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(K)||[];while(c=this[i++])if(e=mb(c),d=1===c.nodeType&&(" "+e+" ").replace(lb," ")){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=r.trim(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,mb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(K)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=mb(this),b&&V.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":V.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+mb(c)+" ").replace(lb," ").indexOf(b)>-1)return!0;return!1}});var nb=/\r/g,ob=/[\x20\t\r\n\f]+/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":r.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(nb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:r.trim(r.text(a)).replace(ob," ")}},select:{get:function(a){for(var b,c,d=a.options,e=a.selectedIndex,f="select-one"===a.type,g=f?null:[],h=f?e+1:d.length,i=e<0?h:f?e:0;i<h;i++)if(c=d[i],(c.selected||i===e)&&!c.disabled&&(!c.parentNode.disabled||!r.nodeName(c.parentNode,"optgroup"))){if(b=r(c).val(),f)return b;g.push(b)}return g},set:function(a,b){var c,d,e=a.options,f=r.makeA
</script>
<script>
!function(){var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
(function(){function S(a){function d(e){var b=e.charCodeAt(0);if(b!==92)return b;var a=e.charAt(1);return(b=r[a])?b:"0"<=a&&a<="7"?parseInt(e.substring(1),8):a==="u"||a==="x"?parseInt(e.substring(2),16):e.charCodeAt(1)}function g(e){if(e<32)return(e<16?"\\x0":"\\x")+e.toString(16);e=String.fromCharCode(e);return e==="\\"||e==="-"||e==="]"||e==="^"?"\\"+e:e}function b(e){var b=e.substring(1,e.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),e=[],a=
b[0]==="^",c=["["];a&&c.push("^");for(var a=a?1:0,f=b.length;a<f;++a){var h=b[a];if(/\\[bdsw]/i.test(h))c.push(h);else{var h=d(h),l;a+2<f&&"-"===b[a+1]?(l=d(b[a+2]),a+=2):l=h;e.push([h,l]);l<65||h>122||(l<65||h>90||e.push([Math.max(65,h)|32,Math.min(l,90)|32]),l<97||h>122||e.push([Math.max(97,h)&-33,Math.min(l,122)&-33]))}}e.sort(function(e,a){return e[0]-a[0]||a[1]-e[1]});b=[];f=[];for(a=0;a<e.length;++a)h=e[a],h[0]<=f[1]+1?f[1]=Math.max(f[1],h[1]):b.push(f=h);for(a=0;a<b.length;++a)h=b[a],c.push(g(h[0])),
h[1]>h[0]&&(h[1]+1>h[0]&&c.push("-"),c.push(g(h[1])));c.push("]");return c.join("")}function s(e){for(var a=e.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),c=a.length,d=[],f=0,h=0;f<c;++f){var l=a[f];l==="("?++h:"\\"===l.charAt(0)&&(l=+l.substring(1))&&(l<=h?d[l]=-1:a[f]=g(l))}for(f=1;f<d.length;++f)-1===d[f]&&(d[f]=++x);for(h=f=0;f<c;++f)l=a[f],l==="("?(++h,d[h]||(a[f]="(?:")):"\\"===l.charAt(0)&&(l=+l.substring(1))&&l<=h&&
(a[f]="\\"+d[l]);for(f=0;f<c;++f)"^"===a[f]&&"^"!==a[f+1]&&(a[f]="");if(e.ignoreCase&&m)for(f=0;f<c;++f)l=a[f],e=l.charAt(0),l.length>=2&&e==="["?a[f]=b(l):e!=="\\"&&(a[f]=l.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return a.join("")}for(var x=0,m=!1,j=!1,k=0,c=a.length;k<c;++k){var i=a[k];if(i.ignoreCase)j=!0;else if(/[a-z]/i.test(i.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){m=!0;j=!1;break}}for(var r={b:8,t:9,n:10,v:11,
f:12,r:13},n=[],k=0,c=a.length;k<c;++k){i=a[k];if(i.global||i.multiline)throw Error(""+i);n.push("(?:"+s(i)+")")}return RegExp(n.join("|"),j?"gi":"g")}function T(a,d){function g(a){var c=a.nodeType;if(c==1){if(!b.test(a.className)){for(c=a.firstChild;c;c=c.nextSibling)g(c);c=a.nodeName.toLowerCase();if("br"===c||"li"===c)s[j]="\n",m[j<<1]=x++,m[j++<<1|1]=a}}else if(c==3||c==4)c=a.nodeValue,c.length&&(c=d?c.replace(/\r\n?/g,"\n"):c.replace(/[\t\n\r ]+/g," "),s[j]=c,m[j<<1]=x,x+=c.length,m[j++<<1|1]=
a)}var b=/(?:^|\s)nocode(?:\s|$)/,s=[],x=0,m=[],j=0;g(a);return{a:s.join("").replace(/\n$/,""),d:m}}function H(a,d,g,b){d&&(a={a:d,e:a},g(a),b.push.apply(b,a.g))}function U(a){for(var d=void 0,g=a.firstChild;g;g=g.nextSibling)var b=g.nodeType,d=b===1?d?a:g:b===3?V.test(g.nodeValue)?a:d:d;return d===a?void 0:d}function C(a,d){function g(a){for(var j=a.e,k=[j,"pln"],c=0,i=a.a.match(s)||[],r={},n=0,e=i.length;n<e;++n){var z=i[n],w=r[z],t=void 0,f;if(typeof w==="string")f=!1;else{var h=b[z.charAt(0)];
if(h)t=z.match(h[1]),w=h[0];else{for(f=0;f<x;++f)if(h=d[f],t=z.match(h[1])){w=h[0];break}t||(w="pln")}if((f=w.length>=5&&"lang-"===w.substring(0,5))&&!(t&&typeof t[1]==="string"))f=!1,w="src";f||(r[z]=w)}h=c;c+=z.length;if(f){f=t[1];var l=z.indexOf(f),B=l+f.length;t[2]&&(B=z.length-t[2].length,l=B-f.length);w=w.substring(5);H(j+h,z.substring(0,l),g,k);H(j+h+l,f,I(w,f),k);H(j+h+B,z.substring(B),g,k)}else k.push(j+h,w)}a.g=k}var b={},s;(function(){for(var g=a.concat(d),j=[],k={},c=0,i=g.length;c<i;++c){var r=
g[c],n=r[3];if(n)for(var e=n.length;--e>=0;)b[n.charAt(e)]=r;r=r[1];n=""+r;k.hasOwnProperty(n)||(j.push(r),k[n]=q)}j.push(/[\S\s]/);s=S(j)})();var x=d.length;return g}function v(a){var d=[],g=[];a.tripleQuotedStrings?d.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?d.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
q,"'\"`"]):d.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&g.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var b=a.hashComments;b&&(a.cStyleComments?(b>1?d.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):d.push(["com",/^#(?:(?:define|e(?:l|nd)if|else|error|ifn?def|include|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),g.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h(?:h|pp|\+\+)?|[a-z]\w*)>/,q])):d.push(["com",
/^#[^\n\r]*/,q,"#"]));a.cStyleComments&&(g.push(["com",/^\/\/[^\n\r]*/,q]),g.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));if(b=a.regexLiterals){var s=(b=b>1?"":"\n\r")?".":"[\\S\\s]";g.push(["lang-regex",RegExp("^(?:^^\\.?|[+-]|[!=]=?=?|\\#|%=?|&&?=?|\\(|\\*=?|[+\\-]=|->|\\/=?|::?|<<?=?|>>?>?=?|,|;|\\?|@|\\[|~|{|\\^\\^?=?|\\|\\|?=?|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\\s*("+("/(?=[^/*"+b+"])(?:[^/\\x5B\\x5C"+b+"]|\\x5C"+s+"|\\x5B(?:[^\\x5C\\x5D"+b+"]|\\x5C"+
s+")*(?:\\x5D|$))+/")+")")])}(b=a.types)&&g.push(["typ",b]);b=(""+a.keywords).replace(/^ | $/g,"");b.length&&g.push(["kwd",RegExp("^(?:"+b.replace(/[\s,]+/g,"|")+")\\b"),q]);d.push(["pln",/^\s+/,q," \r\n\t\u00a0"]);b="^.[^\\s\\w.$@'\"`/\\\\]*";a.regexLiterals&&(b+="(?!s*/)");g.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,
q],["pun",RegExp(b),q]);return C(d,g)}function J(a,d,g){function b(a){var c=a.nodeType;if(c==1&&!x.test(a.className))if("br"===a.nodeName)s(a),a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)b(a);else if((c==3||c==4)&&g){var d=a.nodeValue,i=d.match(m);if(i)c=d.substring(0,i.index),a.nodeValue=c,(d=d.substring(i.index+i[0].length))&&a.parentNode.insertBefore(j.createTextNode(d),a.nextSibling),s(a),c||a.parentNode.removeChild(a)}}function s(a){function b(a,c){var d=
c?a.cloneNode(!1):a,e=a.parentNode;if(e){var e=b(e,1),g=a.nextSibling;e.appendChild(d);for(var i=g;i;i=g)g=i.nextSibling,e.appendChild(i)}return d}for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),d;(d=a.parentNode)&&d.nodeType===1;)a=d;c.push(a)}for(var x=/(?:^|\s)nocode(?:\s|$)/,m=/\r\n?|\n/,j=a.ownerDocument,k=j.createElement("li");a.firstChild;)k.appendChild(a.firstChild);for(var c=[k],i=0;i<c.length;++i)b(c[i]);d===(d|0)&&c[0].setAttribute("value",d);var r=j.createElement("ol");
r.className="linenums";for(var d=Math.max(0,d-1|0)||0,i=0,n=c.length;i<n;++i)k=c[i],k.className="L"+(i+d)%10,k.firstChild||k.appendChild(j.createTextNode("\u00a0")),r.appendChild(k);a.appendChild(r)}function p(a,d){for(var g=d.length;--g>=0;){var b=d[g];F.hasOwnProperty(b)?D.console&&console.warn("cannot override language handler %s",b):F[b]=a}}function I(a,d){if(!a||!F.hasOwnProperty(a))a=/^\s*</.test(d)?"default-markup":"default-code";return F[a]}function K(a){var d=a.h;try{var g=T(a.c,a.i),b=g.a;
a.a=b;a.d=g.d;a.e=0;I(d,b)(a);var s=/\bMSIE\s(\d+)/.exec(navigator.userAgent),s=s&&+s[1]<=8,d=/\n/g,x=a.a,m=x.length,g=0,j=a.d,k=j.length,b=0,c=a.g,i=c.length,r=0;c[i]=m;var n,e;for(e=n=0;e<i;)c[e]!==c[e+2]?(c[n++]=c[e++],c[n++]=c[e++]):e+=2;i=n;for(e=n=0;e<i;){for(var p=c[e],w=c[e+1],t=e+2;t+2<=i&&c[t+1]===w;)t+=2;c[n++]=p;c[n++]=w;e=t}c.length=n;var f=a.c,h;if(f)h=f.style.display,f.style.display="none";try{for(;b<k;){var l=j[b+2]||m,B=c[r+2]||m,t=Math.min(l,B),A=j[b+1],G;if(A.nodeType!==1&&(G=x.substring(g,
t))){s&&(G=G.replace(d,"\r"));A.nodeValue=G;var L=A.ownerDocument,o=L.createElement("span");o.className=c[r+1];var v=A.parentNode;v.replaceChild(o,A);o.appendChild(A);g<l&&(j[b+1]=A=L.createTextNode(x.substring(t,l)),v.insertBefore(A,o.nextSibling))}g=t;g>=l&&(b+=2);g>=B&&(r+=2)}}finally{if(f)f.style.display=h}}catch(u){D.console&&console.log(u&&u.stack||u)}}var D=window,y=["break,continue,do,else,for,if,return,while"],E=[[y,"auto,case,char,const,default,double,enum,extern,float,goto,inline,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],M=[E,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,delegate,dynamic_cast,explicit,export,friend,generic,late_check,mutable,namespace,nullptr,property,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],N=[E,"abstract,assert,boolean,byte,extends,final,finally,implements,import,instanceof,interface,null,native,package,strictfp,super,synchronized,throws,transient"],
O=[N,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,internal,into,is,let,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var,virtual,where"],E=[E,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],P=[y,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
Q=[y,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],W=[y,"as,assert,const,copy,drop,enum,extern,fail,false,fn,impl,let,log,loop,match,mod,move,mut,priv,pub,pure,ref,self,static,struct,true,trait,type,unsafe,use"],y=[y,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],R=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)\b/,
V=/\S/,X=v({keywords:[M,O,E,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",P,Q,y],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),F={};p(X,["default-code"]);p(C([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",
/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),["default-markup","htm","html","mxml","xhtml","xml","xsl"]);p(C([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],
["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);p(C([],[["atv",/^[\S\s]+/]]),["uq.val"]);p(v({keywords:M,hashComments:!0,cStyleComments:!0,types:R}),["c","cc","cpp","cxx","cyc","m"]);p(v({keywords:"null,true,false"}),["json"]);p(v({keywords:O,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:R}),
["cs"]);p(v({keywords:N,cStyleComments:!0}),["java"]);p(v({keywords:y,hashComments:!0,multiLineStrings:!0}),["bash","bsh","csh","sh"]);p(v({keywords:P,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),["cv","py","python"]);p(v({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:2}),["perl","pl","pm"]);p(v({keywords:Q,
hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb","ruby"]);p(v({keywords:E,cStyleComments:!0,regexLiterals:!0}),["javascript","js"]);p(v({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,throw,true,try,unless,until,when,while,yes",hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);p(v({keywords:W,cStyleComments:!0,multilineStrings:!0}),["rc","rs","rust"]);
p(C([],[["str",/^[\S\s]+/]]),["regex"]);var Y=D.PR={createSimpleLexer:C,registerLangHandler:p,sourceDecorator:v,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ",prettyPrintOne:D.prettyPrintOne=function(a,d,g){var b=document.createElement("div");b.innerHTML="<pre>"+a+"</pre>";b=b.firstChild;g&&J(b,g,!0);K({h:d,j:g,c:b,i:1});
return b.innerHTML},prettyPrint:D.prettyPrint=function(a,d){function g(){for(var b=D.PR_SHOULD_USE_CONTINUATION?c.now()+250:Infinity;i<p.length&&c.now()<b;i++){for(var d=p[i],j=h,k=d;k=k.previousSibling;){var m=k.nodeType,o=(m===7||m===8)&&k.nodeValue;if(o?!/^\??prettify\b/.test(o):m!==3||/\S/.test(k.nodeValue))break;if(o){j={};o.replace(/\b(\w+)=([\w%+\-.:]+)/g,function(a,b,c){j[b]=c});break}}k=d.className;if((j!==h||e.test(k))&&!v.test(k)){m=!1;for(o=d.parentNode;o;o=o.parentNode)if(f.test(o.tagName)&&
o.className&&e.test(o.className)){m=!0;break}if(!m){d.className+=" prettyprinted";m=j.lang;if(!m){var m=k.match(n),y;if(!m&&(y=U(d))&&t.test(y.tagName))m=y.className.match(n);m&&(m=m[1])}if(w.test(d.tagName))o=1;else var o=d.currentStyle,u=s.defaultView,o=(o=o?o.whiteSpace:u&&u.getComputedStyle?u.getComputedStyle(d,q).getPropertyValue("white-space"):0)&&"pre"===o.substring(0,3);u=j.linenums;if(!(u=u==="true"||+u))u=(u=k.match(/\blinenums\b(?::(\d+))?/))?u[1]&&u[1].length?+u[1]:!0:!1;u&&J(d,u,o);r=
{h:m,c:d,j:u,i:o};K(r)}}}i<p.length?setTimeout(g,250):"function"===typeof a&&a()}for(var b=d||document.body,s=b.ownerDocument||document,b=[b.getElementsByTagName("pre"),b.getElementsByTagName("code"),b.getElementsByTagName("xmp")],p=[],m=0;m<b.length;++m)for(var j=0,k=b[m].length;j<k;++j)p.push(b[m][j]);var b=q,c=Date;c.now||(c={now:function(){return+new Date}});var i=0,r,n=/\blang(?:uage)?-([\w.]+)(?!\S)/,e=/\bprettyprint\b/,v=/\bprettyprinted\b/,w=/pre|xmp/i,t=/^code$/i,f=/^(?:pre|code|xmp)$/i,
h={};g()}};typeof define==="function"&&define.amd&&define("google-code-prettify",[],function(){return Y})})();}()
</script>
<script>
/*!
* Bootstrap.js by @fat & @mdo
* Copyright 2013 Twitter, Inc.
* http://www.apache.org/licenses/LICENSE-2.0.txt
*/
!function(e){"use strict";e(function(){e.support.transition=function(){var e=function(){var e=document.createElement("bootstrap"),t={WebkitTransition:"webkitTransitionEnd",MozTransition:"transitionend",OTransition:"oTransitionEnd otransitionend",transition:"transitionend"},n;for(n in t)if(e.style[n]!==undefined)return t[n]}();return e&&{end:e}}()})}(window.jQuery),!function(e){"use strict";var t='[data-dismiss="alert"]',n=function(n){e(n).on("click",t,this.close)};n.prototype.close=function(t){function s(){i.trigger("closed").remove()}var n=e(this),r=n.attr("data-target"),i;r||(r=n.attr("href"),r=r&&r.replace(/.*(?=#[^\s]*$)/,"")),i=e(r),t&&t.preventDefault(),i.length||(i=n.hasClass("alert")?n:n.parent()),i.trigger(t=e.Event("close"));if(t.isDefaultPrevented())return;i.removeClass("in"),e.support.transition&&i.hasClass("fade")?i.on(e.support.transition.end,s):s()};var r=e.fn.alert;e.fn.alert=function(t){return this.each(function(){var r=e(this),i=r.data("alert");i||r.data("alert",i=new n(this)),typeof t=="string"&&i[t].call(r)})},e.fn.alert.Constructor=n,e.fn.alert.noConflict=function(){return e.fn.alert=r,this},e(document).on("click.alert.data-api",t,n.prototype.close)}(window.jQuery),!function(e){"use strict";var t=function(t,n){this.$element=e(t),this.options=e.extend({},e.fn.button.defaults,n)};t.prototype.setState=function(e){var t="disabled",n=this.$element,r=n.data(),i=n.is("input")?"val":"html";e+="Text",r.resetText||n.data("resetText",n[i]()),n[i](r[e]||this.options[e]),setTimeout(function(){e=="loadingText"?n.addClass(t).attr(t,t):n.removeClass(t).removeAttr(t)},0)},t.prototype.toggle=function(){var e=this.$element.closest('[data-toggle="buttons-radio"]');e&&e.find(".active").removeClass("active"),this.$element.toggleClass("active")};var n=e.fn.button;e.fn.button=function(n){return this.each(function(){var r=e(this),i=r.data("button"),s=typeof n=="object"&&n;i||r.data("button",i=new t(this,s)),n=="toggle"?i.toggle():n&&i.setState(n)})},e.fn.button.defaults={loadingText:"loading..."},e.fn.button.Constructor=t,e.fn.button.noConflict=function(){return e.fn.button=n,this},e(document).on("click.button.data-api","[data-toggle^=button]",function(t){var n=e(t.target);n.hasClass("btn")||(n=n.closest(".btn")),n.button("toggle")})}(window.jQuery),!function(e){"use strict";var t=function(t,n){this.$element=e(t),this.$indicators=this.$element.find(".carousel-indicators"),this.options=n,this.options.pause=="hover"&&this.$element.on("mouseenter",e.proxy(this.pause,this)).on("mouseleave",e.proxy(this.cycle,this))};t.prototype={cycle:function(t){return t||(this.paused=!1),this.interval&&clearInterval(this.interval),this.options.interval&&!this.paused&&(this.interval=setInterval(e.proxy(this.next,this),this.options.interval)),this},getActiveIndex:function(){return this.$active=this.$element.find(".item.active"),this.$items=this.$active.parent().children(),this.$items.index(this.$active)},to:function(t){var n=this.getActiveIndex(),r=this;if(t>this.$items.length-1||t<0)return;return this.sliding?this.$element.one("slid",function(){r.to(t)}):n==t?this.pause().cycle():this.slide(t>n?"next":"prev",e(this.$items[t]))},pause:function(t){return t||(this.paused=!0),this.$element.find(".next, .prev").length&&e.support.transition.end&&(this.$element.trigger(e.support.transition.end),this.cycle(!0)),clearInterval(this.interval),this.interval=null,this},next:function(){if(this.sliding)return;return this.slide("next")},prev:function(){if(this.sliding)return;return this.slide("prev")},slide:function(t,n){var r=this.$element.find(".item.active"),i=n||r[t](),s=this.interval,o=t=="next"?"left":"right",u=t=="next"?"first":"last",a=this,f;this.sliding=!0,s&&this.pause(),i=i.length?i:this.$element.find(".item")[u](),f=e.Event("slide",{relatedTarget:i[0],direction:o});if(i.hasClass("active"))return;this.$indicators.length&&(this.$indicators.find(".active").removeClass("active"),this.$element.one("slid",function(){var t=e(a.$indicators.children()[a.getActiveIndex()]);t&&t.addClass("active")}));if(e.support.transition&&this.$element.hasClass("slide"))
</script>
<script>
/**
* marked - a markdown parser
* Copyright (c) 2011-2014, Christopher Jeffrey. (MIT Licensed)
* https://github.com/chjj/marked
*/
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
(function(){var block={newline:/^\n+/,code:/^( {4}[^\n]+\n*)+/,fences:noop,hr:/^( *[-*_]){3,} *(?:\n+|$)/,heading:/^ *(#{1,6}) *([^\n]+?) *#* *(?:\n+|$)/,nptable:noop,lheading:/^([^\n]+)\n *(=|-){2,} *(?:\n+|$)/,blockquote:/^( *>[^\n]+(\n(?!def)[^\n]+)*\n*)+/,list:/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/,html:/^ *(?:comment *(?:\n|\s*$)|closed *(?:\n{2,}|\s*$)|closing *(?:\n{2,}|\s*$))/,def:/^ *\[([^\]]+)\]: *<?([^\s>]+)>?(?: +["(]([^\n]+)[")])? *(?:\n+|$)/,table:noop,paragraph:/^((?:[^\n]+\n?(?!hr|heading|lheading|blockquote|tag|def))+)\n*/,text:/^[^\n]+/};block.bullet=/(?:[*+-]|\d+\.)/;block.item=/^( *)(bull) [^\n]*(?:\n(?!\1bull )[^\n]*)*/;block.item=replace(block.item,"gm")(/bull/g,block.bullet)();block.list=replace(block.list)(/bull/g,block.bullet)("hr","\\n+(?=\\1?(?:[-*_] *){3,}(?:\\n+|$))")("def","\\n+(?="+block.def.source+")")();block.blockquote=replace(block.blockquote)("def",block.def)();block._tag="(?!(?:"+"a|em|strong|small|s|cite|q|dfn|abbr|data|time|code"+"|var|samp|kbd|sub|sup|i|b|u|mark|ruby|rt|rp|bdi|bdo"+"|span|br|wbr|ins|del|img)\\b)\\w+(?!:/|[^\\w\\s@]*@)\\b";block.html=replace(block.html)("comment",/<!--[\s\S]*?-->/)("closed",/<(tag)[\s\S]+?<\/\1>/)("closing",/<tag(?:"[^"]*"|'[^']*'|[^'">])*?>/)(/tag/g,block._tag)();block.paragraph=replace(block.paragraph)("hr",block.hr)("heading",block.heading)("lheading",block.lheading)("blockquote",block.blockquote)("tag","<"+block._tag)("def",block.def)();block.normal=merge({},block);block.gfm=merge({},block.normal,{fences:/^ *(`{3,}|~{3,})[ \.]*(\S+)? *\n([\s\S]*?)\s*\1 *(?:\n+|$)/,paragraph:/^/,heading:/^ *(#{1,6}) +([^\n]+?) *#* *(?:\n+|$)/});block.gfm.paragraph=replace(block.paragraph)("(?!","(?!"+block.gfm.fences.source.replace("\\1","\\2")+"|"+block.list.source.replace("\\1","\\3")+"|")();block.tables=merge({},block.gfm,{nptable:/^ *(\S.*\|.*)\n *([-:]+ *\|[-| :]*)\n((?:.*\|.*(?:\n|$))*)\n*/,table:/^ *\|(.+)\n *\|( *[-:]+[-| :]*)\n((?: *\|.*(?:\n|$))*)\n*/});function Lexer(options){this.tokens=[];this.tokens.links={};this.options=options||marked.defaults;this.rules=block.normal;if(this.options.gfm){if(this.options.tables){this.rules=block.tables}else{this.rules=block.gfm}}}Lexer.rules=block;Lexer.lex=function(src,options){var lexer=new Lexer(options);return lexer.lex(src)};Lexer.prototype.lex=function(src){src=src.replace(/\r\n|\r/g,"\n").replace(/\t/g," ").replace(/\u00a0/g," ").replace(/\u2424/g,"\n");return this.token(src,true)};Lexer.prototype.token=function(src,top,bq){var src=src.replace(/^ +$/gm,""),next,loose,cap,bull,b,item,space,i,l;while(src){if(cap=this.rules.newline.exec(src)){src=src.substring(cap[0].length);if(cap[0].length>1){this.tokens.push({type:"space"})}}if(cap=this.rules.code.exec(src)){src=src.substring(cap[0].length);cap=cap[0].replace(/^ {4}/gm,"");this.tokens.push({type:"code",text:!this.options.pedantic?cap.replace(/\n+$/,""):cap});continue}if(cap=this.rules.fences.exec(src)){src=src.substring(cap[0].length);this.tokens.push({type:"code",lang:cap[2],text:cap[3]||""});continue}if(cap=this.rules.heading.exec(src)){src=src.substring(cap[0].length);this.tokens.push({type:"heading",depth:cap[1].length,text:cap[2]});continue}if(top&&(cap=this.rules.nptable.exec(src))){src=src.substring(cap[0].length);item={type:"table",header:cap[1].replace(/^ *| *\| *$/g,"").split(/ *\| */),align:cap[2].replace(/^ *|\| *$/g,"").split(/ *\| */),cells:cap[3].replace(/\n$/,"").split("\n")};for(i=0;i<item.align.length;i++){if(/^ *-+: *$/.test(item.align[i])){item.align[i]="right"}else if(/^ *:-+: *$/.test(item.align[i])){item.align[i]="center"}else if(/^ *:-+ *$/.test(item.align[i])){item.align[i]="left"}else{item.align[i]=null}}for(i=0;i<item.cells.length;i++){item.cells[i]=item.cells[i].split(/ *\| */)}this.tokens.push(item);continue}if(cap=this.rules.lheading.exec(src)){src=src.substring(cap[0].length);this.tokens.push({type:"heading",depth:cap[2]==="="?1:2,text:cap[1]});continue}if(cap=this.rules.hr.exec(src)){src=src.substring(cap[0].length);this.tokens.push({type:"hr"});continue}if(cap=this.rules.blockquote.exec(src)){src=
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</script>
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$( document ).ready(function() {
marked.setOptions({
renderer: new marked.Renderer(),
gfm: true,
tables: true,
breaks: false,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false
});
var textFile = null;
/// Function to be used to download a text json schema
function makeTextFile(text) {
var data = new Blob([text], {type: 'text/plain'});
// If we are replacing a previously generated file we need to
// manually revoke the object URL to avoid memory leaks.
if (textFile !== null) {
window.URL.revokeObjectURL(textFile);
}
textFile = window.URL.createObjectURL(data);
var a = document.createElement("a");
document.body.appendChild(a);
a.style = "display: none";
a.href = textFile;
a.download = 'schema.txt';
a.click();
return textFile;
};
/// TODO: Implement resizing for expanding within iframe
function callResize() {
window.parent.postMessage('resize', "*");
}
function processMarked() {
$(".marked").each(function() {
$(this).html(marked($(this).html()));
});
}
// Bootstrap Scrollspy
$(this).scrollspy({ target: '#scrollingNav', offset: 18 });
// Content-Scroll on Navigation click.
$('.sidenav').find('a').on('click', function(e) {
e.preventDefault();
var id = $(this).attr('href');
if ($(id).length > 0)
$('html,body').animate({ scrollTop: parseInt($(id).offset().top) }, 400);
window.location.hash = $(this).attr('href');
});
// Quickjump on Pageload to hash position.
if(window.location.hash) {
var id = window.location.hash;
if ($(id).length > 0)
$('html,body').animate({ scrollTop: parseInt($(id).offset().top) }, 0);
}
function initDynamic() {
// tabs
$('.nav-tabs-examples a').click(function (e) {
e.preventDefault();
$(this).tab('show');
});
$('.nav-tabs-examples').find('a:first').tab('show');
// call scrollspy refresh method
$(window).scrollspy('refresh');
}
initDynamic();
// Pre- / Code-Format
prettyPrint();
//Convert elements with "marked" class to markdown
processMarked();
});
</script>
<style type="text/css">
/*!
* Bootstrap v2.3.2
*
* Copyright 2013 Twitter, Inc
* Licensed under the Apache License v2.0
* http://www.apache.org/licenses/LICENSE-2.0
*
* Designed and built with all the love in the world by @mdo and @fat.
*/.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;line-height:0;content:""}.clearfix:after{clear:both}.hide-text{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.input-block-level{display:block;width:100%;min-height:30px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}a:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}a:hover,a:active{outline:0}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{width:auto\9;height:auto;max-width:100%;vertical-align:middle;border:0;-ms-interpolation-mode:bicubic}#map_canvas img,.google-maps img{max-width:none}button,input,select,textarea{margin:0;font-size:100%;vertical-align:middle}button,input{*overflow:visible;line-height:normal}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}button,html input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button}label,select,button,input[type="button"],input[type="reset"],input[type="submit"],input[type="radio"],input[type="checkbox"]{cursor:pointer}input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}textarea{overflow:auto;vertical-align:top}@media print{*{color:#000!important;text-shadow:none!important;background:transparent!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}body{margin:0;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:20px;color:#333;background-color:#fff}a{color:#08c;text-decoration:none}a:hover,a:focus{color:#005580;text-decoration:underline}.img-rounded{-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px}.img-polaroid{padding:4px;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);-webkit-box-shadow:0 1px 3px rgba(0,0,0,0.1);-moz-box-shadow:0 1px 3px rgba(0,0,0,0.1);box-shadow:0 1px 3px rgba(0,0,0,0.1)}.img-circle{-webkit-border-radius:500px;-moz-border-radius:500px;border-radius:500px}.row{margin-left:-20px;*zoom:1}.row:before,.row:after{display:table;line-height:0;content:""}.row:after{clear:both}[class*="span"]{float:left;min-height:1px;margin-left:20px}.container,.navbar-static-top .container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:940px}.span12{width:940px}.span11{width:860px}.span10{width:780px}.span9{width:700px}.span8{width:620px}.span7{width:540px}.span6{width:460px}.span5{width:380px}.span4{width:300px}.span3{width:220px}.span2{width:140px}.span1{width:60px}.offset12{margin-left:980px}.offset11{margin-left:900px}.offset10{margin-left:820px}.offset9{margin-left:740px}.offset8{margin-left:660px}.offset7{margin-left:580px}.offset6{margin-left:500px}.offset5{margin-left:420px}.offset4{margin-left:340px}.offset3{margin-left:260px}.offset2{margin-left:180px}.offset1{margin-left:100px}.row-fluid{width:100%;*zoom:1}.row-fluid:before,.row-fluid:after{display:table;line-height:0;content:""}.row-fluid:after{clear:both}.row-fluid [class*="span"]{display:block;float:left;width:100%;min-height:30px;margin-left:2.127659574468085%;*margin-left:2.074468085106383%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-
/* Pretty printing styles. Used with prettify.js. */
/* Vim sunburst theme by David Leibovic */
pre .str {
color: #65B042;
}
/* string - green */
pre .kwd {
color: #E28964;
}
/* keyword - dark pink */
pre .com {
color: #AEAEAE;
font-style: italic;
}
/* comment - gray */
pre .typ {
color: #89bdff;
}
/* type - light blue */
pre .lit {
color: #3387CC;
}
/* literal - blue */
pre .pun {
color: #fff;
}
/* punctuation - white */
pre .pln {
color: #fff;
}
/* plaintext - white */
pre .tag {
color: #89bdff;
}
/* html/xml tag - light blue */
pre .atn {
color: #bdb76b;
}
/* html/xml attribute name - khaki */
pre .atv {
color: #65B042;
}
/* html/xml attribute value - green */
pre .dec {
color: #3387CC;
}
/* decimal - blue */
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0;
color: #AEAEAE;
}
/* IE indents via margin-left */
li.L0,
li.L1,
li.L2,
li.L3,
li.L5,
li.L6,
li.L7,
li.L8 {
list-style-type: none;
}
/* Alternate shading for lines */
@media print {
pre .str {
color: #060;
}
pre .kwd {
color: #006;
font-weight: bold;
}
pre .com {
color: #600;
font-style: italic;
}
pre .typ {
color: #404;
font-weight: bold;
}
pre .lit {
color: #044;
}
pre .pun {
color: #440;
}
pre .pln {
color: #000;
}
pre .tag {
color: #006;
font-weight: bold;
}
pre .atn {
color: #404;
}
pre .atv {
color: #060;
}
}
/* ------------------------------------------------------------------------------------------
* Content
* ------------------------------------------------------------------------------------------ */
@import url('https://fonts.googleapis.com/css?family=Source+Code+Pro');
* {
font-family: 'Source Code Pro', sans-serif;
}
body {
min-width: 980px;
}
body, p, a, div, th, td {
font-family: "Source Sans Pro", sans-serif;
font-weight: 400;
font-size: 16px;
text-shadow: none !important;
}
td.code {
font-size: 14px;
font-family: "Source Code Pro", monospace;
font-style: normal;
font-weight: 400;
}
#content {
padding-top: 16px;
z-Index: -1;
margin-left: 270px;
}
p {
color: #808080;
}
h1 {
font-family: "Source Sans Pro Semibold", sans-serif;
font-weight: normal;
font-size: 44px;
line-height: 50px;
margin: 0 0 10px 0;
padding: 0;
}
h2 {
font-family: "Source Sans Pro", sans-serif;
font-weight: normal;
font-size: 24px;
line-height: 40px;
margin: 0 0 20px 0;
padding: 0;
}
section {
border-top: 1px solid #ebebeb;
padding: 30px 0;
}
section h1 {
font-family: "Source Sans Pro", sans-serif;
font-weight: 700;
font-size: 32px;
line-height: 40px;
padding-bottom: 14px;
margin: 0 0 20px 0;
padding: 0;
}
article {
padding: 14px 0 30px 0;
}
article h1 {
font-family: "Source Sans Pro Bold", sans-serif;
font-weight: 600;
font-size: 24px;
line-height: 26px;
}
article h2 {
font-family: "Source Sans Pro", sans-serif;
font-weight: 600;
font-size: 18px;
line-height: 24px;
margin: 0 0 10px 0;
}
article h3 {
font-family: "Source Sans Pro", sans-serif;
font-weight: 600;
font-size: 16px;
line-height: 18px;
margin: 0 0 10px 0;
}
article h4 {
font-family: "Source Sans Pro", sans-serif;
font-weight: 600;
font-size: 14px;
line-height: 16px;
margin: 0 0 8px 0;
}
table {
border-collapse: collapse;
width: 100%;
margin: 0 0 20px 0;
}
th {
background-color: #f5f5f5;
text-align: left;
font-family: "Source Sans Pro", sans-serif;
font-weight: 700;
padding: 4px 8px;
border: #e0e0e0 1px solid;
}
td {
vertical-align: top;
padding: 2px 8px;
border: #e0e0e0 1px solid;
}
#generator .content {
color: #b0b0b0;
border-top: 1px solid #ebebeb;
padding: 10px 0;
}
.label-optional {
float: right;
}
.open-left {
right: 0;
left: auto;
}
/* ------------------------------------------------------------------------------------------
* apidoc - intro
* ------------------------------------------------------------------------------------------ */
#apidoc .apidoc {
border-top: 1px solid #ebebeb;
padding: 30px 0;
}
#apidoc h1 {
font-family: "Source Sans Pro", sans-serif;
font-weight: 700;
font-size: 32px;
line-height: 40px;
padding-bottom: 14px;
margin: 0 0 20px 0;
padding: 0;
}
#apidoc h2 {
font-family: "Source Sans Pro Bold", sans-serif;
font-weight: 600;
font-size: 22px;
line-height: 26px;
padding-top: 14px;
}
/* ------------------------------------------------------------------------------------------
* pre / code
* ------------------------------------------------------------------------------------------ */
pre {
background-color: #292b36;
color: #ffffff;
padding: 10px;
border-radius: 6px;
position: relative;
margin: 10px 0 20px 0;
}
code.language-text {
word-wrap: break-word;
}
pre.language-json {
overflow: auto;
}
pre.language-html {
margin: 40px 0 20px 0;
}
pre.language-html:before {
content: attr(data-type);
position: absolute;
top: -30px;
left: 0;
font-family: "Source Sans Pro", sans-serif;
font-weight: 600;
font-size: 15px;
display: inline-block;
padding: 2px 5px;
border-radius: 6px;
text-transform: uppercase;
background-color: #3387CC;
color: #ffffff;
}
pre.language-html[data-type="get"]:before {
background-color: green;
}
pre.language-html[data-type="put"]:before {
background-color: #e5c500;
}
pre.language-html[data-type="post"]:before {
background-color: #4070ec;
}
pre.language-html[data-type="delete"]:before {
background-color: #ed0039;
}
pre.language-api .str {
color: #ffffff;
}
pre.language-api .pln,
pre.language-api .pun {
color: #65B042;
}
pre code {
display: block;
font-size: 14px;
font-family: "Source Code Pro", monospace;
font-style: normal;
font-weight: 400;
}
pre code.sample-request-response-json {
white-space: pre-wrap;
max-height: 500px;
overflow: auto;
}
/* ------------------------------------------------------------------------------------------
* Sidenav
* ------------------------------------------------------------------------------------------ */
.sidenav {
width: 228px;
margin: 0;
padding: 20px;
position: fixed;
top: 0;
left: 0;
bottom: 0;
overflow-x: hidden;
overflow-y: auto;
background-color: #f5f5f5;
z-index: 10;
}
.sidenav > li > a {
display: block;
width: 192px;
margin: 0;
padding: 2px 11px;
border: 0;
border-left: transparent 4px solid;
border-right: transparent 4px solid;
font-family: "Source Sans Pro", sans-serif;
font-weight: 400;
font-size: 14px;
}
.sidenav > li.nav-header > a {
padding: 5px 15px;
border: 1px solid #e5e5e5;
width: 190px;
font-family: "Source Sans Pro", sans-serif;
font-weight: 700;
font-size: 16px;
background-color: #4c8eca;
color: #fff;
}
.sidenav > li.nav-header.active > a {
background-color: #4c8eca;
color: #fff;
}
00427D
.sidenav > .active > a {
position: relative;
z-index: 2;
}
.sidenav > li > a:hover {
background-color: #ffffff;
}
.sidenav > li.has-modifications a {
border-right: #60d060 4px solid;
}
.sidenav > li.is-new a {
border-left: #e5e5e5 4px solid;
}
/* ------------------------------------------------------------------------------------------
* Tabs
* ------------------------------------------------------------------------------------------ */
ul.nav-tabs {
margin: 0;
}
/* ------------------------------------------------------------------------------------------
* Print
* ------------------------------------------------------------------------------------------ */
@media print {
#sidenav,
#version,
#versions,
section .version,
section .versions {
display: none;
}
#content {
margin-left: 0;
}
a {
text-decoration: none;
color: inherit;
}
a:after {
content: " [" attr(href) "] ";
}
p {
color: #000000
}
pre {
background-color: #ffffff;
color: #000000;
padding: 10px;
border: #808080 1px solid;
border-radius: 6px;
position: relative;
margin: 10px 0 20px 0;
}
} /* /@media print */
.doc-chapter
{
display:none;
background-color: #eee;
border-radius: 1px;
padding: 10px;
margin-bottom: 20px;
}
/*!
* json-schema-view-js
* https://github.com/mohsen1/json-schema-view-js#readme
* Version: 0.4.1 - 2015-11-12T17:19:27.615Z
* License: MIT
*/.json-schema-view .toggle-handle:after,.json-schema-view.json-schema-view-dark .toggle-handle:after,json-schema-view .toggle-handle:after,json-schema-view[json-schema-view-dark] .toggle-handle:after{content:"\25BC"}.json-schema-view .title,.json-schema-view.json-schema-view-dark .title,json-schema-view .title,json-schema-view[json-schema-view-dark] .title{font-weight:700;cursor:pointer}.json-schema-view,json-schema-view{font-family:monospace;font-size:0;display:table-cell}.json-schema-view>*,json-schema-view>*{font-size:14px}.json-schema-view .toggle-handle,json-schema-view .toggle-handle{cursor:pointer;margin:auto .3em;font-size:10px;display:inline-block;transform-origin:50% 40%;transition:transform 150ms ease-in}.json-schema-view .toggle-handle,.json-schema-view .toggle-handle:hover,json-schema-view .toggle-handle,json-schema-view .toggle-handle:hover{text-decoration:none;color:#333}.json-schema-view .description,json-schema-view .description{color:gray;font-style:italic}
.pattern {
color: blue;
}
.default {
color: black;
}
.required {
color:black;
}
.json-schema-view .title,.json-schema-view .title:hover,json-schema-view .title,json-schema-view .title:hover{text-decoration:none;color:#333}.json-schema-view .brace,.json-schema-view .bracket,.json-schema-view .title,json-schema-view .brace,json-schema-view .bracket,json-schema-view .title{color:#333}.json-schema-view .property,json-schema-view .property{font-size:0;display:table-row}.json-schema-view .property>*,json-schema-view .property>*{font-size:14px;padding:.2em}.json-schema-view .name,json-schema-view .name{color:#00f;display:table-cell;vertical-align:top}.json-schema-view .type,json-schema-view .type{color:green}.json-schema-view .type-any,json-schema-view .type-any{color:#33f}.json-schema-view .required,json-schema-view .required{color:red}.json-schema-view .inner,json-schema-view .inner{padding-left:18px}.json-schema-view.collapsed .description,.json-schema-view.collapsed .property,json-schema-view.collapsed .description,json-schema-view.collapsed .property{display:none}.json-schema-view.collapsed .closeing.brace,json-schema-view.collapsed .closeing.brace{display:inline-block}.json-schema-view.collapsed .toggle-handle,json-schema-view.collapsed .toggle-handle{transform:rotate(-90deg)}.json-schema-view.json-schema-view-dark,json-schema-view[json-schema-view-dark]{font-family:monospace;font-size:0;display:table-cell}.json-schema-view.json-schema-view-dark>*,json-schema-view[json-schema-view-dark]>*{font-size:14px}.json-schema-view.json-schema-view-dark .toggle-handle,json-schema-view[json-schema-view-dark] .toggle-handle{cursor:pointer;margin:auto .3em;font-size:10px;display:inline-block;transform-origin:50% 40%;transition:transform 150ms ease-in}.json-schema-view.json-schema-view-dark .toggle-handle,.json-schema-view.json-schema-view-dark .toggle-handle:hover,json-schema-view[json-schema-view-dark] .toggle-handle,json-schema-view[json-schema-view-dark] .toggle-handle:hover{text-decoration:none;color:#eee}.json-schema-view.json-schema-view-dark .description,json-schema-view[json-schema-view-dark] .description{color:gray;font-style:italic}.json-schema-view.json-schema-view-dark .title,.json-schema-view.json-schema-view-dark .title:hover,json-schema-view[json-schema-view-dark] .title,json-schema-view[json-schema-view-dark] .title:hover{text-decoration:none;color:#eee}.json-schema-view.json-schema-view-dark .brace,.json-schema-view.json-schema-view-dark .bracket,.json-schema-view.json-schema-view-dark .title,json-schema-view[json-schema-view-dark] .brace,json-schema-view[json-schema-view-dark] .bracket,json-schema-view[json-schema-view-dark] .title{color:#eee}.json-schema-view.json-schema-view-dark .property,json-schema-view[json-schema-view-dark] .property{font-size:0;display:table-row}.json-schema-view.json-schema-view-dark .property>*,json-schema-view[json-schema-view-dark] .property>*{font-size:14px;padding:.2em}.json-schema-view.json-schema-view-dark .name,json-schema-view[json-schema-view-dark] .name{color:#add8e6;display:table-cell;vertical-align:top}.json-schema-view.json-schema-view-dark .type,json-schema-view[json-schema-view-dark] .type{color:#90ee90}.json-schema-view.json-schema-view-dark .type-any,json-schema-view[json-schema-view-dark] .type-any{color:#d4ebf2}.json-schema-view.json-schema-view-dark .required,json-schema-view[json-schema-view-dark] .required{color:#fe0000}.json-schema-view.json-schema-view-dark .inner,json-schema-view[json-schema-view-dark] .inner{padding-left:18px}.json-schema-view.json-schema-view-dark.collapsed .description,.json-schema-view.json-schema-view-dark.collapsed .property,json-schema-view[json-schema-view-dark].collapsed .description,json-schema-view[json-schema-view-dark].collapsed .property{display:none}.json-schema-view.json-schema-view-dark.collapsed .closeing.brace,json-schema-view[json-schema-view-dark].collapsed .closeing.brace{display:inline-block}.json-schema-view.json-schema-view-dark.collapsed .toggle-handle,json-schema-view[json-schema-view-dark].collapsed .toggle-handle{transform:rotate(-90deg)}
</style>
</head>
<body>
<script>
// Script section to load models into a JS Var
var defs = {}
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
defs.AMDemodReport = {
"properties" : {
"channelPowerDB" : {
"type" : "number",
"format" : "float",
"description" : "power received in channel (dB)"
},
"squelch" : {
"type" : "integer",
"description" : "squelch status (1 if open else 0)"
}
},
"description" : "AMDemod"
};
defs.AMDemodSettings = {
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
"format" : "int64",
"description" : "channel center frequency shift from baseband center in Hz"
},
"rfBandwidth" : {
"type" : "number",
"format" : "float",
Web API: AirspyHF: implemented settings entry points
2018-03-22 00:10:13 -04:00
"description" : "channel RF bandwidth in Hz (floors to next 100 Hz)"
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
},
"squelch" : {
"type" : "number",
"format" : "float",
Web API: AirspyHF: implemented settings entry points
2018-03-22 00:10:13 -04:00
"description" : "power squelch threshold in decibels"
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
},
"volume" : {
"type" : "number",
"format" : "float"
},
"audioSampleRate" : {
"type" : "integer"
},
"audioMute" : {
"type" : "integer"
},
"bandpassEnable" : {
"type" : "integer",
"description" : "use bandpass filter (1 for yes, 0 for no)"
},
"copyAudioToUDP" : {
"type" : "integer"
},
"copyAudioUseRTP" : {
"type" : "integer"
},
"udpAddress" : {
"type" : "string"
},
"udpPort" : {
"type" : "integer"
},
"rgbColor" : {
"type" : "integer"
},
"title" : {
"type" : "string"
}
},
"description" : "AMDemod"
Web API: AirspyHF: implemented settings entry points
2018-03-22 00:10:13 -04:00
};
defs.AirspyHFSettings = {
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"LOppmTenths" : {
"type" : "integer"
},
"devSampleRateIndex" : {
"type" : "integer"
},
"log2Decim" : {
"type" : "integer"
},
"transverterMode" : {
"type" : "integer"
},
"transverterDeltaFrequency" : {
"type" : "integer",
"format" : "int64"
},
"bandIndex" : {
"type" : "integer"
}
},
"description" : "AirspyHF"
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
};
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
defs.AudioDevice = {
"properties" : {
"name" : {
"type" : "string",
"description" : "Displayable name of the device"
}
},
"description" : "Audio device"
};
defs.AudioDevices = {
"required" : [ "inputDeviceSelectedIndex", "inputVolume", "nbInputDevices", "nbOutputDevices", "outputDeviceSelectedIndex" ],
"properties" : {
"inputVolume" : {
"type" : "number",
"format" : "float",
"description" : "Audio input volume [0.0..1.0]"
},
"nbInputDevices" : {
"type" : "integer",
"description" : "Number of input audio devices"
},
"inputDeviceSelectedIndex" : {
"type" : "integer",
"description" : "Index of selected input audio devices (-1 if default)"
},
"inputDevices" : {
"type" : "array",
"description" : "List of input devices",
"items" : {
"$ref" : "#/definitions/AudioDevice"
}
},
"nbOutputDevices" : {
"type" : "integer",
"description" : "Number of output audio devices"
},
"outputDeviceSelectedIndex" : {
"type" : "integer",
"description" : "Index of selected output audio devices (-1 if default)"
},
"outputDevices" : {
"type" : "array",
"description" : "List of output devices",
"items" : {
"$ref" : "#/definitions/AudioDevice"
}
}
},
"description" : "List of audio devices available in the system"
};
defs.AudioDevicesSelect = {
"required" : [ "inputIndex", "inputVolume", "outputIndex" ],
"properties" : {
"inputVolume" : {
"type" : "number",
"format" : "float",
"description" : "Audio input volume [0.0..1.0]"
},
"inputIndex" : {
"type" : "integer",
"description" : "Index of the audio input device (-1 for default)"
},
"outputIndex" : {
"type" : "integer",
"description" : "Index of the audio output device (-1 for default)"
}
},
"description" : "Audio devices selected"
};
defs.CWKeyerSettings = {
"properties" : {
"sampleRate" : {
"type" : "integer"
},
"wpm" : {
"type" : "integer"
},
"mode" : {
"type" : "integer"
},
"text" : {
"type" : "string"
},
"loop" : {
"type" : "integer"
}
}
};
defs.Channel = {
"required" : [ "deltaFrequency", "id", "index", "title", "uid" ],
"properties" : {
"index" : {
"type" : "integer",
"description" : "Index in the list of channels"
},
"id" : {
"type" : "string",
"description" : "Key to identify the type of channel"
},
"uid" : {
"type" : "integer",
"format" : "int64",
"description" : "Channel instance unique id"
},
"title" : {
"type" : "string",
"description" : "Freeform title of the channel"
},
"deltaFrequency" : {
"type" : "integer",
"description" : "Channel shift frequency in Hz from the center of baseband"
Web API: entry point to get all channel reports at once
2018-03-18 19:08:38 -04:00
},
"report" : {
"$ref" : "#/definitions/ChannelReport"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
},
"description" : "Channel summarized information"
};
defs.ChannelListItem = {
"required" : [ "id" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Displayable name of the channel plugin"
},
"idURI" : {
"type" : "string",
"description" : "Key to identify the channel plugin type in URI form"
},
"id" : {
"type" : "string",
"description" : "Key to identify the channel plugin type as short object name"
},
"tx" : {
"type" : "integer",
"description" : "Not zero (true) if this is a Tx channel"
},
"version" : {
"type" : "string",
"description" : "Channel plugin version number"
},
"index" : {
"type" : "integer",
"description" : "Index of the channel in the list of registered channels"
}
},
"description" : "Summarized information about channel plugin"
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
};
defs.ChannelReport = {
"discriminator" : "channelType",
"properties" : {
"channelType" : {
"type" : "string",
"description" : "Channel type code"
},
"tx" : {
"type" : "integer",
"description" : "Not zero if it is a tx channel else it is a rx channel"
},
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"AMDemodReport" : {
"$ref" : "#/definitions/AMDemodReport"
},
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
"NFMDemodReport" : {
"$ref" : "#/definitions/NFMDemodReport"
},
"NFMModReport" : {
"$ref" : "#/definitions/NFMModReport"
}
},
Web API: implemented channel reporting entry points in server instance
2018-03-18 19:20:54 -04:00
"description" : "Base channel report. The specific channel report present depends on channelType or paremt context."
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.ChannelSettings = {
"required" : [ "channelType", "tx" ],
"discriminator" : "channelType",
"properties" : {
"channelType" : {
"type" : "string",
"description" : "Channel type code"
},
"tx" : {
"type" : "integer",
"description" : "Not zero if it is a tx channel else it is a rx channel"
},
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"AMDemodSettings" : {
"$ref" : "#/definitions/AMDemodSettings"
},
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"NFMDemodSettings" : {
"$ref" : "#/definitions/NFMDemodSettings"
},
"NFMModSettings" : {
"$ref" : "#/definitions/NFMModSettings"
}
},
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
"description" : "Base channel settings. The specific channel settings present depends on channelType."
Web API: entry point to get all channel reports at once
2018-03-18 19:08:38 -04:00
};
defs.ChannelsDetail = {
"required" : [ "channelcount" ],
"properties" : {
"channelcount" : {
"type" : "integer",
"description" : "Number of channels in the set"
},
"channels" : {
"type" : "array",
"description" : "Channels list",
"items" : {
"$ref" : "#/definitions/Channel"
}
}
},
"description" : "All channels detailed information"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.DVSeralDevices = {
"required" : [ "nbDevices" ],
"properties" : {
"nbDevices" : {
"type" : "integer",
"description" : "Number of DV serial devices"
},
"dvSerialDevices" : {
"type" : "array",
"description" : "Device names of DV serial devices",
"items" : {
"$ref" : "#/definitions/DVSerialDevice"
}
}
},
"description" : "List of DV serial devices available in the system"
};
defs.DVSerialDevice = {
"properties" : {
"deviceName" : {
"type" : "string",
"description" : "Name of the serial device in the system"
}
},
"description" : "DV serial device details"
};
defs.DeviceListItem = {
"properties" : {
"displayedName" : {
"type" : "string",
"description" : "Displayable name that uniquely identifies this device instance"
},
"hwType" : {
"type" : "string",
"description" : "Key to identify the type of hardware device"
},
"serial" : {
"type" : "string",
"description" : "Serial number of the hardware device"
},
"sequence" : {
"type" : "integer",
"description" : "Sequence in the enumeration of same device types"
},
"tx" : {
"type" : "integer",
"description" : "Set to not zero (true) if this is a Tx device"
},
"nbStreams" : {
"type" : "integer",
"description" : "Number of channels or streams in the device"
},
"streamIndex" : {
"type" : "integer",
"description" : "Index of the channel in the device"
},
"deviceSetIndex" : {
"type" : "integer",
"description" : "Index of the device set that claimed this device (-1 if not claimed)"
},
"index" : {
"type" : "integer",
"description" : "Index of the device in the list of registered devices"
}
},
"description" : "Summarized information about attached hardware device"
};
defs.DeviceSet = {
"required" : [ "channelcount", "samplingDevice" ],
"properties" : {
"samplingDevice" : {
"$ref" : "#/definitions/SamplingDevice"
},
"channelcount" : {
"type" : "integer",
"description" : "Number of channels in the set"
},
"channels" : {
"type" : "array",
"description" : "Channels list",
"items" : {
"$ref" : "#/definitions/Channel"
}
}
},
"description" : "Sampling device and its associated channels"
};
defs.DeviceSetList = {
"required" : [ "devicesetcount" ],
"properties" : {
"devicesetcount" : {
"type" : "integer",
"description" : "Number of device sets opened in this instance"
},
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
"devicesetfocus" : {
"type" : "integer",
"description" : "Index of the deviceset that has focus (relevant for GUI only)"
},
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"deviceSets" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DeviceSet"
}
}
},
"description" : "List of device sets opened in this instance"
};
defs.DeviceSettings = {
"required" : [ "deviceHwType", "tx" ],
"discriminator" : "deviceHwType",
"properties" : {
"deviceHwType" : {
"type" : "string",
"description" : "Device hardware type code"
},
"tx" : {
"type" : "integer",
"description" : "Not zero if it is a tx device else it is a rx device"
},
Web API: AirspyHF: implemented settings entry points
2018-03-22 00:10:13 -04:00
"airspyHFSettings" : {
"$ref" : "#/definitions/AirspyHFSettings"
},
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"fileSourceSettings" : {
"$ref" : "#/definitions/FileSourceSettings"
},
Server and web API: added HackRF support
2017-12-28 19:40:34 -05:00
"hackRFInputSettings" : {
"$ref" : "#/definitions/HackRFInputSettings"
},
"hackRFOutputSettings" : {
"$ref" : "#/definitions/HackRFOutputSettings"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
},
"limeSdrInputSettings" : {
"$ref" : "#/definitions/LimeSdrInputSettings"
},
"limeSdrOutputSettings" : {
"$ref" : "#/definitions/LimeSdrOutputSettings"
Server and web API: added HackRF support
2017-12-28 19:40:34 -05:00
},
"rtlSdrSettings" : {
"$ref" : "#/definitions/RtlSdrSettings"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
},
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
"description" : "Base device settings. The specific device settings present depends on deviceHwType."
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.DeviceState = {
"required" : [ "state" ],
"properties" : {
"state" : {
"type" : "string",
"description" : "State: notStarted, idle, ready, running, error"
}
},
"description" : "Device running state"
};
defs.ErrorResponse = {
"required" : [ "message" ],
"properties" : {
"message" : {
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
"type" : "string",
"example" : "KO"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
}
};
defs.FileSourceSettings = {
"properties" : {
"fileName" : {
"type" : "string"
}
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
},
"description" : "FileSource"
Server and web API: added HackRF support
2017-12-28 19:40:34 -05:00
};
defs.HackRFInputSettings = {
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64"
},
"LOppmTenths" : {
"type" : "integer"
},
"bandwidth" : {
"type" : "integer"
},
"lnaGain" : {
"type" : "integer"
},
"vgaGain" : {
"type" : "integer"
},
"log2Decim" : {
"type" : "integer"
},
"fcPos" : {
"type" : "integer",
"description" : "0=Infra 1=Supra 2=Center"
},
"devSampleRate" : {
"type" : "integer"
},
"biasT" : {
"type" : "integer"
},
"lnaExt" : {
"type" : "integer"
},
"dcBlock" : {
"type" : "integer"
},
"iqCorrection" : {
"type" : "integer"
},
"linkTxFrequency" : {
"type" : "integer"
}
},
"description" : "HackRF"
};
defs.HackRFOutputSettings = {
"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"
}
},
"description" : "HackRF"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.InstanceChannelsResponse = {
"required" : [ "channelcount" ],
"properties" : {
"channelcount" : {
"type" : "integer",
"description" : "Number of plugins available"
},
"channels" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ChannelListItem"
}
}
},
"description" : "Summarized information about channel plugins available in this SDRangel instance"
};
defs.InstanceDevicesResponse = {
"required" : [ "devicecount" ],
"properties" : {
"devicecount" : {
"type" : "integer",
"description" : "Number of devices attached"
},
"devices" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DeviceListItem"
}
}
},
"description" : "Summarized information about logical devices from hardware devices attached to this SDRangel instance"
};
defs.InstanceSummaryResponse = {
24 bit DSP: document in log and Web API. Adding PID information
2018-01-22 17:29:09 -05:00
"required" : [ "appname", "devicesetlist", "dspRxBits", "dspTxBits", "pid", "qtVersion", "version" ],
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"properties" : {
"version" : {
"type" : "string",
"description" : "Current software version"
},
Web API: added Qt version in the instance summary
2017-12-18 07:19:20 -05:00
"qtVersion" : {
"type" : "string",
"description" : "Qt version with which the software was compiled"
},
24 bit DSP: document in log and Web API. Adding PID information
2018-01-22 17:29:09 -05:00
"dspRxBits" : {
"type" : "integer",
"description" : "Number of samples significant bits in software Rx DSP"
},
"dspTxBits" : {
"type" : "integer",
"description" : "Number of samples significant bits in software Tx DSP"
},
"pid" : {
"type" : "integer",
"description" : "PID of the SDRangel instance"
},
Added information about O/S, CPU architecture and application name where it was missing
2018-01-06 19:33:57 -05:00
"appname" : {
"type" : "string",
"description" : "Application name: SDRangel for a GUI instance and SDRangelSrv for a server instance"
},
"architecture" : {
"type" : "string",
"description" : "Codename of the CPU architecture on which the instance is running (available with Qt >= 5.4)"
},
"os" : {
"type" : "string",
"description" : "Descriptive text of the operating system running the instance (available with Qt >= 5.4)"
},
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"logging" : {
"$ref" : "#/definitions/LoggingInfo"
},
"devicesetlist" : {
"$ref" : "#/definitions/DeviceSetList"
}
},
"description" : "Summarized information about this SDRangel instance"
};
defs.LimeSdrInputSettings = {
"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"
}
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
},
"description" : "LimeSDR"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.LimeSdrOutputSettings = {
"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"
}
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
},
"description" : "LimeSDR"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.LocationInformation = {
"required" : [ "latitude", "longitude" ],
"properties" : {
"latitude" : {
"type" : "number",
"format" : "float",
"description" : "Lautitude in decimal degrees positive to the north"
},
"longitude" : {
"type" : "number",
"format" : "float",
"description" : "Longitude in decimal degrees positive to the east"
}
},
"description" : "Instance geolocation information"
};
defs.LoggingInfo = {
"properties" : {
"consoleLevel" : {
"type" : "string",
"description" : "Minimum level of messages printed to console: debug, info, warning, error"
},
"fileLevel" : {
"type" : "string",
"description" : "Minimum level of messages written to file: debug, info, warning, error"
},
"dumpToFile" : {
"type" : "integer",
"description" : "not zero (true) if messages are written to file"
},
"fileName" : {
"type" : "string",
"description" : "Name of the log file"
}
},
"description" : "Logging parameters setting"
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
};
defs.NFMDemodReport = {
"properties" : {
"channelPowerDB" : {
"type" : "number",
"format" : "float",
"description" : "power received in channel (dB)"
},
"ctcssTone" : {
"type" : "number",
"format" : "float",
"description" : "CTCSS tone frequency if detected else 0"
},
"squelch" : {
"type" : "integer",
"description" : "squelch status (1 if open else 0)"
}
},
"description" : "NFMDemod"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.NFMDemodSettings = {
"properties" : {
"inputFrequencyOffset" : {
"type" : "integer",
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"format" : "int64",
"description" : "channel center frequency shift from baseband center in Hz"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
},
"rfBandwidth" : {
"type" : "number",
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"format" : "float",
"description" : "channel RF bandwidth in Hz (takes closest value from RF bandwidth set)"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
},
"afBandwidth" : {
"type" : "number",
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"format" : "float",
"description" : "AF bandwidth in Hz (rounds to lower kHz)"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
},
"fmDeviation" : {
"type" : "integer"
},
"squelchGate" : {
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"type" : "integer",
"description" : "squelch gate in tens of ms"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
},
"deltaSquelch" : {
"type" : "integer"
},
"squelch" : {
"type" : "number",
Web API: AM demod: implemented settings and report entry points
2018-03-21 18:49:16 -04:00
"format" : "float",
"description" : "power squelch threshold in centi-bels"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
},
"volume" : {
"type" : "number",
"format" : "float"
},
"ctcssOn" : {
"type" : "integer"
},
"audioMute" : {
"type" : "integer"
},
"ctcssIndex" : {
"type" : "integer"
},
"audioSampleRate" : {
"type" : "integer"
},
"copyAudioToUDP" : {
"type" : "integer"
},
Web API: NFM demod: implemented use RTP indicator
2018-02-20 14:07:23 -05:00
"copyAudioUseRTP" : {
"type" : "integer"
},
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"udpAddress" : {
"type" : "string"
},
"udpPort" : {
"type" : "integer"
},
"rgbColor" : {
"type" : "integer"
},
"title" : {
"type" : "string"
}
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
},
"description" : "NFMDemod"
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
};
defs.NFMModReport = {
"properties" : {
"channelPowerDB" : {
"type" : "number",
"format" : "float",
"description" : "power transmitted in channel (dB)"
}
},
"description" : "NFMMod"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.NFMModSettings = {
"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" : "#/definitions/CWKeyerSettings"
}
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
},
"description" : "NFMMod"
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
};
defs.PresetExport = {
"properties" : {
"filePath" : {
"type" : "string",
"description" : "Path of the import file"
},
"preset" : {
"$ref" : "#/definitions/PresetIdentifier"
}
},
"description" : "Details to export a preset to file"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.PresetGroup = {
"required" : [ "groupName", "nbPresets" ],
"properties" : {
"groupName" : {
"type" : "string",
"description" : "Name of the preset group"
},
"nbPresets" : {
"type" : "integer",
"description" : "Number of presets in the group"
},
"presets" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/PresetItem"
}
}
},
"description" : "Group of presets"
};
defs.PresetIdentifier = {
"required" : [ "centerFrequency", "groupName", "name", "type" ],
"properties" : {
"groupName" : {
"type" : "string",
"description" : "Name of the preset group"
},
"centerFrequency" : {
"type" : "integer",
"format" : "int64",
"description" : "Center freqeuency in Hz"
},
"type" : {
"type" : "string",
"description" : "Type of device set (R: Rx, T: Tx)"
},
"name" : {
"type" : "string",
"description" : "Descriptive name of the preset"
}
},
"description" : "Settings preset item"
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
};
defs.PresetImport = {
"required" : [ "filePath" ],
"properties" : {
"groupName" : {
"type" : "string",
"description" : "If present overrides imported preset group name with this name"
},
"description" : {
"type" : "string",
"description" : "If present overrides imported preset description with this description"
},
"filePath" : {
"type" : "string",
"description" : "Path of the import file"
}
},
"description" : "Details to import preset from file in preset list"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.PresetItem = {
"required" : [ "centerFrequency", "name", "type" ],
"properties" : {
"centerFrequency" : {
"type" : "integer",
"format" : "int64",
"description" : "Center freqeuency in Hz"
},
"type" : {
"type" : "string",
"description" : "Type of device set (R: Rx, T: Tx)"
},
"name" : {
"type" : "string",
"description" : "Descriptive name of the preset"
}
},
"description" : "Settings preset item"
};
defs.PresetTransfer = {
"required" : [ "deviceSetIndex", "preset" ],
"properties" : {
"deviceSetIndex" : {
"type" : "integer",
"description" : "Index of the device set"
},
"preset" : {
"$ref" : "#/definitions/PresetIdentifier"
}
},
"description" : "Preset transfer to or from a device set"
};
defs.Presets = {
"required" : [ "nbGroups" ],
"properties" : {
"nbGroups" : {
"type" : "integer",
"description" : "Number of preset groups"
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/PresetGroup"
}
}
},
"description" : "Settings presets"
};
defs.RtlSdrSettings = {
"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"
RTL-SDR: added RF bandwidth setting in web API
2018-01-16 14:03:18 -05:00
},
"rfBandwidth" : {
"type" : "integer"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
},
"description" : "RTLSDR"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
};
defs.SamplingDevice = {
"required" : [ "bandwidth", "centerFrequency", "hwType", "index", "sequence", "serial", "state", "streamIndex" ],
"properties" : {
"index" : {
"type" : "integer",
"description" : "Index in the list of device sets opened in this instance"
},
"hwType" : {
"type" : "string",
"description" : "Key to identify the type of hardware device"
},
"tx" : {
"type" : "integer",
"description" : "Not zero (true) if this is a Tx device"
},
"nbStreams" : {
"type" : "integer",
"description" : "Number of channels or streams in the device"
},
"streamIndex" : {
"type" : "integer",
"description" : "Index of the channel in the device"
},
"sequence" : {
"type" : "integer",
"description" : "Sequence in the enumeration of same device types"
},
"serial" : {
"type" : "string",
"description" : "Serial number of the hardware device"
},
"centerFrequency" : {
"type" : "integer",
"format" : "int64",
"description" : "Center frequency in Hz at which the device is tuned possibly taking NCO into account"
},
"bandwidth" : {
"type" : "integer",
"description" : "Bandwidth in Hz or complex S/s of baseband"
},
"state" : {
"type" : "string",
"description" : "State: notStarted, idle, ready, running, error"
}
},
"description" : "Information about a logical device available from an attached hardware device that can be used as a sampling device"
Web API: suppress waiting after asynchronous message posting and return 200 with a simple message
2017-12-19 11:55:05 -05:00
};
defs.SuccessResponse = {
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string"
}
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
</script>
<div class="container-fluid">
<div class="row-fluid">
<div id="sidenav" class="span2">
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<!-- Logo Area -->
<!--<div style="width: 80%; background-color: #4c8eca; color: white; padding: 20px; text-align: center; margin-bottom: 20px; ">
API Docs 2
</div>
-->
<li class="nav-fixed nav-header active" data-group="_"><a href="#api-_">API Summary</a></li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="nav-header" data-group="DeviceSet"><a href="#api-DeviceSet">API Methods - DeviceSet</a></li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<li data-group="DeviceSet" data-name="devicesetChannelDelete" class="">
<a href="#api-DeviceSet-devicesetChannelDelete">devicesetChannelDelete</a>
</li>
<li data-group="DeviceSet" data-name="devicesetChannelPost" class="">
<a href="#api-DeviceSet-devicesetChannelPost">devicesetChannelPost</a>
</li>
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
<li data-group="DeviceSet" data-name="devicesetChannelReportGet" class="">
<a href="#api-DeviceSet-devicesetChannelReportGet">devicesetChannelReportGet</a>
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<li data-group="DeviceSet" data-name="devicesetChannelSettingsGet" class="">
<a href="#api-DeviceSet-devicesetChannelSettingsGet">devicesetChannelSettingsGet</a>
</li>
<li data-group="DeviceSet" data-name="devicesetChannelSettingsPatch" class="">
<a href="#api-DeviceSet-devicesetChannelSettingsPatch">devicesetChannelSettingsPatch</a>
</li>
<li data-group="DeviceSet" data-name="devicesetChannelSettingsPut" class="">
<a href="#api-DeviceSet-devicesetChannelSettingsPut">devicesetChannelSettingsPut</a>
</li>
Web API: entry point to get all channel reports at once
2018-03-18 19:08:38 -04:00
<li data-group="DeviceSet" data-name="devicesetChannelsReportGet" class="">
<a href="#api-DeviceSet-devicesetChannelsReportGet">devicesetChannelsReportGet</a>
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="DeviceSet" data-name="devicesetDevicePut" class="">
<a href="#api-DeviceSet-devicesetDevicePut">devicesetDevicePut</a>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</li>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<li data-group="DeviceSet" data-name="devicesetDeviceRunDelete" class="">
<a href="#api-DeviceSet-devicesetDeviceRunDelete">devicesetDeviceRunDelete</a>
</li>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
<li data-group="DeviceSet" data-name="devicesetDeviceRunGet" class="">
<a href="#api-DeviceSet-devicesetDeviceRunGet">devicesetDeviceRunGet</a>
</li>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<li data-group="DeviceSet" data-name="devicesetDeviceRunPost" class="">
<a href="#api-DeviceSet-devicesetDeviceRunPost">devicesetDeviceRunPost</a>
</li>
<li data-group="DeviceSet" data-name="devicesetDeviceSettingsGet" class="">
<a href="#api-DeviceSet-devicesetDeviceSettingsGet">devicesetDeviceSettingsGet</a>
</li>
<li data-group="DeviceSet" data-name="devicesetDeviceSettingsPatch" class="">
<a href="#api-DeviceSet-devicesetDeviceSettingsPatch">devicesetDeviceSettingsPatch</a>
</li>
<li data-group="DeviceSet" data-name="devicesetDeviceSettingsPut" class="">
<a href="#api-DeviceSet-devicesetDeviceSettingsPut">devicesetDeviceSettingsPut</a>
</li>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
<li data-group="DeviceSet" data-name="devicesetFocusPatch" class="">
<a href="#api-DeviceSet-devicesetFocusPatch">devicesetFocusPatch</a>
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="DeviceSet" data-name="devicesetGet" class="">
<a href="#api-DeviceSet-devicesetGet">devicesetGet</a>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li data-group="DeviceSet" data-name="instanceDeviceSetDelete" class="">
<a href="#api-DeviceSet-instanceDeviceSetDelete">instanceDeviceSetDelete</a>
</li>
<li data-group="DeviceSet" data-name="instanceDeviceSetPost" class="">
<a href="#api-DeviceSet-instanceDeviceSetPost">instanceDeviceSetPost</a>
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="nav-header" data-group="Instance"><a href="#api-Instance">API Methods - Instance</a></li>
<li data-group="Instance" data-name="instanceAudioGet" class="">
<a href="#api-Instance-instanceAudioGet">instanceAudioGet</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceAudioPatch" class="">
<a href="#api-Instance-instanceAudioPatch">instanceAudioPatch</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceChannels" class="">
<a href="#api-Instance-instanceChannels">instanceChannels</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceDVSerialPatch" class="">
<a href="#api-Instance-instanceDVSerialPatch">instanceDVSerialPatch</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<li data-group="Instance" data-name="instanceDelete" class="">
<a href="#api-Instance-instanceDelete">instanceDelete</a>
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceDeviceSetsGet" class="">
<a href="#api-Instance-instanceDeviceSetsGet">instanceDeviceSetsGet</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceDevices" class="">
<a href="#api-Instance-instanceDevices">instanceDevices</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceLocationGet" class="">
<a href="#api-Instance-instanceLocationGet">instanceLocationGet</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceLocationPut" class="">
<a href="#api-Instance-instanceLocationPut">instanceLocationPut</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceLoggingGet" class="">
<a href="#api-Instance-instanceLoggingGet">instanceLoggingGet</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceLoggingPut" class="">
<a href="#api-Instance-instanceLoggingPut">instanceLoggingPut</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instancePresetDelete" class="">
<a href="#api-Instance-instancePresetDelete">instancePresetDelete</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
<li data-group="Instance" data-name="instancePresetFilePost" class="">
<a href="#api-Instance-instancePresetFilePost">instancePresetFilePost</a>
</li>
<li data-group="Instance" data-name="instancePresetFilePut" class="">
<a href="#api-Instance-instancePresetFilePut">instancePresetFilePut</a>
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instancePresetGet" class="">
<a href="#api-Instance-instancePresetGet">instancePresetGet</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instancePresetPatch" class="">
<a href="#api-Instance-instancePresetPatch">instancePresetPatch</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instancePresetPost" class="">
<a href="#api-Instance-instancePresetPost">instancePresetPost</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instancePresetPut" class="">
<a href="#api-Instance-instancePresetPut">instancePresetPut</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li data-group="Instance" data-name="instanceSummary" class="">
<a href="#api-Instance-instanceSummary">instanceSummary</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
</nav>
</div>
<div id="content">
<div id="project">
<div class="pull-left">
<h1>SDRangel</h1>
</div>
<div class="clearfix"></div>
</div>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
<div class="app-desc">Version: 4.0.0</div>
<hr>
Ewb API: updated swagger.yaml documentation
2017-12-15 13:10:45 -05:00
<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 />
Server: implemented add device set and remove last device set and associated web API entry points
2017-12-19 19:01:53 -05:00
<p>Limitations and specifcities:</p>
Ewb API: updated swagger.yaml documentation
2017-12-15 13:10:45 -05:00
<ul>
Server: implemented add device set and remove last device set and associated web API entry points
2017-12-19 19:01:53 -05:00
<li>In SDRangel GUI the first Rx device set cannot be deleted. Conversely the server starts with no device sets and its number of device sets can be reduced to zero by as many calls as necessary to /sdrangel/deviceset with DELETE method.</li>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<li>Stopping instance i.e. /sdrangel with DELETE method is a server only feature. It allows stopping the instance nicely.</li>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
<li>Preset import and export from/to file is a server only feature.</li>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
<li>Device set focus is a GUI only feature.</li>
Ewb API: updated swagger.yaml documentation
2017-12-15 13:10:45 -05:00
<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>
</ul>
</li>
</ul>
<hr />
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<div id="sections">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<section id="api-DeviceSet">
<h1>DeviceSet</h1>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<div id="api-DeviceSet-devicesetChannelDelete">
<article id="api-DeviceSet-devicesetChannelDelete-0" data-group="User" data-name="devicesetChannelDelete" data-version="0">
<div class="pull-left">
<h1>devicesetChannelDelete</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: updated documentation
2017-12-17 19:56:56 -05:00
<p class="marked">delete channel (server only)</p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelDelete-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelDelete-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelDelete-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}"</code></pre>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of channel in the channels list
try {
ChannelSettings result = apiInstance.devicesetChannelDelete(deviceSetIndex, channelIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelDelete");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of channel in the channels list
try {
ChannelSettings result = apiInstance.devicesetChannelDelete(deviceSetIndex, channelIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelDelete");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Integer *channelIndex = 56; // Index of channel in the channels list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelDeleteWith:deviceSetIndex
channelIndex:channelIndex
completionHandler: ^(ChannelSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var channelIndex = 56; // {Integer} Index of channel in the channels list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetChannelDelete(deviceSetIndex, channelIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelDeleteExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var channelIndex = 56; // Integer | Index of channel in the channels list
try
{
ChannelSettings result = apiInstance.devicesetChannelDelete(deviceSetIndex, channelIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelDelete: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$channelIndex = 56; // Integer | Index of channel in the channels list
try {
$result = $api_instance->devicesetChannelDelete($deviceSetIndex, $channelIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelDelete: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $channelIndex = 56; # Integer | Index of channel in the channels list
eval {
my $result = $api_instance->devicesetChannelDelete(deviceSetIndex => $deviceSetIndex, channelIndex => $channelIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelDelete: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelDelete-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
channelIndex = 56 # Integer | Index of channel in the channels list
try:
api_response = api_instance.deviceset_channel_delete(deviceSetIndex, channelIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelDelete: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelDelete_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
<tr><td style="width:150px;">channelIndex*</td>
<td>
<div id="d2e199_devicesetChannelDelete_channelIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of channel in the channels list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return deleted channel settings </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelDelete-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelDelete-200-schema">
<div id='responses-devicesetChannelDelete-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return deleted channel settings",
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelDelete-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelDelete-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelDelete-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set or channel index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelDelete-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelDelete-400-schema">
<div id='responses-devicesetChannelDelete-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set or channel index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelDelete-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelDelete-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelDelete-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device or channel not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelDelete-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelDelete-404-schema">
<div id='responses-devicesetChannelDelete-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device or channel not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelDelete-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelDelete-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelDelete-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelDelete-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelDelete-500-schema">
<div id='responses-devicesetChannelDelete-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelDelete-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelDelete-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelDelete-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelDelete-501-schema">Schema</a>
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetChannelDelete-501-schema">
<div id='responses-devicesetChannelDelete-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelDelete-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelDelete-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelDelete-501-schema-data' type='hidden' value=''></input>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetChannelPost">
<article id="api-DeviceSet-devicesetChannelPost-0" data-group="User" data-name="devicesetChannelPost" data-version="0">
<div class="pull-left">
<h1>devicesetChannelPost</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">add a channel</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channel</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelPost-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelPost-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelPost-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channel"</code></pre>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
ChannelSettings body = ; // ChannelSettings | Channel identification (no settings data)
try {
Web API: suppress waiting after asynchronous message posting and return 200 with a simple message
2017-12-19 11:55:05 -05:00
SuccessResponse result = apiInstance.devicesetChannelPost(deviceSetIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelPost");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
ChannelSettings body = ; // ChannelSettings | Channel identification (no settings data)
try {
Web API: suppress waiting after asynchronous message posting and return 200 with a simple message
2017-12-19 11:55:05 -05:00
SuccessResponse result = apiInstance.devicesetChannelPost(deviceSetIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelPost");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
ChannelSettings *body = ; // Channel identification (no settings data)
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelPostWith:deviceSetIndex
body:body
Web API: suppress waiting after asynchronous message posting and return 200 with a simple message
2017-12-19 11:55:05 -05:00
completionHandler: ^(SuccessResponse output, NSError* error) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var body = ; // {ChannelSettings} Channel identification (no settings data)
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetChannelPost(deviceSetIndex, body, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelPostExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var body = new ChannelSettings(); // ChannelSettings | Channel identification (no settings data)
try
{
Web API: suppress waiting after asynchronous message posting and return 200 with a simple message
2017-12-19 11:55:05 -05:00
SuccessResponse result = apiInstance.devicesetChannelPost(deviceSetIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelPost: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$body = ; // ChannelSettings | Channel identification (no settings data)
try {
$result = $api_instance->devicesetChannelPost($deviceSetIndex, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelPost: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $body = SWGSDRangel::Object::ChannelSettings->new(); # ChannelSettings | Channel identification (no settings data)
eval {
my $result = $api_instance->devicesetChannelPost(deviceSetIndex => $deviceSetIndex, body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelPost: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelPost-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
body = # ChannelSettings | Channel identification (no settings data)
try:
api_response = api_instance.deviceset_channel_post(deviceSetIndex, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelPost: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelPost_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Channel identification (no settings data)",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_devicesetChannelPost_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_devicesetChannelPost_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<h3> Status: 202 - Message to add a channel was sent successfully </h3>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<a data-toggle="tab" href="#responses-devicesetChannelPost-202-schema">Schema</a>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<div class="tab-pane active" id="responses-devicesetChannelPost-202-schema">
<div id='responses-devicesetChannelPost-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
"description" : "Message to add a channel was sent successfully",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: suppress waiting after asynchronous message posting and return 200 with a simple message
2017-12-19 11:55:05 -05:00
"$ref" : "#/definitions/SuccessResponse"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
$('#responses-devicesetChannelPost-202-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelPost-202-schema-202');
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<input id='responses-devicesetChannelPost-202-schema-data' type='hidden' value=''></input>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
</div>
<h3> Status: 400 - Invalid device set index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelPost-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelPost-400-schema">
<div id='responses-devicesetChannelPost-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelPost-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelPost-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelPost-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelPost-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelPost-404-schema">
<div id='responses-devicesetChannelPost-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelPost-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelPost-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelPost-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelPost-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelPost-500-schema">
<div id='responses-devicesetChannelPost-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelPost-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelPost-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelPost-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelPost-501-schema">Schema</a>
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetChannelPost-501-schema">
<div id='responses-devicesetChannelPost-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelPost-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelPost-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelPost-501-schema-data' type='hidden' value=''></input>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
</article>
</div>
<hr>
Web API: new entry point to get a channel report. Applied to NFM mod and demod
2018-03-18 15:17:11 -04:00
<div id="api-DeviceSet-devicesetChannelReportGet">
<article id="api-DeviceSet-devicesetChannelReportGet-0" data-group="User" data-name="devicesetChannelReportGet" data-version="0">
<div class="pull-left">
<h1>devicesetChannelReportGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">get a channel report</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/report</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelReportGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelReportGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelReportGet-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/report"</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try {
ChannelReport result = apiInstance.devicesetChannelReportGet(deviceSetIndex, channelIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelReportGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try {
ChannelReport result = apiInstance.devicesetChannelReportGet(deviceSetIndex, channelIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelReportGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Integer *channelIndex = 56; // Index of the channel in the channels list for this device set
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelReportGetWith:deviceSetIndex
channelIndex:channelIndex
completionHandler: ^(ChannelReport output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var channelIndex = 56; // {Integer} Index of the channel in the channels list for this device set
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetChannelReportGet(deviceSetIndex, channelIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelReportGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try
{
ChannelReport result = apiInstance.devicesetChannelReportGet(deviceSetIndex, channelIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelReportGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try {
$result = $api_instance->devicesetChannelReportGet($deviceSetIndex, $channelIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelReportGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $channelIndex = 56; # Integer | Index of the channel in the channels list for this device set
eval {
my $result = $api_instance->devicesetChannelReportGet(deviceSetIndex => $deviceSetIndex, channelIndex => $channelIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelReportGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelReportGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
channelIndex = 56 # Integer | Index of the channel in the channels list for this device set
try:
api_response = api_instance.deviceset_channel_report_get(deviceSetIndex, channelIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelReportGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelReportGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
<tr><td style="width:150px;">channelIndex*</td>
<td>
<div id="d2e199_devicesetChannelReportGet_channelIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of the channel in the channels list for this device set
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return channel report </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelReportGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelReportGet-200-schema">
<div id='responses-devicesetChannelReportGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "On success return channel report",
"schema" : {
"$ref" : "#/definitions/ChannelReport"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelReportGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelReportGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelReportGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set or channel index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelReportGet-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelReportGet-400-schema">
<div id='responses-devicesetChannelReportGet-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Invalid device set or channel index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelReportGet-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelReportGet-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelReportGet-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device or channel not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelReportGet-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelReportGet-404-schema">
<div id='responses-devicesetChannelReportGet-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Device or channel not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelReportGet-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelReportGet-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelReportGet-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelReportGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelReportGet-500-schema">
<div id='responses-devicesetChannelReportGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelReportGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelReportGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelReportGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelReportGet-501-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelReportGet-501-schema">
<div id='responses-devicesetChannelReportGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelReportGet-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelReportGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelReportGet-501-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<div id="api-DeviceSet-devicesetChannelSettingsGet">
<article id="api-DeviceSet-devicesetChannelSettingsGet-0" data-group="User" data-name="devicesetChannelSettingsGet" data-version="0">
<div class="pull-left">
<h1>devicesetChannelSettingsGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">get a channel settings</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelSettingsGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings"</code></pre>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try {
ChannelSettings result = apiInstance.devicesetChannelSettingsGet(deviceSetIndex, channelIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelSettingsGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try {
ChannelSettings result = apiInstance.devicesetChannelSettingsGet(deviceSetIndex, channelIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelSettingsGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Integer *channelIndex = 56; // Index of the channel in the channels list for this device set
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelSettingsGetWith:deviceSetIndex
channelIndex:channelIndex
completionHandler: ^(ChannelSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var channelIndex = 56; // {Integer} Index of the channel in the channels list for this device set
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetChannelSettingsGet(deviceSetIndex, channelIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelSettingsGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try
{
ChannelSettings result = apiInstance.devicesetChannelSettingsGet(deviceSetIndex, channelIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelSettingsGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
try {
$result = $api_instance->devicesetChannelSettingsGet($deviceSetIndex, $channelIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelSettingsGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $channelIndex = 56; # Integer | Index of the channel in the channels list for this device set
eval {
my $result = $api_instance->devicesetChannelSettingsGet(deviceSetIndex => $deviceSetIndex, channelIndex => $channelIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelSettingsGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
channelIndex = 56 # Integer | Index of the channel in the channels list for this device set
try:
api_response = api_instance.deviceset_channel_settings_get(deviceSetIndex, channelIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelSettingsGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelSettingsGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
<tr><td style="width:150px;">channelIndex*</td>
<td>
<div id="d2e199_devicesetChannelSettingsGet_channelIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of the channel in the channels list for this device set
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return channel settings </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsGet-200-schema">
<div id='responses-devicesetChannelSettingsGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return channel settings",
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set or channel index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsGet-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsGet-400-schema">
<div id='responses-devicesetChannelSettingsGet-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set or channel index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsGet-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsGet-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsGet-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device or channel not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsGet-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsGet-404-schema">
<div id='responses-devicesetChannelSettingsGet-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device or channel not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsGet-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsGet-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsGet-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsGet-500-schema">
<div id='responses-devicesetChannelSettingsGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsGet-501-schema">Schema</a>
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetChannelSettingsGet-501-schema">
<div id='responses-devicesetChannelSettingsGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsGet-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetChannelSettingsPatch">
<article id="api-DeviceSet-devicesetChannelSettingsPatch-0" data-group="User" data-name="devicesetChannelSettingsPatch" data-version="0">
<div class="pull-left">
<h1>devicesetChannelSettingsPatch</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">apply settings differentially (no force)</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPatch-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PATCH "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings"</code></pre>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings body = ; // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings result = apiInstance.devicesetChannelSettingsPatch(deviceSetIndex, channelIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelSettingsPatch");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings body = ; // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings result = apiInstance.devicesetChannelSettingsPatch(deviceSetIndex, channelIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelSettingsPatch");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Integer *channelIndex = 56; // Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings *body = ; // Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelSettingsPatchWith:deviceSetIndex
channelIndex:channelIndex
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
body:body
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
completionHandler: ^(ChannelSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var channelIndex = 56; // {Integer} Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
var body = ; // {ChannelSettings} Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
api.devicesetChannelSettingsPatch(deviceSetIndex, channelIndex, body, callback);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelSettingsPatchExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
var body = new ChannelSettings(); // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try
{
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings result = apiInstance.devicesetChannelSettingsPatch(deviceSetIndex, channelIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelSettingsPatch: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
$body = ; // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
$result = $api_instance->devicesetChannelSettingsPatch($deviceSetIndex, $channelIndex, $body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelSettingsPatch: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $channelIndex = 56; # Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
my $body = SWGSDRangel::Object::ChannelSettings->new(); # ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
eval {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
my $result = $api_instance->devicesetChannelSettingsPatch(deviceSetIndex => $deviceSetIndex, channelIndex => $channelIndex, body => $body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelSettingsPatch: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPatch-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
channelIndex = 56 # Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
body = # ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try:
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
api_response = api_instance.deviceset_channel_settings_patch(deviceSetIndex, channelIndex, body)
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelSettingsPatch: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelSettingsPatch_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
<tr><td style="width:150px;">channelIndex*</td>
<td>
<div id="d2e199_devicesetChannelSettingsPatch_channelIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of the channel in the channels list for this device set
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Channel settings to apply",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_devicesetChannelSettingsPatch_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_devicesetChannelSettingsPatch_body"></div>
</td>
</tr>
</table>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<h2>Responses</h2>
<h3> Status: 200 - On success return channel new settings </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPatch-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPatch-200-schema">
<div id='responses-devicesetChannelSettingsPatch-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return channel new settings",
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPatch-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPatch-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPatch-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set or channel index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPatch-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPatch-400-schema">
<div id='responses-devicesetChannelSettingsPatch-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set or channel index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPatch-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPatch-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPatch-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device or channel not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPatch-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPatch-404-schema">
<div id='responses-devicesetChannelSettingsPatch-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device or channel not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPatch-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPatch-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPatch-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPatch-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPatch-500-schema">
<div id='responses-devicesetChannelSettingsPatch-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPatch-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPatch-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPatch-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPatch-501-schema">Schema</a>
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetChannelSettingsPatch-501-schema">
<div id='responses-devicesetChannelSettingsPatch-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPatch-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPatch-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPatch-501-schema-data' type='hidden' value=''></input>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetChannelSettingsPut">
<article id="api-DeviceSet-devicesetChannelSettingsPut-0" data-group="User" data-name="devicesetChannelSettingsPut" data-version="0">
<div class="pull-left">
<h1>devicesetChannelSettingsPut</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">apply all settings unconditionally (force)</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelSettingsPut-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelSettingsPut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings"</code></pre>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings body = ; // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings result = apiInstance.devicesetChannelSettingsPut(deviceSetIndex, channelIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelSettingsPut");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Integer channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings body = ; // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings result = apiInstance.devicesetChannelSettingsPut(deviceSetIndex, channelIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelSettingsPut");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Integer *channelIndex = 56; // Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings *body = ; // Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelSettingsPutWith:deviceSetIndex
channelIndex:channelIndex
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
body:body
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
completionHandler: ^(ChannelSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var channelIndex = 56; // {Integer} Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
var body = ; // {ChannelSettings} Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
api.devicesetChannelSettingsPut(deviceSetIndex, channelIndex, body, callback);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelSettingsPutExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
var body = new ChannelSettings(); // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try
{
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
ChannelSettings result = apiInstance.devicesetChannelSettingsPut(deviceSetIndex, channelIndex, body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelSettingsPut: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$channelIndex = 56; // Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
$body = ; // ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
$result = $api_instance->devicesetChannelSettingsPut($deviceSetIndex, $channelIndex, $body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelSettingsPut: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $channelIndex = 56; # Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
my $body = SWGSDRangel::Object::ChannelSettings->new(); # ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
eval {
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
my $result = $api_instance->devicesetChannelSettingsPut(deviceSetIndex => $deviceSetIndex, channelIndex => $channelIndex, body => $body);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelSettingsPut: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelSettingsPut-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
channelIndex = 56 # Integer | Index of the channel in the channels list for this device set
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
body = # ChannelSettings | Channel settings to apply
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
try:
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
api_response = api_instance.deviceset_channel_settings_put(deviceSetIndex, channelIndex, body)
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelSettingsPut: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelSettingsPut_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
<tr><td style="width:150px;">channelIndex*</td>
<td>
<div id="d2e199_devicesetChannelSettingsPut_channelIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of the channel in the channels list for this device set
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
Web API: updated some descriptions. Documented JSON body in /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings PUT, PATCH
2017-12-28 16:46:01 -05:00
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Channel settings to apply",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_devicesetChannelSettingsPut_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_devicesetChannelSettingsPut_body"></div>
</td>
</tr>
</table>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
<h2>Responses</h2>
<h3> Status: 200 - On success return channel new settings </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPut-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPut-200-schema">
<div id='responses-devicesetChannelSettingsPut-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return channel new settings",
"schema" : {
"$ref" : "#/definitions/ChannelSettings"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPut-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPut-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPut-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set or channel index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPut-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPut-400-schema">
<div id='responses-devicesetChannelSettingsPut-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set or channel index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPut-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPut-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPut-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device or channel not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPut-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPut-404-schema">
<div id='responses-devicesetChannelSettingsPut-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device or channel not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPut-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPut-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPut-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPut-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelSettingsPut-500-schema">
<div id='responses-devicesetChannelSettingsPut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPut-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPut-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPut-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelSettingsPut-501-schema">Schema</a>
</li>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetChannelSettingsPut-501-schema">
<div id='responses-devicesetChannelSettingsPut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelSettingsPut-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelSettingsPut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelSettingsPut-501-schema-data' type='hidden' value=''></input>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings GET for NFM demod and mod
2017-12-10 14:27:08 -05:00
</div>
</article>
</div>
<hr>
Web API: entry point to get all channel reports at once
2018-03-18 19:08:38 -04:00
<div id="api-DeviceSet-devicesetChannelsReportGet">
<article id="api-DeviceSet-devicesetChannelsReportGet-0" data-group="User" data-name="devicesetChannelsReportGet" data-version="0">
<div class="pull-left">
<h1>devicesetChannelsReportGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">get channels report</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/channels/report</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetChannelsReportGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetChannelsReportGet-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/deviceset/{deviceSetIndex}/channels/report"</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
ChannelsDetail result = apiInstance.devicesetChannelsReportGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelsReportGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
ChannelsDetail result = apiInstance.devicesetChannelsReportGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetChannelsReportGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetChannelsReportGetWith:deviceSetIndex
completionHandler: ^(ChannelsDetail output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetChannelsReportGet(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetChannelsReportGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
ChannelsDetail result = apiInstance.devicesetChannelsReportGet(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetChannelsReportGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetChannelsReportGet($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetChannelsReportGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetChannelsReportGet(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetChannelsReportGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetChannelsReportGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_channels_report_get(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetChannelsReportGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetChannelsReportGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return channels report information </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelsReportGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelsReportGet-200-schema">
<div id='responses-devicesetChannelsReportGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "On success return channels report information",
"schema" : {
"$ref" : "#/definitions/ChannelsDetail"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelsReportGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelsReportGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelsReportGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelsReportGet-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelsReportGet-400-schema">
<div id='responses-devicesetChannelsReportGet-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Invalid device set index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelsReportGet-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelsReportGet-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelsReportGet-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelsReportGet-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelsReportGet-404-schema">
<div id='responses-devicesetChannelsReportGet-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelsReportGet-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelsReportGet-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelsReportGet-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelsReportGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelsReportGet-500-schema">
<div id='responses-devicesetChannelsReportGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelsReportGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelsReportGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelsReportGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetChannelsReportGet-501-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetChannelsReportGet-501-schema">
<div id='responses-devicesetChannelsReportGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetChannelsReportGet-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetChannelsReportGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetChannelsReportGet-501-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div id="api-DeviceSet-devicesetDevicePut">
<article id="api-DeviceSet-devicesetDevicePut-0" data-group="User" data-name="devicesetDevicePut" data-version="0">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<div class="pull-left">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<h1>devicesetDevicePut</h1>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<p class="marked">Set the device used in the device set</p>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<p></p>
<br />
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device</span></code></pre>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<li class="active"><a href="#examples-DeviceSet-devicesetDevicePut-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDevicePut-0-python">Python</a></li>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</ul>
<div class="tab-content">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane active" id="examples-DeviceSet-devicesetDevicePut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device"</code></pre>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-java">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
DeviceListItem body = ; // DeviceListItem | Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
try {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
DeviceListItem result = apiInstance.devicesetDevicePut(deviceSetIndex, body);
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
System.err.println("Exception when calling DeviceSetApi#devicesetDevicePut");
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-android">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
DeviceListItem body = ; // DeviceListItem | Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
try {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
DeviceListItem result = apiInstance.devicesetDevicePut(deviceSetIndex, body);
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
System.err.println("Exception when calling DeviceSetApi#devicesetDevicePut");
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-groovy">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-objc">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
DeviceListItem *body = ; // Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
[apiInstance devicesetDevicePutWith:deviceSetIndex
body:body
completionHandler: ^(DeviceListItem output, NSError* error) {
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-javascript">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
var body = ; // {DeviceListItem} Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
api.devicesetDevicePut(deviceSetIndex, body, callback);
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-angular">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-csharp">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
public class devicesetDevicePutExample
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
var body = new DeviceListItem(); // DeviceListItem | Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
try
{
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
DeviceListItem result = apiInstance.devicesetDevicePut(deviceSetIndex, body);
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
Debug.Print("Exception when calling DeviceSetApi.devicesetDevicePut: " + e.Message );
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
}
}
}
}
</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-php">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
$body = ; // DeviceListItem | Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
try {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$result = $api_instance->devicesetDevicePut($deviceSetIndex, $body);
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
print_r($result);
} catch (Exception $e) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
echo 'Exception when calling DeviceSetApi->devicesetDevicePut: ', $e->getMessage(), PHP_EOL;
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
}
?></code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-perl">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
my $body = SWGSDRangel::Object::DeviceListItem->new(); # DeviceListItem | Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
eval {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
my $result = $api_instance->devicesetDevicePut(deviceSetIndex => $deviceSetIndex, body => $body);
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
print Dumper($result);
};
if ($@) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
warn "Exception when calling DeviceSetApi->devicesetDevicePut: $@\n";
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
}</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDevicePut-0-python">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
body = # DeviceListItem | Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
try:
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
api_response = api_instance.deviceset_device_put(deviceSetIndex, body)
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
pprint(api_response)
except ApiException as e:
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
print("Exception when calling DeviceSetApi->devicesetDevicePut: %s\n" % e)</code></pre>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div id="d2e199_devicesetDevicePut_deviceSetIndex">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
Web API: /sdrangel/deviceset/{deviceSetIndex}/device PUT: let client specify only the necessary fields. Inernally set integer value default (-1) if not specified
2017-12-23 01:28:02 -05:00
"description" : "Device item to look for. Specify only the fields you want to search for. You must at least specify one among displayedName, hwType or serial. index and nbStreams are ignored. Rx is assumed if tx is not specified.",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"required" : true,
"schema" : {
"$ref" : "#/definitions/DeviceListItem"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_devicesetDevicePut_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_devicesetDevicePut_body"></div>
</td>
</tr>
</table>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<h2>Responses</h2>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<h3> Status: 202 - On successful semdomg of the message it returns the details of the device being set </h3>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<a data-toggle="tab" href="#responses-devicesetDevicePut-202-schema">Schema</a>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<div class="tab-pane active" id="responses-devicesetDevicePut-202-schema">
<div id='responses-devicesetDevicePut-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
"description" : "On successful semdomg of the message it returns the details of the device being set",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
"$ref" : "#/definitions/DeviceListItem"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
$('#responses-devicesetDevicePut-202-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDevicePut-202-schema-202');
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<input id='responses-devicesetDevicePut-202-schema-data' type='hidden' value=''></input>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
</div>
<h3> Status: 400 - Device set and device type mismatch (Rx vs Tx) </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDevicePut-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDevicePut-400-schema">
<div id='responses-devicesetDevicePut-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device set and device type mismatch (Rx vs Tx)",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDevicePut-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDevicePut-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDevicePut-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Invalid device set index or device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDevicePut-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDevicePut-404-schema">
<div id='responses-devicesetDevicePut-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index or device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$('#responses-devicesetDevicePut-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDevicePut-404-schema-404');
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<input id='responses-devicesetDevicePut-404-schema-data' type='hidden' value=''></input>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<a data-toggle="tab" href="#responses-devicesetDevicePut-500-schema">Schema</a>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane active" id="responses-devicesetDevicePut-500-schema">
<div id='responses-devicesetDevicePut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$('#responses-devicesetDevicePut-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDevicePut-500-schema-500');
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<input id='responses-devicesetDevicePut-500-schema-data' type='hidden' value=''></input>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDevicePut-501-schema">Schema</a>
</li>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDevicePut-501-schema">
<div id='responses-devicesetDevicePut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDevicePut-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDevicePut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDevicePut-501-schema-data' type='hidden' value=''></input>
</div>
Web API: added FileSource settings. Generated code and up to date documentation
2017-12-06 02:25:04 -05:00
</div>
</article>
</div>
<hr>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div id="api-DeviceSet-devicesetDeviceRunDelete">
<article id="api-DeviceSet-devicesetDeviceRunDelete-0" data-group="User" data-name="devicesetDeviceRunDelete" data-version="0">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<div class="pull-left">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<h1>devicesetDeviceRunDelete</h1>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<p class="marked">stop device</p>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<p></p>
<br />
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device/run</span></code></pre>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunDelete-0-python">Python</a></li>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</ul>
<div class="tab-content">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceRunDelete-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device/run"</code></pre>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class DeviceSetApiExample {
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
DeviceState result = apiInstance.devicesetDeviceRunDelete(deviceSetIndex);
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceRunDelete");
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-android">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class DeviceSetApiExample {
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
DeviceState result = apiInstance.devicesetDeviceRunDelete(deviceSetIndex);
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceRunDelete");
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-groovy">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-objc">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
[apiInstance devicesetDeviceRunDeleteWith:deviceSetIndex
completionHandler: ^(DeviceState output, NSError* error) {
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-javascript">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.DeviceSetApi()
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
api.devicesetDeviceRunDelete(deviceSetIndex, callback);
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-angular">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-csharp">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
namespace Example
{
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
public class devicesetDeviceRunDeleteExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceState result = apiInstance.devicesetDeviceRunDelete(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceRunDelete: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetDeviceRunDelete($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceRunDelete: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetDeviceRunDelete(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceRunDelete: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunDelete-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_device_run_delete(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceRunDelete: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceRunDelete_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/device/run POST,DELETE: return previous state instead of attempt to wait and return the state after change since it does not work reliably
2017-12-14 17:29:12 -05:00
<h3> Status: 200 - On success return state before change </h3>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunDelete-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunDelete-200-schema">
<div id='responses-devicesetDeviceRunDelete-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return state before change",
"schema" : {
"$ref" : "#/definitions/DeviceState"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunDelete-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunDelete-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunDelete-200-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
<h3> Status: 400 - Invalid device set index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunDelete-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunDelete-400-schema">
<div id='responses-devicesetDeviceRunDelete-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunDelete-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunDelete-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunDelete-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device not found </h3>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunDelete-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunDelete-404-schema">
<div id='responses-devicesetDeviceRunDelete-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunDelete-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunDelete-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunDelete-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunDelete-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunDelete-500-schema">
<div id='responses-devicesetDeviceRunDelete-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunDelete-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunDelete-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunDelete-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunDelete-501-schema">Schema</a>
</li>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceRunDelete-501-schema">
<div id='responses-devicesetDeviceRunDelete-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunDelete-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunDelete-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunDelete-501-schema-data' type='hidden' value=''></input>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
</article>
</div>
<hr>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
<div id="api-DeviceSet-devicesetDeviceRunGet">
<article id="api-DeviceSet-devicesetDeviceRunGet-0" data-group="User" data-name="devicesetDeviceRunGet" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceRunGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">get device rune status</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device/run</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceRunGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device/run"</code></pre>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceState result = apiInstance.devicesetDeviceRunGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceRunGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceState result = apiInstance.devicesetDeviceRunGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceRunGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceRunGetWith:deviceSetIndex
completionHandler: ^(DeviceState output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceRunGet(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceRunGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceState result = apiInstance.devicesetDeviceRunGet(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceRunGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetDeviceRunGet($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceRunGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetDeviceRunGet(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceRunGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_device_run_get(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceRunGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceRunGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return current state </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunGet-200-schema">
<div id='responses-devicesetDeviceRunGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return current state",
"schema" : {
"$ref" : "#/definitions/DeviceState"
}
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid device set index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunGet-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunGet-400-schema">
<div id='responses-devicesetDeviceRunGet-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunGet-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunGet-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunGet-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunGet-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunGet-404-schema">
<div id='responses-devicesetDeviceRunGet-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunGet-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunGet-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunGet-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunGet-500-schema">
<div id='responses-devicesetDeviceRunGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunGet-501-schema">Schema</a>
</li>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceRunGet-501-schema">
<div id='responses-devicesetDeviceRunGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunGet-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
</div>
</article>
</div>
<hr>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div id="api-DeviceSet-devicesetDeviceRunPost">
<article id="api-DeviceSet-devicesetDeviceRunPost-0" data-group="User" data-name="devicesetDeviceRunPost" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceRunPost</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">start device</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device/run</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceRunPost-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceRunPost-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device/run"</code></pre>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceState result = apiInstance.devicesetDeviceRunPost(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceRunPost");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceState result = apiInstance.devicesetDeviceRunPost(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceRunPost");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceRunPostWith:deviceSetIndex
completionHandler: ^(DeviceState output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceRunPost(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceRunPostExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceState result = apiInstance.devicesetDeviceRunPost(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceRunPost: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetDeviceRunPost($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceRunPost: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetDeviceRunPost(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceRunPost: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceRunPost-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_device_run_post(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceRunPost: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceRunPost_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/device/run POST,DELETE: return previous state instead of attempt to wait and return the state after change since it does not work reliably
2017-12-14 17:29:12 -05:00
<h3> Status: 200 - On success return state before change </h3>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunPost-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunPost-200-schema">
<div id='responses-devicesetDeviceRunPost-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return state before change",
"schema" : {
"$ref" : "#/definitions/DeviceState"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunPost-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunPost-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunPost-200-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
<h3> Status: 400 - Invalid device set index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunPost-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunPost-400-schema">
<div id='responses-devicesetDeviceRunPost-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: created run state getter. Implemented in RTLSDR
2017-12-09 04:49:20 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunPost-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunPost-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunPost-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Device not found </h3>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunPost-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunPost-404-schema">
<div id='responses-devicesetDeviceRunPost-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunPost-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunPost-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunPost-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunPost-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceRunPost-500-schema">
<div id='responses-devicesetDeviceRunPost-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunPost-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunPost-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunPost-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceRunPost-501-schema">Schema</a>
</li>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceRunPost-501-schema">
<div id='responses-devicesetDeviceRunPost-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceRunPost-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceRunPost-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceRunPost-501-schema-data' type='hidden' value=''></input>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetDeviceSettingsGet">
<article id="api-DeviceSet-devicesetDeviceSettingsGet-0" data-group="User" data-name="devicesetDeviceSettingsGet" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceSettingsGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get device settings</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device/settings</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsGet-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device/settings"</code></pre>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSettings result = apiInstance.devicesetDeviceSettingsGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceSettingsGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSettings result = apiInstance.devicesetDeviceSettingsGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceSettingsGet");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceSettingsGetWith:deviceSetIndex
completionHandler: ^(DeviceSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceSettingsGet(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceSettingsGetExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceSettings result = apiInstance.devicesetDeviceSettingsGet(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceSettingsGet: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetDeviceSettingsGet($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceSettingsGet: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetDeviceSettingsGet(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceSettingsGet: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsGet-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_device_settings_get(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceSettingsGet: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceSettingsGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success returns current settings values </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceSettingsGet-200-schema">
<div id='responses-devicesetDeviceSettingsGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success returns current settings values",
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Invalid device set index or device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsGet-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceSettingsGet-404-schema">
<div id='responses-devicesetDeviceSettingsGet-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index or device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsGet-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsGet-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsGet-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceSettingsGet-500-schema">
<div id='responses-devicesetDeviceSettingsGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsGet-501-schema">Schema</a>
</li>
</ul>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceSettingsGet-501-schema">
<div id='responses-devicesetDeviceSettingsGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsGet-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetDeviceSettingsPatch">
<article id="api-DeviceSet-devicesetDeviceSettingsPatch-0" data-group="User" data-name="devicesetDeviceSettingsPatch" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceSettingsPatch</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Apply settings differentially (no force)</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device/settings</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPatch-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PATCH "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device/settings"</code></pre>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
DeviceSettings body = ; // DeviceSettings | Device settings to apply
try {
DeviceSettings result = apiInstance.devicesetDeviceSettingsPatch(deviceSetIndex, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceSettingsPatch");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
DeviceSettings body = ; // DeviceSettings | Device settings to apply
try {
DeviceSettings result = apiInstance.devicesetDeviceSettingsPatch(deviceSetIndex, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceSettingsPatch");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSettings *body = ; // Device settings to apply
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceSettingsPatchWith:deviceSetIndex
body:body
completionHandler: ^(DeviceSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var body = ; // {DeviceSettings} Device settings to apply
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceSettingsPatch(deviceSetIndex, body, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceSettingsPatchExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
var body = new DeviceSettings(); // DeviceSettings | Device settings to apply
try
{
DeviceSettings result = apiInstance.devicesetDeviceSettingsPatch(deviceSetIndex, body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceSettingsPatch: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
$body = ; // DeviceSettings | Device settings to apply
try {
$result = $api_instance->devicesetDeviceSettingsPatch($deviceSetIndex, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetDeviceSettingsPatch: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
my $body = SWGSDRangel::Object::DeviceSettings->new(); # DeviceSettings | Device settings to apply
eval {
my $result = $api_instance->devicesetDeviceSettingsPatch(deviceSetIndex => $deviceSetIndex, body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetDeviceSettingsPatch: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPatch-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
body = # DeviceSettings | Device settings to apply
try:
api_response = api_instance.deviceset_device_settings_patch(deviceSetIndex, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetDeviceSettingsPatch: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetDeviceSettingsPatch_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Device settings to apply",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_devicesetDeviceSettingsPatch_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_devicesetDeviceSettingsPatch_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success returns new settings values </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPatch-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPatch-200-schema">
<div id='responses-devicesetDeviceSettingsPatch-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success returns new settings values",
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsPatch-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPatch-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsPatch-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Invalid device set index or device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPatch-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPatch-404-schema">
<div id='responses-devicesetDeviceSettingsPatch-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index or device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsPatch-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPatch-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsPatch-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPatch-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPatch-500-schema">
<div id='responses-devicesetDeviceSettingsPatch-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsPatch-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPatch-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsPatch-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPatch-501-schema">Schema</a>
</li>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPatch-501-schema">
<div id='responses-devicesetDeviceSettingsPatch-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsPatch-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPatch-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsPatch-501-schema-data' type='hidden' value=''></input>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
</article>
</div>
<hr>
<div id="api-DeviceSet-devicesetDeviceSettingsPut">
<article id="api-DeviceSet-devicesetDeviceSettingsPut-0" data-group="User" data-name="devicesetDeviceSettingsPut" data-version="0">
<div class="pull-left">
<h1>devicesetDeviceSettingsPut</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Apply all settings unconditionally (force)</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/device/settings</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetDeviceSettingsPut-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/deviceset/{deviceSetIndex}/device/settings"</code></pre>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
DeviceSettings body = ; // DeviceSettings | Device settings to apply
try {
DeviceSettings result = apiInstance.devicesetDeviceSettingsPut(deviceSetIndex, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceSettingsPut");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
DeviceSettings body = ; // DeviceSettings | Device settings to apply
try {
DeviceSettings result = apiInstance.devicesetDeviceSettingsPut(deviceSetIndex, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetDeviceSettingsPut");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSettings *body = ; // Device settings to apply
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetDeviceSettingsPutWith:deviceSetIndex
body:body
completionHandler: ^(DeviceSettings output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var body = ; // {DeviceSettings} Device settings to apply
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetDeviceSettingsPut(deviceSetIndex, body, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetDeviceSettingsPutExample
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
var body = new DeviceSettings(); // DeviceSettings | Device settings to apply
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
try
{
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
DeviceSettings result = apiInstance.devicesetDeviceSettingsPut(deviceSetIndex, body);
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
Debug.Print("Exception when calling DeviceSetApi.devicesetDeviceSettingsPut: " + e.Message );
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
}
}
}
}
</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-php">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$body = ; // DeviceSettings | Device settings to apply
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
try {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$result = $api_instance->devicesetDeviceSettingsPut($deviceSetIndex, $body);
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
print_r($result);
} catch (Exception $e) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
echo 'Exception when calling DeviceSetApi->devicesetDeviceSettingsPut: ', $e->getMessage(), PHP_EOL;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
}
?></code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-perl">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::DeviceSetApi->new();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
my $body = SWGSDRangel::Object::DeviceSettings->new(); # DeviceSettings | Device settings to apply
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
eval {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
my $result = $api_instance->devicesetDeviceSettingsPut(deviceSetIndex => $deviceSetIndex, body => $body);
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
print Dumper($result);
};
if ($@) {
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
warn "Exception when calling DeviceSetApi->devicesetDeviceSettingsPut: $@\n";
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
}</code></pre>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetDeviceSettingsPut-0-python">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.DeviceSetApi()
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
deviceSetIndex = 56 # Integer | Index of device set in the device set list
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
body = # DeviceSettings | Device settings to apply
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
try:
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
api_response = api_instance.deviceset_device_settings_put(deviceSetIndex, body)
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
pprint(api_response)
except ApiException as e:
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
print("Exception when calling DeviceSetApi->devicesetDeviceSettingsPut: %s\n" % e)</code></pre>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div id="d2e199_devicesetDeviceSettingsPut_deviceSetIndex">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Device settings to apply",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
var result = $('#d2e199_devicesetDeviceSettingsPut_body');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
result.empty();
result.append(view.render());
});
</script>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div id="d2e199_devicesetDeviceSettingsPut_body"></div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
</td>
</tr>
</table>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<h2>Responses</h2>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<h3> Status: 200 - On success returns new settings values </h3>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPut-200-schema">Schema</a>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPut-200-schema">
<div id='responses-devicesetDeviceSettingsPut-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success returns new settings values",
"schema" : {
"$ref" : "#/definitions/DeviceSettings"
}
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$('#responses-devicesetDeviceSettingsPut-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPut-200-schema-200');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<input id='responses-devicesetDeviceSettingsPut-200-schema-data' type='hidden' value=''></input>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
</div>
</div>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<h3> Status: 404 - Invalid device set index or device not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPut-404-schema">Schema</a>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPut-404-schema">
<div id='responses-devicesetDeviceSettingsPut-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid device set index or device not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$('#responses-devicesetDeviceSettingsPut-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPut-404-schema-404');
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<input id='responses-devicesetDeviceSettingsPut-404-schema-data' type='hidden' value=''></input>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPut-500-schema">Schema</a>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPut-500-schema">
<div id='responses-devicesetDeviceSettingsPut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
$('#responses-devicesetDeviceSettingsPut-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPut-500-schema-500');
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: Added settings getter for RTLSDR. Added more device URLs
2017-12-06 17:49:14 -05:00
<input id='responses-devicesetDeviceSettingsPut-500-schema-data' type='hidden' value=''></input>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetDeviceSettingsPut-501-schema">Schema</a>
</li>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetDeviceSettingsPut-501-schema">
<div id='responses-devicesetDeviceSettingsPut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetDeviceSettingsPut-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetDeviceSettingsPut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetDeviceSettingsPut-501-schema-data' type='hidden' value=''></input>
</div>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
</article>
</div>
<hr>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
<div id="api-DeviceSet-devicesetFocusPatch">
<article id="api-DeviceSet-devicesetFocusPatch-0" data-group="User" data-name="devicesetFocusPatch" data-version="0">
<div class="pull-left">
<h1>devicesetFocusPatch</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Set focus on device set (GUI only)</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}/focus</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-DeviceSet-devicesetFocusPatch-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetFocusPatch-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-DeviceSet-devicesetFocusPatch-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PATCH "http://localhost/sdrangel/deviceset/{deviceSetIndex}/focus"</code></pre>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
import java.io.File;
import java.util.*;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
SuccessResponse result = apiInstance.devicesetFocusPatch(deviceSetIndex);
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetFocusPatch");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
public class DeviceSetApiExample {
public static void main(String[] args) {
DeviceSetApi apiInstance = new DeviceSetApi();
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
SuccessResponse result = apiInstance.devicesetFocusPatch(deviceSetIndex);
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceSetApi#devicesetFocusPatch");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
[apiInstance devicesetFocusPatchWith:deviceSetIndex
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
completionHandler: ^(SuccessResponse output, NSError* error) {
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.DeviceSetApi()
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetFocusPatch(deviceSetIndex, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class devicesetFocusPatchExample
{
public void main()
{
var apiInstance = new DeviceSetApi();
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
SuccessResponse result = apiInstance.devicesetFocusPatch(deviceSetIndex);
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceSetApi.devicesetFocusPatch: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetFocusPatch($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceSetApi->devicesetFocusPatch: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetFocusPatch(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceSetApi->devicesetFocusPatch: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-DeviceSet-devicesetFocusPatch-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.DeviceSetApi()
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_focus_patch(deviceSetIndex)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceSetApi->devicesetFocusPatch: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetFocusPatch_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
<h3> Status: 202 - Message to focus on device set was sent successfully </h3>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
<a data-toggle="tab" href="#responses-devicesetFocusPatch-202-schema">Schema</a>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
<div class="tab-pane active" id="responses-devicesetFocusPatch-202-schema">
<div id='responses-devicesetFocusPatch-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
"description" : "Message to focus on device set was sent successfully",
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
"schema" : {
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
"$ref" : "#/definitions/SuccessResponse"
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
$('#responses-devicesetFocusPatch-202-schema-data').val(stringify(schema));
var result = $('#responses-devicesetFocusPatch-202-schema-202');
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: DeviceSetList: added focused device set index for the GUI
2018-01-06 03:50:09 -05:00
<input id='responses-devicesetFocusPatch-202-schema-data' type='hidden' value=''></input>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
</div>
</div>
<h3> Status: 400 - Unsupported (srver instance) </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetFocusPatch-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetFocusPatch-400-schema">
<div id='responses-devicesetFocusPatch-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Unsupported (srver instance)",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetFocusPatch-400-schema-data').val(stringify(schema));
var result = $('#responses-devicesetFocusPatch-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetFocusPatch-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Invalid index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetFocusPatch-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetFocusPatch-404-schema">
<div id='responses-devicesetFocusPatch-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Invalid index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetFocusPatch-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetFocusPatch-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetFocusPatch-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetFocusPatch-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetFocusPatch-500-schema">
<div id='responses-devicesetFocusPatch-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetFocusPatch-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetFocusPatch-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetFocusPatch-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetFocusPatch-501-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetFocusPatch-501-schema">
<div id='responses-devicesetFocusPatch-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetFocusPatch-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetFocusPatch-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetFocusPatch-501-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-DeviceSet-devicesetGet">
<article id="api-DeviceSet-devicesetGet-0" data-group="User" data-name="devicesetGet" data-version="0">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<div class="pull-left">
<h1>devicesetGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get device set information</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/deviceset/{deviceSetIndex}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-DeviceSet-devicesetGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-devicesetGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-devicesetGet-0-python">Python</a></li>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-DeviceSet-devicesetGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/deviceset/{deviceSetIndex}"</code></pre>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.DeviceSetApi;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class DeviceSetApiExample {
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSet result = apiInstance.devicesetGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling DeviceSetApi#devicesetGet");
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class DeviceSetApiExample {
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Integer deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
DeviceSet result = apiInstance.devicesetGet(deviceSetIndex);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling DeviceSetApi#devicesetGet");
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-groovy">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-objc">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-cpp">Integer *deviceSetIndex = 56; // Index of device set in the device set list
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
[apiInstance devicesetGetWith:deviceSetIndex
completionHandler: ^(DeviceSet output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-javascript">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.DeviceSetApi()
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
var deviceSetIndex = 56; // {Integer} Index of device set in the device set list
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.devicesetGet(deviceSetIndex, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-angular">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-csharp">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
namespace Example
{
public class devicesetGetExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
var deviceSetIndex = 56; // Integer | Index of device set in the device set list
try
{
DeviceSet result = apiInstance.devicesetGet(deviceSetIndex);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling DeviceSetApi.devicesetGet: " + e.Message );
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-php">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\DeviceSetApi();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
$deviceSetIndex = 56; // Integer | Index of device set in the device set list
try {
$result = $api_instance->devicesetGet($deviceSetIndex);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling DeviceSetApi->devicesetGet: ', $e->getMessage(), PHP_EOL;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-perl">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::DeviceSetApi;
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::DeviceSetApi->new();
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
my $deviceSetIndex = 56; # Integer | Index of device set in the device set list
eval {
my $result = $api_instance->devicesetGet(deviceSetIndex => $deviceSetIndex);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling DeviceSetApi->devicesetGet: $@\n";
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-DeviceSet-devicesetGet-0-python">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.DeviceSetApi()
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
deviceSetIndex = 56 # Integer | Index of device set in the device set list
try:
api_response = api_instance.deviceset_get(deviceSetIndex)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling DeviceSetApi->devicesetGet: %s\n" % e)</code></pre>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">deviceSetIndex*</td>
<td>
<div id="d2e199_devicesetGet_deviceSetIndex">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Index of device set in the device set list
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return details on the device set </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetGet-200-schema">
<div id='responses-devicesetGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return details on the device set",
"schema" : {
"$ref" : "#/definitions/DeviceSet"
}
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetGet-200-schema-data').val(stringify(schema));
var result = $('#responses-devicesetGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Invalid index </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetGet-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetGet-404-schema">
<div id='responses-devicesetGet-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid index",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetGet-404-schema-data').val(stringify(schema));
var result = $('#responses-devicesetGet-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetGet-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-devicesetGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-devicesetGet-500-schema">
<div id='responses-devicesetGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetGet-500-schema-data').val(stringify(schema));
var result = $('#responses-devicesetGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-devicesetGet-501-schema">Schema</a>
</li>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-devicesetGet-501-schema">
<div id='responses-devicesetGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-devicesetGet-501-schema-data').val(stringify(schema));
var result = $('#responses-devicesetGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-devicesetGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="api-DeviceSet-instanceDeviceSetDelete">
<article id="api-DeviceSet-instanceDeviceSetDelete-0" data-group="User" data-name="instanceDeviceSetDelete" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceDeviceSetDelete</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Remove last device set. The GUI version does not remove the first device.</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/sdrangel/deviceset</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetDelete-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-DeviceSet-instanceDeviceSetDelete-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/sdrangel/deviceset"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
import SWGSDRangel.api.DeviceSetApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class DeviceSetApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
SuccessResponse result = apiInstance.instanceDeviceSetDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling DeviceSetApi#instanceDeviceSetDelete");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class DeviceSetApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
SuccessResponse result = apiInstance.instanceDeviceSetDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling DeviceSetApi#instanceDeviceSetDelete");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceDeviceSetDeleteWithCompletionHandler:
^(SuccessResponse output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var api = new SdRangel.DeviceSetApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceDeviceSetDelete(callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceDeviceSetDeleteExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var apiInstance = new DeviceSetApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
SuccessResponse result = apiInstance.instanceDeviceSetDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling DeviceSetApi.instanceDeviceSetDelete: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$api_instance = new Swagger\Client\Api\DeviceSetApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceDeviceSetDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling DeviceSetApi->instanceDeviceSetDelete: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
use SWGSDRangel::DeviceSetApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $api_instance = SWGSDRangel::DeviceSetApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceDeviceSetDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling DeviceSetApi->instanceDeviceSetDelete: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetDelete-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_instance = swagger_sdrangel.DeviceSetApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_device_set_delete()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling DeviceSetApi->instanceDeviceSetDelete: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h3> Status: 202 - Message to remove last device set was sent successfully </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetDelete-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetDelete-202-schema">
<div id='responses-instanceDeviceSetDelete-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"description" : "Message to remove last device set was sent successfully",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/SuccessResponse"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDeviceSetDelete-202-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetDelete-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDeviceSetDelete-202-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - No more device sets to be deleted </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceDeviceSetDelete-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceDeviceSetDelete-404-schema">
<div id='responses-instanceDeviceSetDelete-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "No more device sets to be deleted",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceDeviceSetDelete-404-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetDelete-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceDeviceSetDelete-404-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetDelete-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetDelete-500-schema">
<div id='responses-instanceDeviceSetDelete-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDeviceSetDelete-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetDelete-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDeviceSetDelete-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetDelete-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetDelete-501-schema">
<div id='responses-instanceDeviceSetDelete-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDeviceSetDelete-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetDelete-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDeviceSetDelete-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="api-DeviceSet-instanceDeviceSetPost">
<article id="api-DeviceSet-instanceDeviceSetPost-0" data-group="User" data-name="instanceDeviceSetPost" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceDeviceSetPost</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Add (append) a new device set with default values</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/sdrangel/deviceset</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-DeviceSet-instanceDeviceSetPost-0-curl">Curl</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-java">Java</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-android">Android</a></li>
<!--<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-csharp">C#</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-php">PHP</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-perl">Perl</a></li>
<li class=""><a href="#examples-DeviceSet-instanceDeviceSetPost-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-DeviceSet-instanceDeviceSetPost-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/sdrangel/deviceset?tx="</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
import SWGSDRangel.api.DeviceSetApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class DeviceSetApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Integer tx = 56; // Integer | Set to non zero (true) for a Tx device set (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
SuccessResponse result = apiInstance.instanceDeviceSetPost(tx);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling DeviceSetApi#instanceDeviceSetPost");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.DeviceSetApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class DeviceSetApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DeviceSetApi apiInstance = new DeviceSetApi();
Integer tx = 56; // Integer | Set to non zero (true) for a Tx device set (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
SuccessResponse result = apiInstance.instanceDeviceSetPost(tx);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling DeviceSetApi#instanceDeviceSetPost");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *tx = 56; // Set to non zero (true) for a Tx device set (default Rx) (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DeviceSetApi *apiInstance = [[DeviceSetApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceDeviceSetPostWith:tx
completionHandler: ^(SuccessResponse output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var api = new SdRangel.DeviceSetApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var opts = {
'tx': 56 // {Integer} Set to non zero (true) for a Tx device set (default Rx)
};
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceDeviceSetPost(opts, callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceDeviceSetPostExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var apiInstance = new DeviceSetApi();
var tx = 56; // Integer | Set to non zero (true) for a Tx device set (default Rx) (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
SuccessResponse result = apiInstance.instanceDeviceSetPost(tx);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling DeviceSetApi.instanceDeviceSetPost: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$api_instance = new Swagger\Client\Api\DeviceSetApi();
$tx = 56; // Integer | Set to non zero (true) for a Tx device set (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceDeviceSetPost($tx);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling DeviceSetApi->instanceDeviceSetPost: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
use SWGSDRangel::DeviceSetApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $api_instance = SWGSDRangel::DeviceSetApi->new();
my $tx = 56; # Integer | Set to non zero (true) for a Tx device set (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceDeviceSetPost(tx => $tx);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling DeviceSetApi->instanceDeviceSetPost: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-DeviceSet-instanceDeviceSetPost-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_instance = swagger_sdrangel.DeviceSetApi()
tx = 56 # Integer | Set to non zero (true) for a Tx device set (default Rx) (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_device_set_post(tx=tx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling DeviceSetApi->instanceDeviceSetPost: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="methodsubtabletitle">Query parameters</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<tr><td style="width:150px;">tx</td>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<td>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="d2e199_instanceDeviceSetPost_tx">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="inner description">
Set to non zero (true) for a Tx device set (default Rx)
</div>
</div>
</div>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h3> Status: 202 - Message to add a new device set was sent successfully </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetPost-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetPost-202-schema">
<div id='responses-instanceDeviceSetPost-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"description" : "Message to add a new device set was sent successfully",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/SuccessResponse"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDeviceSetPost-202-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetPost-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDeviceSetPost-202-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetPost-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetPost-500-schema">
<div id='responses-instanceDeviceSetPost-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDeviceSetPost-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetPost-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDeviceSetPost-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetPost-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetPost-501-schema">
<div id='responses-instanceDeviceSetPost-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDeviceSetPost-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetPost-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDeviceSetPost-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
</section>
<section id="api-Instance">
<h1>Instance</h1>
<div id="api-Instance-instanceAudioGet">
<article id="api-Instance-instanceAudioGet-0" data-group="User" data-name="instanceAudioGet" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceAudioGet</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Get audio devices list available to this instance</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/audio</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-Instance-instanceAudioGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceAudioGet-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceAudioGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceAudioGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceAudioGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceAudioGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceAudioGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceAudioGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceAudioGet-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceAudioGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceAudioGet-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-Instance-instanceAudioGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/audio"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevices result = apiInstance.instanceAudioGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceAudioGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-android">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevices result = apiInstance.instanceAudioGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceAudioGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceAudioGetWithCompletionHandler:
^(AudioDevices output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceAudioGet(callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceAudioGetExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevices result = apiInstance.instanceAudioGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling InstanceApi.instanceAudioGet: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceAudioGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling InstanceApi->instanceAudioGet: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceAudioGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling InstanceApi->instanceAudioGet: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioGet-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_audio_get()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling InstanceApi->instanceAudioGet: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
<h3> Status: 200 - Success </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceAudioGet-200-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceAudioGet-200-schema">
<div id='responses-instanceAudioGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Success",
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/AudioDevices"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceAudioGet-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceAudioGet-200-schema-200');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceAudioGet-200-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceAudioGet-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceAudioGet-500-schema">
<div id='responses-instanceAudioGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceAudioGet-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceAudioGet-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceAudioGet-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceAudioGet-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceAudioGet-501-schema">
<div id='responses-instanceAudioGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceAudioGet-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceAudioGet-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceAudioGet-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="api-Instance-instanceAudioPatch">
<article id="api-Instance-instanceAudioPatch-0" data-group="User" data-name="instanceAudioPatch" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceAudioPatch</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Set audio devices</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/sdrangel/audio</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-Instance-instanceAudioPatch-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceAudioPatch-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceAudioPatch-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceAudioPatch-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-Instance-instanceAudioPatch-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PATCH "http://localhost/sdrangel/audio"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevicesSelect body = ; // AudioDevicesSelect | Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevicesSelect result = apiInstance.instanceAudioPatch(body);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceAudioPatch");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-android">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevicesSelect body = ; // AudioDevicesSelect | Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevicesSelect result = apiInstance.instanceAudioPatch(body);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceAudioPatch");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-objc">
<pre class="prettyprint"><code class="language-cpp">AudioDevicesSelect *body = ; // Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceAudioPatchWith:body
completionHandler: ^(AudioDevicesSelect output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var body = ; // {AudioDevicesSelect} Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceAudioPatch(body, callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceAudioPatchExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var body = new AudioDevicesSelect(); // AudioDevicesSelect | Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
AudioDevicesSelect result = apiInstance.instanceAudioPatch(body);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling InstanceApi.instanceAudioPatch: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$body = ; // AudioDevicesSelect | Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceAudioPatch($body);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling InstanceApi->instanceAudioPatch: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $body = SWGSDRangel::Object::AudioDevicesSelect->new(); # AudioDevicesSelect | Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceAudioPatch(body => $body);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling InstanceApi->instanceAudioPatch: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceAudioPatch-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
body = # AudioDevicesSelect | Select audio devices to use for this instance
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_audio_patch(body)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling InstanceApi->instanceAudioPatch: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="methodsubtabletitle">Body parameters</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<td>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Select audio devices to use for this instance",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AudioDevicesSelect"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instanceAudioPatch_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instanceAudioPatch_body"></div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</td>
</tr>
</table>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h3> Status: 200 - Success </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceAudioPatch-200-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceAudioPatch-200-schema">
<div id='responses-instanceAudioPatch-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"description" : "Success",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/AudioDevicesSelect"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceAudioPatch-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceAudioPatch-200-schema-200');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceAudioPatch-200-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceAudioPatch-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceAudioPatch-500-schema">
<div id='responses-instanceAudioPatch-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceAudioPatch-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceAudioPatch-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceAudioPatch-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceAudioPatch-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceAudioPatch-501-schema">
<div id='responses-instanceAudioPatch-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceAudioPatch-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceAudioPatch-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceAudioPatch-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="api-Instance-instanceChannels">
<article id="api-Instance-instanceChannels-0" data-group="User" data-name="instanceChannels" data-version="0">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceChannels</h1>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Get a list of channel plugins available in this instance</p>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/channels</span></code></pre>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-Instance-instanceChannels-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceChannels-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceChannels-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceChannels-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceChannels-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceChannels-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceChannels-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceChannels-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceChannels-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceChannels-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceChannels-0-python">Python</a></li>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-Instance-instanceChannels-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/channels?tx="</code></pre>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-java">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
import java.io.File;
import java.util.*;
public class InstanceApiExample {
public static void main(String[] args) {
InstanceApi apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Integer tx = 56; // Integer | Set to non zero (true) for Tx channels (default Rx)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
InstanceChannelsResponse result = apiInstance.instanceChannels(tx);
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceChannels");
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-android">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
public class InstanceApiExample {
public static void main(String[] args) {
InstanceApi apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Integer tx = 56; // Integer | Set to non zero (true) for Tx channels (default Rx)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
InstanceChannelsResponse result = apiInstance.instanceChannels(tx);
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceChannels");
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-groovy">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *tx = 56; // Set to non zero (true) for Tx channels (default Rx) (optional)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceChannelsWith:tx
completionHandler: ^(InstanceChannelsResponse output, NSError* error) {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-javascript">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.InstanceApi()
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var opts = {
'tx': 56 // {Integer} Set to non zero (true) for Tx channels (default Rx)
};
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceChannels(opts, callback);
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceChannels-0-angular">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-csharp">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceChannelsExample
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
{
public void main()
{
var apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var tx = 56; // Integer | Set to non zero (true) for Tx channels (default Rx) (optional)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
InstanceChannelsResponse result = apiInstance.instanceChannels(tx);
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling InstanceApi.instanceChannels: " + e.Message );
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-php">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$tx = 56; // Integer | Set to non zero (true) for Tx channels (default Rx)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceChannels($tx);
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling InstanceApi->instanceChannels: ', $e->getMessage(), PHP_EOL;
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-perl">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $tx = 56; # Integer | Set to non zero (true) for Tx channels (default Rx)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceChannels(tx => $tx);
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling InstanceApi->instanceChannels: $@\n";
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceChannels-0-python">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.InstanceApi()
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
tx = 56 # Integer | Set to non zero (true) for Tx channels (default Rx) (optional)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_channels(tx=tx)
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling InstanceApi->instanceChannels: %s\n" % e)</code></pre>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</div>
</div>
<h2>Parameters</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">tx</td>
<td>
<div id="d2e199_instanceChannels_tx">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
<div class="inner description">
Set to non zero (true) for Tx channels (default Rx)
</div>
</div>
</div>
</div>
</td>
</tr>
</table>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h3> Status: 200 - Success </h3>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceChannels-200-schema">Schema</a>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceChannels-200-schema">
<div id='responses-instanceChannels-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"description" : "Success",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/InstanceChannelsResponse"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceChannels-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceChannels-200-schema-200');
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceChannels-200-schema-data' type='hidden' value=''></input>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceChannels-500-schema">Schema</a>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceChannels-500-schema">
<div id='responses-instanceChannels-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceChannels-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceChannels-500-schema-500');
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceChannels-500-schema-data' type='hidden' value=''></input>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceChannels-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceChannels-501-schema">
<div id='responses-instanceChannels-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceChannels-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceChannels-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceChannels-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="api-Instance-instanceDVSerialPatch">
<article id="api-Instance-instanceDVSerialPatch-0" data-group="User" data-name="instanceDVSerialPatch" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceDVSerialPatch</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Set or reset DV serial processing for AMBE frames decoding in digital voice modes</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/sdrangel/dvserial</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-Instance-instanceDVSerialPatch-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceDVSerialPatch-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-Instance-instanceDVSerialPatch-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PATCH "http://localhost/sdrangel/dvserial?dvserial="</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Integer dvserial = 56; // Integer | Set to non zero (true) to set DV serial processing
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DVSeralDevices result = apiInstance.instanceDVSerialPatch(dvserial);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceDVSerialPatch");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-android">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Integer dvserial = 56; // Integer | Set to non zero (true) to set DV serial processing
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DVSeralDevices result = apiInstance.instanceDVSerialPatch(dvserial);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceDVSerialPatch");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-objc">
<pre class="prettyprint"><code class="language-cpp">Integer *dvserial = 56; // Set to non zero (true) to set DV serial processing (optional)
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceDVSerialPatchWith:dvserial
completionHandler: ^(DVSeralDevices output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var opts = {
'dvserial': 56 // {Integer} Set to non zero (true) to set DV serial processing
};
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceDVSerialPatch(opts, callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceDVSerialPatchExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
var dvserial = 56; // Integer | Set to non zero (true) to set DV serial processing (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
DVSeralDevices result = apiInstance.instanceDVSerialPatch(dvserial);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling InstanceApi.instanceDVSerialPatch: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$dvserial = 56; // Integer | Set to non zero (true) to set DV serial processing
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceDVSerialPatch($dvserial);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling InstanceApi->instanceDVSerialPatch: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $dvserial = 56; # Integer | Set to non zero (true) to set DV serial processing
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceDVSerialPatch(dvserial => $dvserial);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling InstanceApi->instanceDVSerialPatch: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDVSerialPatch-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
dvserial = 56 # Integer | Set to non zero (true) to set DV serial processing (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_dv_serial_patch(dvserial=dvserial)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling InstanceApi->instanceDVSerialPatch: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">dvserial</td>
<td>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="d2e199_instanceDVSerialPatch_dvserial">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Integer
</span>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="inner description">
Set to non zero (true) to set DV serial processing
</div>
</div>
</div>
</div>
</td>
</tr>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
</table>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h2>Responses</h2>
<h3> Status: 200 - On success return list of devices or empty list if unset </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDVSerialPatch-200-schema">Schema</a>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDVSerialPatch-200-schema">
<div id='responses-instanceDVSerialPatch-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"description" : "On success return list of devices or empty list if unset",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/DVSeralDevices"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDVSerialPatch-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceDVSerialPatch-200-schema-200');
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDVSerialPatch-200-schema-data' type='hidden' value=''></input>
Web API: Swagger definitions of deviceset GET and deviceset/device PUT
2017-11-25 18:26:56 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDVSerialPatch-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDVSerialPatch-500-schema">
<div id='responses-instanceDVSerialPatch-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDVSerialPatch-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceDVSerialPatch-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDVSerialPatch-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDVSerialPatch-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDVSerialPatch-501-schema">
<div id='responses-instanceDVSerialPatch-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDVSerialPatch-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceDVSerialPatch-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDVSerialPatch-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div id="api-Instance-instanceDelete">
<article id="api-Instance-instanceDelete-0" data-group="User" data-name="instanceDelete" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h1>instanceDelete</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<p class="marked">Stop SDRangel instance (server only)</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/sdrangel</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<li class="active"><a href="#examples-Instance-instanceDelete-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceDelete-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceDelete-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDelete-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceDelete-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceDelete-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDelete-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceDelete-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceDelete-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceDelete-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceDelete-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="examples-Instance-instanceDelete-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/sdrangel"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
InstanceSummaryResponse result = apiInstance.instanceDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceDelete");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-android">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
InstanceSummaryResponse result = apiInstance.instanceDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
System.err.println("Exception when calling InstanceApi#instanceDelete");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-objc">
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
[apiInstance instanceDeleteWithCompletionHandler:
^(InstanceSummaryResponse output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api.instanceDelete(callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceDelete-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
public class instanceDeleteExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
InstanceSummaryResponse result = apiInstance.instanceDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
Debug.Print("Exception when calling InstanceApi.instanceDelete: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$result = $api_instance->instanceDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
echo 'Exception when calling InstanceApi->instanceDelete: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
my $result = $api_instance->instanceDelete();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
warn "Exception when calling InstanceApi->instanceDelete: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane" id="examples-Instance-instanceDelete-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
api_response = api_instance.instance_delete()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
print("Exception when calling InstanceApi->instanceDelete: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<h3> Status: 202 - Message to stop the SDRangel instance was sent successfully </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDelete-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDelete-202-schema">
<div id='responses-instanceDelete-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"description" : "Message to stop the SDRangel instance was sent successfully",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
"$ref" : "#/definitions/InstanceSummaryResponse"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDelete-202-schema-data').val(stringify(schema));
var result = $('#responses-instanceDelete-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDelete-202-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: implemented /sdrangel/deviceset/{deviceSetIndex}/focus PATCH
2018-01-05 21:46:53 -05:00
<h3> Status: 400 - Unsupported (GUI instance) </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceDelete-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceDelete-400-schema">
<div id='responses-instanceDelete-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Unsupported (GUI instance)",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceDelete-400-schema-data').val(stringify(schema));
var result = $('#responses-instanceDelete-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceDelete-400-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDelete-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDelete-500-schema">
<div id='responses-instanceDelete-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDelete-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceDelete-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDelete-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<a data-toggle="tab" href="#responses-instanceDelete-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<div class="tab-pane active" id="responses-instanceDelete-501-schema">
<div id='responses-instanceDelete-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
$('#responses-instanceDelete-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceDelete-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex} DELETE implemented in GUI also
2017-12-23 17:41:37 -05:00
<input id='responses-instanceDelete-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div id="api-Instance-instanceDeviceSetsGet">
<article id="api-Instance-instanceDeviceSetsGet-0" data-group="User" data-name="instanceDeviceSetsGet" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<h1>instanceDeviceSetsGet</h1>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<p class="marked">Get summary information about device sets opened in the instance</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/devicesets</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<li class="active"><a href="#examples-Instance-instanceDeviceSetsGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceDeviceSetsGet-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane active" id="examples-Instance-instanceDeviceSetsGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/devicesets"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-java">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
DeviceSetList result = apiInstance.instanceDeviceSetsGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
System.err.println("Exception when calling InstanceApi#instanceDeviceSetsGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-android">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
DeviceSetList result = apiInstance.instanceDeviceSetsGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
System.out.println(result);
} catch (ApiException e) {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
System.err.println("Exception when calling InstanceApi#instanceDeviceSetsGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-objc">
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
[apiInstance instanceDeviceSetsGetWithCompletionHandler:
^(DeviceSetList output, NSError* error) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
api.instanceDeviceSetsGet(callback);
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</code></pre>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
public class instanceDeviceSetsGetExample
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
DeviceSetList result = apiInstance.instanceDeviceSetsGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
Debug.Print("Exception when calling InstanceApi.instanceDeviceSetsGet: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
$result = $api_instance->instanceDeviceSetsGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print_r($result);
} catch (Exception $e) {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
echo 'Exception when calling InstanceApi->instanceDeviceSetsGet: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
my $result = $api_instance->instanceDeviceSetsGet();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
print Dumper($result);
};
if ($@) {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
warn "Exception when calling InstanceApi->instanceDeviceSetsGet: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane" id="examples-Instance-instanceDeviceSetsGet-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
api_response = api_instance.instance_device_sets_get()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
pprint(api_response)
except ApiException as e:
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
print("Exception when calling InstanceApi->instanceDeviceSetsGet: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<h3> Status: 200 - On success return device set list </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetsGet-200-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetsGet-200-schema">
<div id='responses-instanceDeviceSetsGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
"description" : "On success return device set list",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
"$ref" : "#/definitions/DeviceSetList"
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
$('#responses-instanceDeviceSetsGet-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetsGet-200-schema-200');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<input id='responses-instanceDeviceSetsGet-200-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetsGet-500-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetsGet-500-schema">
<div id='responses-instanceDeviceSetsGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
$('#responses-instanceDeviceSetsGet-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetsGet-500-schema-500');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<input id='responses-instanceDeviceSetsGet-500-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<a data-toggle="tab" href="#responses-instanceDeviceSetsGet-501-schema">Schema</a>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<div class="tab-pane active" id="responses-instanceDeviceSetsGet-501-schema">
<div id='responses-instanceDeviceSetsGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
$('#responses-instanceDeviceSetsGet-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceDeviceSetsGet-501-schema-501');
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: changed /sdrangel/devicesets POST,DELETE to /sdrangel/deviceset to reflect that it applies to a single device set
2017-12-21 19:07:03 -05:00
<input id='responses-instanceDeviceSetsGet-501-schema-data' type='hidden' value=''></input>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instanceDevices">
<article id="api-Instance-instanceDevices-0" data-group="User" data-name="instanceDevices" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instanceDevices</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get a list of sampling devices that can be used to take part in a device set</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/devices</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instanceDevices-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceDevices-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceDevices-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDevices-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceDevices-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceDevices-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceDevices-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceDevices-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceDevices-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceDevices-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceDevices-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instanceDevices-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/devices?tx="</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
Integer tx = 56; // Integer | Set to non zero (true) for Tx direction (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
InstanceDevicesResponse result = apiInstance.instanceDevices(tx);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceDevices");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
Integer tx = 56; // Integer | Set to non zero (true) for Tx direction (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
InstanceDevicesResponse result = apiInstance.instanceDevices(tx);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceDevices");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-objc">
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
<pre class="prettyprint"><code class="language-cpp">Integer *tx = 56; // Set to non zero (true) for Tx direction (default Rx) (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instanceDevicesWith:tx
completionHandler: ^(InstanceDevicesResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var opts = {
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
'tx': 56 // {Integer} Set to non zero (true) for Tx direction (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instanceDevices(opts, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceDevices-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instanceDevicesExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
var tx = 56; // Integer | Set to non zero (true) for Tx direction (default Rx) (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
InstanceDevicesResponse result = apiInstance.instanceDevices(tx);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instanceDevices: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
$tx = 56; // Integer | Set to non zero (true) for Tx direction (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
$result = $api_instance->instanceDevices($tx);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instanceDevices: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
my $tx = 56; # Integer | Set to non zero (true) for Tx direction (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instanceDevices(tx => $tx);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instanceDevices: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceDevices-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
tx = 56 # Integer | Set to non zero (true) for Tx direction (default Rx) (optional)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
api_response = api_instance.instance_devices(tx=tx)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instanceDevices: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">tx</td>
<td>
<div id="d2e199_instanceDevices_tx">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
Integer
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</span>
<div class="inner description">
Web API: change all boolean parameters to integer
2017-11-23 18:55:47 -05:00
Set to non zero (true) for Tx direction (default Rx)
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
</div>
</div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - Success </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceDevices-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceDevices-200-schema">
<div id='responses-instanceDevices-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Success",
"schema" : {
"$ref" : "#/definitions/InstanceDevicesResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceDevices-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceDevices-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceDevices-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceDevices-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceDevices-500-schema">
<div id='responses-instanceDevices-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceDevices-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceDevices-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceDevices-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceDevices-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instanceDevices-501-schema">
<div id='responses-instanceDevices-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceDevices-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceDevices-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceDevices-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instanceLocationGet">
<article id="api-Instance-instanceLocationGet-0" data-group="User" data-name="instanceLocationGet" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instanceLocationGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get instance geolocation information</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/location</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instanceLocationGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceLocationGet-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceLocationGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLocationGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceLocationGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceLocationGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLocationGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceLocationGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceLocationGet-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceLocationGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceLocationGet-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instanceLocationGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/location"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
LocationInformation result = apiInstance.instanceLocationGet();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLocationGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
LocationInformation result = apiInstance.instanceLocationGet();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLocationGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instanceLocationGetWithCompletionHandler:
^(LocationInformation output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instanceLocationGet(callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instanceLocationGetExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
LocationInformation result = apiInstance.instanceLocationGet();
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instanceLocationGet: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
$result = $api_instance->instanceLocationGet();
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instanceLocationGet: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instanceLocationGet();
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instanceLocationGet: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationGet-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
api_response = api_instance.instance_location_get()
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instanceLocationGet: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
<h3> Status: 200 - On success return location </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLocationGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLocationGet-200-schema">
<div id='responses-instanceLocationGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return location",
"schema" : {
"$ref" : "#/definitions/LocationInformation"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLocationGet-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceLocationGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLocationGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLocationGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLocationGet-500-schema">
<div id='responses-instanceLocationGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLocationGet-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceLocationGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLocationGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceLocationGet-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instanceLocationGet-501-schema">
<div id='responses-instanceLocationGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLocationGet-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceLocationGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLocationGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instanceLocationPut">
<article id="api-Instance-instanceLocationPut-0" data-group="User" data-name="instanceLocationPut" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instanceLocationPut</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Set instance geolocation information</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/location</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instanceLocationPut-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceLocationPut-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceLocationPut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLocationPut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceLocationPut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceLocationPut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLocationPut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceLocationPut-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceLocationPut-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceLocationPut-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceLocationPut-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instanceLocationPut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/location"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
LocationInformation body = ; // LocationInformation | Location of instance in latitude and longitude
try {
LocationInformation result = apiInstance.instanceLocationPut(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLocationPut");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
LocationInformation body = ; // LocationInformation | Location of instance in latitude and longitude
try {
LocationInformation result = apiInstance.instanceLocationPut(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLocationPut");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">LocationInformation *body = ; // Location of instance in latitude and longitude
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instanceLocationPutWith:body
completionHandler: ^(LocationInformation output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = ; // {LocationInformation} Location of instance in latitude and longitude
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instanceLocationPut(body, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instanceLocationPutExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = new LocationInformation(); // LocationInformation | Location of instance in latitude and longitude
try
{
LocationInformation result = apiInstance.instanceLocationPut(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instanceLocationPut: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
$body = ; // LocationInformation | Location of instance in latitude and longitude
try {
$result = $api_instance->instanceLocationPut($body);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instanceLocationPut: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::LocationInformation->new(); # LocationInformation | Location of instance in latitude and longitude
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instanceLocationPut(body => $body);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instanceLocationPut: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLocationPut-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
body = # LocationInformation | Location of instance in latitude and longitude
try:
api_response = api_instance.instance_location_put(body)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instanceLocationPut: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Location of instance in latitude and longitude",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LocationInformation"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instanceLocationPut_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instanceLocationPut_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return location </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLocationPut-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLocationPut-200-schema">
<div id='responses-instanceLocationPut-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return location",
"schema" : {
"$ref" : "#/definitions/LocationInformation"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLocationPut-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceLocationPut-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLocationPut-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Location invalid </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLocationPut-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLocationPut-500-schema">
<div id='responses-instanceLocationPut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLocationPut-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceLocationPut-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLocationPut-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceLocationPut-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instanceLocationPut-501-schema">
<div id='responses-instanceLocationPut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLocationPut-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceLocationPut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLocationPut-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instanceLoggingGet">
<article id="api-Instance-instanceLoggingGet-0" data-group="User" data-name="instanceLoggingGet" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instanceLoggingGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Get logging information for this instance</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/logging</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instanceLoggingGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLoggingGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLoggingGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingGet-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instanceLoggingGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/logging"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
LoggingInfo result = apiInstance.instanceLoggingGet();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLoggingGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
LoggingInfo result = apiInstance.instanceLoggingGet();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLoggingGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instanceLoggingGetWithCompletionHandler:
^(LoggingInfo output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instanceLoggingGet(callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instanceLoggingGetExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
LoggingInfo result = apiInstance.instanceLoggingGet();
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instanceLoggingGet: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
$result = $api_instance->instanceLoggingGet();
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instanceLoggingGet: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instanceLoggingGet();
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instanceLoggingGet: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingGet-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
api_response = api_instance.instance_logging_get()
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instanceLoggingGet: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
<h3> Status: 200 - Success </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLoggingGet-200-schema">
<div id='responses-instanceLoggingGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Success",
"schema" : {
"$ref" : "#/definitions/LoggingInfo"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingGet-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLoggingGet-500-schema">
<div id='responses-instanceLoggingGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingGet-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingGet-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instanceLoggingGet-501-schema">
<div id='responses-instanceLoggingGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingGet-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instanceLoggingPut">
<article id="api-Instance-instanceLoggingPut-0" data-group="User" data-name="instanceLoggingPut" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instanceLoggingPut</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Change logging parmeters for this instance</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/logging</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instanceLoggingPut-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLoggingPut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceLoggingPut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceLoggingPut-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instanceLoggingPut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/logging"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
LoggingInfo body = ; // LoggingInfo | Logging information
try {
LoggingInfo result = apiInstance.instanceLoggingPut(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLoggingPut");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
LoggingInfo body = ; // LoggingInfo | Logging information
try {
LoggingInfo result = apiInstance.instanceLoggingPut(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceLoggingPut");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">LoggingInfo *body = ; // Logging information
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instanceLoggingPutWith:body
completionHandler: ^(LoggingInfo output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = ; // {LoggingInfo} Logging information
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instanceLoggingPut(body, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instanceLoggingPutExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = new LoggingInfo(); // LoggingInfo | Logging information
try
{
LoggingInfo result = apiInstance.instanceLoggingPut(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instanceLoggingPut: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
$body = ; // LoggingInfo | Logging information
try {
$result = $api_instance->instanceLoggingPut($body);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instanceLoggingPut: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::LoggingInfo->new(); # LoggingInfo | Logging information
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instanceLoggingPut(body => $body);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instanceLoggingPut: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceLoggingPut-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
body = # LoggingInfo | Logging information
try:
api_response = api_instance.instance_logging_put(body)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instanceLoggingPut: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Logging information",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LoggingInfo"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instanceLoggingPut_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instanceLoggingPut_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - Return new data on success </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingPut-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLoggingPut-200-schema">
<div id='responses-instanceLoggingPut-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Return new data on success",
"schema" : {
"$ref" : "#/definitions/LoggingInfo"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingPut-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingPut-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingPut-200-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<h3> Status: 400 - Invalid data </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: /sdrangel/logging implementation (2)
2017-11-23 18:47:42 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingPut-400-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/logging implementation (2)
2017-11-23 18:47:42 -05:00
<div class="tab-pane active" id="responses-instanceLoggingPut-400-schema">
<div id='responses-instanceLoggingPut-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid data",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/logging implementation (2)
2017-11-23 18:47:42 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingPut-400-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingPut-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingPut-400-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingPut-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceLoggingPut-500-schema">
<div id='responses-instanceLoggingPut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingPut-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingPut-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingPut-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceLoggingPut-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instanceLoggingPut-501-schema">
<div id='responses-instanceLoggingPut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceLoggingPut-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceLoggingPut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceLoggingPut-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instancePresetDelete">
<article id="api-Instance-instancePresetDelete-0" data-group="User" data-name="instancePresetDelete" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instancePresetDelete</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Deletes a preset</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/sdrangel/preset</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instancePresetDelete-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetDelete-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetDelete-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetDelete-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetDelete-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetDelete-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetDelete-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetDelete-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetDelete-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetDelete-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetDelete-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instancePresetDelete-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/sdrangel/preset"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetIdentifier body = ; // PresetIdentifier | delete this preset
try {
PresetIdentifier result = apiInstance.instancePresetDelete(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetDelete");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetIdentifier body = ; // PresetIdentifier | delete this preset
try {
PresetIdentifier result = apiInstance.instancePresetDelete(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetDelete");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">PresetIdentifier *body = ; // delete this preset
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instancePresetDeleteWith:body
completionHandler: ^(PresetIdentifier output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = ; // {PresetIdentifier} delete this preset
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetDelete(body, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instancePresetDeleteExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = new PresetIdentifier(); // PresetIdentifier | delete this preset
try
{
PresetIdentifier result = apiInstance.instancePresetDelete(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instancePresetDelete: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
$body = ; // PresetIdentifier | delete this preset
try {
$result = $api_instance->instancePresetDelete($body);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instancePresetDelete: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::PresetIdentifier->new(); # PresetIdentifier | delete this preset
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instancePresetDelete(body => $body);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instancePresetDelete: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetDelete-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
body = # PresetIdentifier | delete this preset
try:
api_response = api_instance.instance_preset_delete(body)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instancePresetDelete: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "delete this preset",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instancePresetDelete_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instancePresetDelete_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<h3> Status: 202 - On successful sending of the message the selected preset identification is returned </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<a data-toggle="tab" href="#responses-instancePresetDelete-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<div class="tab-pane active" id="responses-instancePresetDelete-202-schema">
<div id='responses-instancePresetDelete-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
"description" : "On successful sending of the message the selected preset identification is returned",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
$('#responses-instancePresetDelete-202-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetDelete-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<input id='responses-instancePresetDelete-202-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<h3> Status: 400 - Invalid JSON request </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetDelete-400-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<div class="tab-pane active" id="responses-instancePresetDelete-400-schema">
<div id='responses-instancePresetDelete-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid JSON request",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetDelete-400-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetDelete-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetDelete-400-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
<h3> Status: 404 - Preset not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetDelete-404-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<div class="tab-pane active" id="responses-instancePresetDelete-404-schema">
<div id='responses-instancePresetDelete-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Preset not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetDelete-404-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetDelete-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetDelete-404-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetDelete-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetDelete-500-schema">
<div id='responses-instancePresetDelete-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetDelete-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetDelete-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetDelete-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetDelete-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetDelete-501-schema">
<div id='responses-instancePresetDelete-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetDelete-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetDelete-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetDelete-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
<div id="api-Instance-instancePresetFilePost">
<article id="api-Instance-instancePresetFilePost-0" data-group="User" data-name="instancePresetFilePost" data-version="0">
<div class="pull-left">
<h1>instancePresetFilePost</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">export a preset to file (server only).</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/sdrangel/preset/file</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-Instance-instancePresetFilePost-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetFilePost-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetFilePost-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePost-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-Instance-instancePresetFilePost-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/sdrangel/preset/file"</code></pre>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
import java.io.File;
import java.util.*;
public class InstanceApiExample {
public static void main(String[] args) {
InstanceApi apiInstance = new InstanceApi();
PresetExport body = ; // PresetExport | export details
try {
PresetIdentifier result = apiInstance.instancePresetFilePost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstanceApi#instancePresetFilePost");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
public class InstanceApiExample {
public static void main(String[] args) {
InstanceApi apiInstance = new InstanceApi();
PresetExport body = ; // PresetExport | export details
try {
PresetIdentifier result = apiInstance.instancePresetFilePost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstanceApi#instancePresetFilePost");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-objc">
<pre class="prettyprint"><code class="language-cpp">PresetExport *body = ; // export details
InstanceApi *apiInstance = [[InstanceApi alloc] init];
[apiInstance instancePresetFilePostWith:body
completionHandler: ^(PresetIdentifier output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.InstanceApi()
var body = ; // {PresetExport} export details
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetFilePost(body, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class instancePresetFilePostExample
{
public void main()
{
var apiInstance = new InstanceApi();
var body = new PresetExport(); // PresetExport | export details
try
{
PresetIdentifier result = apiInstance.instancePresetFilePost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling InstanceApi.instancePresetFilePost: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\InstanceApi();
$body = ; // PresetExport | export details
try {
$result = $api_instance->instancePresetFilePost($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstanceApi->instancePresetFilePost: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::PresetExport->new(); # PresetExport | export details
eval {
my $result = $api_instance->instancePresetFilePost(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling InstanceApi->instancePresetFilePost: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePost-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.InstanceApi()
body = # PresetExport | export details
try:
api_response = api_instance.instance_preset_file_post(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstanceApi->instancePresetFilePost: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "export details",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PresetExport"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instancePresetFilePost_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instancePresetFilePost_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return preset identification </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePost-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePost-200-schema">
<div id='responses-instancePresetFilePost-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "On success return preset identification",
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePost-200-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePost-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePost-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid JSON request </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePost-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePost-400-schema">
<div id='responses-instancePresetFilePost-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Invalid JSON request",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePost-400-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePost-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePost-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - Preset or file path not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePost-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePost-404-schema">
<div id='responses-instancePresetFilePost-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Preset or file path not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePost-404-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePost-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePost-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePost-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePost-500-schema">
<div id='responses-instancePresetFilePost-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePost-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePost-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePost-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePost-501-schema">Schema</a>
</li>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetFilePost-501-schema">
<div id='responses-instancePresetFilePost-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePost-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePost-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePost-501-schema-data' type='hidden' value=''></input>
</div>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
</div>
</article>
</div>
<hr>
<div id="api-Instance-instancePresetFilePut">
<article id="api-Instance-instancePresetFilePut-0" data-group="User" data-name="instancePresetFilePut" data-version="0">
<div class="pull-left">
<h1>instancePresetFilePut</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">import a preset from file as a new preset (server only).</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/preset/file</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active"><a href="#examples-Instance-instancePresetFilePut-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetFilePut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetFilePut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetFilePut-0-python">Python</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="examples-Instance-instancePresetFilePut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/preset/file"</code></pre>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
import java.io.File;
import java.util.*;
public class InstanceApiExample {
public static void main(String[] args) {
InstanceApi apiInstance = new InstanceApi();
PresetImport body = ; // PresetImport | import details
try {
PresetIdentifier result = apiInstance.instancePresetFilePut(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstanceApi#instancePresetFilePut");
e.printStackTrace();
}
}
}</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
public class InstanceApiExample {
public static void main(String[] args) {
InstanceApi apiInstance = new InstanceApi();
PresetImport body = ; // PresetImport | import details
try {
PresetIdentifier result = apiInstance.instancePresetFilePut(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstanceApi#instancePresetFilePut");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-objc">
<pre class="prettyprint"><code class="language-cpp">PresetImport *body = ; // import details
InstanceApi *apiInstance = [[InstanceApi alloc] init];
[apiInstance instancePresetFilePutWith:body
completionHandler: ^(PresetIdentifier output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-javascript">
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
var api = new SdRangel.InstanceApi()
var body = ; // {PresetImport} import details
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetFilePut(body, callback);
</code></pre>
</div>
<!--<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
namespace Example
{
public class instancePresetFilePutExample
{
public void main()
{
var apiInstance = new InstanceApi();
var body = new PresetImport(); // PresetImport | import details
try
{
PresetIdentifier result = apiInstance.instancePresetFilePut(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling InstanceApi.instancePresetFilePut: " + e.Message );
}
}
}
}
</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\InstanceApi();
$body = ; // PresetImport | import details
try {
$result = $api_instance->instancePresetFilePut($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstanceApi->instancePresetFilePut: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::PresetImport->new(); # PresetImport | import details
eval {
my $result = $api_instance->instancePresetFilePut(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling InstanceApi->instancePresetFilePut: $@\n";
}</code></pre>
</div>
<div class="tab-pane" id="examples-Instance-instancePresetFilePut-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_sdrangel.InstanceApi()
body = # PresetImport | import details
try:
api_response = api_instance.instance_preset_file_put(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling InstanceApi->instancePresetFilePut: %s\n" % e)</code></pre>
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "import details",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PresetImport"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instancePresetFilePut_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instancePresetFilePut_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
<h3> Status: 200 - On success return preset identification </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePut-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePut-200-schema">
<div id='responses-instancePresetFilePut-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "On success return preset identification",
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePut-200-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePut-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePut-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 400 - Invalid JSON request </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePut-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePut-400-schema">
<div id='responses-instancePresetFilePut-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Invalid JSON request",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePut-400-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePut-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePut-400-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 404 - File not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePut-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePut-404-schema">
<div id='responses-instancePresetFilePut-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "File not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePut-404-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePut-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePut-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePut-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetFilePut-500-schema">
<div id='responses-instancePresetFilePut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePut-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePut-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePut-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetFilePut-501-schema">Schema</a>
</li>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetFilePut-501-schema">
<div id='responses-instancePresetFilePut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetFilePut-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetFilePut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetFilePut-501-schema-data' type='hidden' value=''></input>
</div>
Server: web API: implemented /sdrangel/preset/file
2017-12-18 19:11:34 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instancePresetGet">
<article id="api-Instance-instancePresetGet-0" data-group="User" data-name="instancePresetGet" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instancePresetGet</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">List all presets in the instance</p>
<p></p>
<br />
Web API: renamed /sdrangel/preset GET to /sdrangel/presets GET as this returns the list of presets
2017-12-20 18:50:58 -05:00
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel/presets</span></code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instancePresetGet-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetGet-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetGet-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetGet-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetGet-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetGet-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetGet-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetGet-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetGet-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetGet-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetGet-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instancePresetGet-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel/presets"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Presets result = apiInstance.instancePresetGet();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
Presets result = apiInstance.instancePresetGet();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetGet");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instancePresetGetWithCompletionHandler:
^(Presets output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetGet(callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instancePresetGet-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instancePresetGetExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
Presets result = apiInstance.instancePresetGet();
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instancePresetGet: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
$result = $api_instance->instancePresetGet();
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instancePresetGet: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instancePresetGet();
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instancePresetGet: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetGet-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
api_response = api_instance.instance_preset_get()
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instancePresetGet: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
<h3> Status: 200 - On success return preset list </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetGet-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetGet-200-schema">
<div id='responses-instancePresetGet-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "On success return preset list",
"schema" : {
"$ref" : "#/definitions/Presets"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetGet-200-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetGet-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetGet-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetGet-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetGet-500-schema">
<div id='responses-instancePresetGet-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetGet-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetGet-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetGet-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetGet-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetGet-501-schema">
<div id='responses-instancePresetGet-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetGet-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetGet-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetGet-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instancePresetPatch">
<article id="api-Instance-instancePresetPatch-0" data-group="User" data-name="instancePresetPatch" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instancePresetPatch</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">Load a preset in a device set</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/sdrangel/preset</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instancePresetPatch-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetPatch-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetPatch-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetPatch-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetPatch-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetPatch-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetPatch-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetPatch-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetPatch-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetPatch-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetPatch-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instancePresetPatch-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PATCH "http://localhost/sdrangel/preset"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetTransfer body = ; // PresetTransfer | Load preset settings to the device set
try {
PresetIdentifier result = apiInstance.instancePresetPatch(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetPatch");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetTransfer body = ; // PresetTransfer | Load preset settings to the device set
try {
PresetIdentifier result = apiInstance.instancePresetPatch(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetPatch");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">PresetTransfer *body = ; // Load preset settings to the device set
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instancePresetPatchWith:body
completionHandler: ^(PresetIdentifier output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = ; // {PresetTransfer} Load preset settings to the device set
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetPatch(body, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instancePresetPatchExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = new PresetTransfer(); // PresetTransfer | Load preset settings to the device set
try
{
PresetIdentifier result = apiInstance.instancePresetPatch(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instancePresetPatch: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
$body = ; // PresetTransfer | Load preset settings to the device set
try {
$result = $api_instance->instancePresetPatch($body);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instancePresetPatch: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::PresetTransfer->new(); # PresetTransfer | Load preset settings to the device set
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instancePresetPatch(body => $body);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instancePresetPatch: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPatch-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
body = # PresetTransfer | Load preset settings to the device set
try:
api_response = api_instance.instance_preset_patch(body)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instancePresetPatch: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "Load preset settings to the device set",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PresetTransfer"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instancePresetPatch_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instancePresetPatch_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<h3> Status: 202 - On successful sending of the message the selected preset identification is returned </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<a data-toggle="tab" href="#responses-instancePresetPatch-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<div class="tab-pane active" id="responses-instancePresetPatch-202-schema">
<div id='responses-instancePresetPatch-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
"description" : "On successful sending of the message the selected preset identification is returned",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
$('#responses-instancePresetPatch-202-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPatch-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<input id='responses-instancePresetPatch-202-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<h3> Status: 400 - Invalid JSON request or preset type and device set type mismatch </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPatch-400-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<div class="tab-pane active" id="responses-instancePresetPatch-400-schema">
<div id='responses-instancePresetPatch-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid JSON request or preset type and device set type mismatch",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPatch-400-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPatch-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPatch-400-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
<h3> Status: 404 - No preset or device set found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPatch-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPatch-404-schema">
<div id='responses-instancePresetPatch-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "No preset or device set found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPatch-404-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPatch-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPatch-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPatch-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPatch-500-schema">
<div id='responses-instancePresetPatch-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPatch-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPatch-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPatch-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPatch-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetPatch-501-schema">
<div id='responses-instancePresetPatch-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPatch-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPatch-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPatch-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instancePresetPost">
<article id="api-Instance-instancePresetPost-0" data-group="User" data-name="instancePresetPost" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instancePresetPost</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<p class="marked">Create a new preset from a device set settings. Frequency and type is ignored and taken from the the device set values.</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/sdrangel/preset</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instancePresetPost-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetPost-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetPost-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetPost-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetPost-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetPost-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetPost-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetPost-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetPost-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetPost-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetPost-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instancePresetPost-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/sdrangel/preset"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetTransfer body = ; // PresetTransfer | save device set settings on a new preset
try {
PresetIdentifier result = apiInstance.instancePresetPost(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetPost");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetTransfer body = ; // PresetTransfer | save device set settings on a new preset
try {
PresetIdentifier result = apiInstance.instancePresetPost(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetPost");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">PresetTransfer *body = ; // save device set settings on a new preset
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instancePresetPostWith:body
completionHandler: ^(PresetIdentifier output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = ; // {PresetTransfer} save device set settings on a new preset
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetPost(body, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instancePresetPost-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instancePresetPostExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = new PresetTransfer(); // PresetTransfer | save device set settings on a new preset
try
{
PresetIdentifier result = apiInstance.instancePresetPost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instancePresetPost: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
$body = ; // PresetTransfer | save device set settings on a new preset
try {
$result = $api_instance->instancePresetPost($body);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instancePresetPost: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::PresetTransfer->new(); # PresetTransfer | save device set settings on a new preset
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instancePresetPost(body => $body);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instancePresetPost: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPost-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
body = # PresetTransfer | save device set settings on a new preset
try:
api_response = api_instance.instance_preset_post(body)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instancePresetPost: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "save device set settings on a new preset",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PresetTransfer"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instancePresetPost_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instancePresetPost_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<h3> Status: 202 - On successful sending of the message the created preset identification is returned </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<a data-toggle="tab" href="#responses-instancePresetPost-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<div class="tab-pane active" id="responses-instancePresetPost-202-schema">
<div id='responses-instancePresetPost-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
"description" : "On successful sending of the message the created preset identification is returned",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
$('#responses-instancePresetPost-202-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPost-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<input id='responses-instancePresetPost-202-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<h3> Status: 400 - Invalid JSON request </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPost-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPost-400-schema">
<div id='responses-instancePresetPost-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid JSON request",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPost-400-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPost-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPost-400-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<h3> Status: 404 - Device set not found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPost-404-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<div class="tab-pane active" id="responses-instancePresetPost-404-schema">
<div id='responses-instancePresetPost-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Device set not found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPost-404-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPost-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPost-404-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<h3> Status: 409 - Preset already exists </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<a data-toggle="tab" href="#responses-instancePresetPost-409-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<div class="tab-pane active" id="responses-instancePresetPost-409-schema">
<div id='responses-instancePresetPost-409-schema-409' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Preset already exists",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
$('#responses-instancePresetPost-409-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPost-409-schema-409');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: /sdrangel/preset (PUT, POST) implementation
2017-11-25 12:32:37 -05:00
<input id='responses-instancePresetPost-409-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPost-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPost-500-schema">
<div id='responses-instancePresetPost-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPost-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPost-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPost-500-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPost-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetPost-501-schema">
<div id='responses-instancePresetPost-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPost-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPost-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPost-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instancePresetPut">
<article id="api-Instance-instancePresetPut-0" data-group="User" data-name="instancePresetPut" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instancePresetPut</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
Server: Web API: implemented /sdrangel/preset (PUT)
2017-12-20 08:31:17 -05:00
<p class="marked">Update an existing preset with device set settings.</p>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/sdrangel/preset</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instancePresetPut-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instancePresetPut-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instancePresetPut-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetPut-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetPut-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instancePresetPut-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instancePresetPut-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instancePresetPut-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instancePresetPut-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instancePresetPut-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instancePresetPut-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instancePresetPut-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/sdrangel/preset"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetTransfer body = ; // PresetTransfer | save device set settings to the preset
try {
PresetIdentifier result = apiInstance.instancePresetPut(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetPut");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
PresetTransfer body = ; // PresetTransfer | save device set settings to the preset
try {
PresetIdentifier result = apiInstance.instancePresetPut(body);
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instancePresetPut");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">PresetTransfer *body = ; // save device set settings to the preset
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instancePresetPutWith:body
completionHandler: ^(PresetIdentifier output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = ; // {PresetTransfer} save device set settings to the preset
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instancePresetPut(body, callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instancePresetPut-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instancePresetPutExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var body = new PresetTransfer(); // PresetTransfer | save device set settings to the preset
try
{
PresetIdentifier result = apiInstance.instancePresetPut(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instancePresetPut: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
$body = ; // PresetTransfer | save device set settings to the preset
try {
$result = $api_instance->instancePresetPut($body);
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instancePresetPut: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
my $body = SWGSDRangel::Object::PresetTransfer->new(); # PresetTransfer | save device set settings to the preset
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instancePresetPut(body => $body);
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instancePresetPut: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instancePresetPut-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
body = # PresetTransfer | save device set settings to the preset
try:
api_response = api_instance.instance_preset_put(body)
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instancePresetPut: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"in" : "body",
"name" : "body",
"description" : "save device set settings to the preset",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PresetTransfer"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_instancePresetPut_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_instancePresetPut_body"></div>
</td>
</tr>
</table>
<h2>Responses</h2>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<h3> Status: 202 - On successful sending of the message the selected preset identification is returned </h3>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<a data-toggle="tab" href="#responses-instancePresetPut-202-schema">Schema</a>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<div class="tab-pane active" id="responses-instancePresetPut-202-schema">
<div id='responses-instancePresetPut-202-schema-202' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
"description" : "On successful sending of the message the selected preset identification is returned",
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
"schema" : {
"$ref" : "#/definitions/PresetIdentifier"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
$('#responses-instancePresetPut-202-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPut-202-schema-202');
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
result.empty();
result.append(view.render());
});
</script>
</div>
Web API: replaced status code 200 by 202 whenever an asynchronous message is enqueued
2017-12-21 12:10:43 -05:00
<input id='responses-instancePresetPut-202-schema-data' type='hidden' value=''></input>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
<h3> Status: 400 - Invalid JSON request </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPut-400-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPut-400-schema">
<div id='responses-instancePresetPut-400-schema-400' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Invalid JSON request",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: /sdrangel/preset (DELETE) implementation
2017-11-25 13:42:56 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPut-400-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPut-400-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPut-400-schema-data' type='hidden' value=''></input>
</div>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<h3> Status: 404 - No preset or device set found </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPut-404-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPut-404-schema">
<div id='responses-instancePresetPut-404-schema-404' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "No preset or device set found",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPut-404-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPut-404-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPut-404-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPut-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instancePresetPut-500-schema">
<div id='responses-instancePresetPut-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPut-500-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPut-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPut-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instancePresetPut-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instancePresetPut-501-schema">
<div id='responses-instancePresetPut-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instancePresetPut-501-schema-data').val(stringify(schema));
var result = $('#responses-instancePresetPut-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instancePresetPut-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div id="api-Instance-instanceSummary">
<article id="api-Instance-instanceSummary-0" data-group="User" data-name="instanceSummary" data-version="0">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<div class="pull-left">
<h1>instanceSummary</h1>
<p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">SDRangel instance summary</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/sdrangel</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<li class="active"><a href="#examples-Instance-instanceSummary-0-curl">Curl</a></li>
<li class=""><a href="#examples-Instance-instanceSummary-0-java">Java</a></li>
<li class=""><a href="#examples-Instance-instanceSummary-0-android">Android</a></li>
<!--<li class=""><a href="#examples-Instance-instanceSummary-0-groovy">Groovy</a></li>-->
<li class=""><a href="#examples-Instance-instanceSummary-0-objc">Obj-C</a></li>
<li class=""><a href="#examples-Instance-instanceSummary-0-javascript">JavaScript</a></li>
<!--<li class=""><a href="#examples-Instance-instanceSummary-0-angular">Angular</a></li>-->
<li class=""><a href="#examples-Instance-instanceSummary-0-csharp">C#</a></li>
<li class=""><a href="#examples-Instance-instanceSummary-0-php">PHP</a></li>
<li class=""><a href="#examples-Instance-instanceSummary-0-perl">Perl</a></li>
<li class=""><a href="#examples-Instance-instanceSummary-0-python">Python</a></li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane active" id="examples-Instance-instanceSummary-0-curl">
Web API: removed host from Swagger yaml spec so that it takes the current host in Swagger UI
2018-01-24 18:16:07 -05:00
<pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/sdrangel"</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-java">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.*;
import SWGSDRangel.auth.*;
import SWGSDRangel.model.*;
import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
import java.io.File;
import java.util.*;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
InstanceSummaryResponse result = apiInstance.instanceSummary();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceSummary");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-android">
<pre class="prettyprint"><code class="language-java">import SWGSDRangel.api.InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
public class InstanceApiExample {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
public static void main(String[] args) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
InstanceSummaryResponse result = apiInstance.instanceSummary();
System.out.println(result);
} catch (ApiException e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
System.err.println("Exception when calling InstanceApi#instanceSummary");
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-groovy">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-objc">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cpp">
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
InstanceApi *apiInstance = [[InstanceApi alloc] init];
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
[apiInstance instanceSummaryWithCompletionHandler:
^(InstanceSummaryResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-javascript">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-js">var SdRangel = require('sd_rangel');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var api = new SdRangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.instanceSummary(callback);
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<!--<div class="tab-pane" id="examples-Instance-instanceSummary-0-angular">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-csharp">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
using SWGSDRangel.Api;
using SWGSDRangel.Client;
using SWGSDRangel.Model;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
namespace Example
{
public class instanceSummaryExample
{
public void main()
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
var apiInstance = new InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try
{
InstanceSummaryResponse result = apiInstance.instanceSummary();
Debug.WriteLine(result);
}
catch (Exception e)
{
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
Debug.Print("Exception when calling InstanceApi.instanceSummary: " + e.Message );
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
}
}
}
</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-php">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
$api_instance = new Swagger\Client\Api\InstanceApi();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try {
$result = $api_instance->instanceSummary();
print_r($result);
} catch (Exception $e) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
echo 'Exception when calling InstanceApi->instanceSummary: ', $e->getMessage(), PHP_EOL;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
?></code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-perl">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
use SWGSDRangel::Configuration;
use SWGSDRangel::InstanceApi;
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
my $api_instance = SWGSDRangel::InstanceApi->new();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
eval {
my $result = $api_instance->instanceSummary();
print Dumper($result);
};
if ($@) {
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
warn "Exception when calling InstanceApi->instanceSummary: $@\n";
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}</code></pre>
</div>
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
<div class="tab-pane" id="examples-Instance-instanceSummary-0-python">
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
import swagger_sdrangel
from swagger_sdrangel.rest import ApiException
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
from pprint import pprint
# create an instance of the API class
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
api_instance = swagger_sdrangel.InstanceApi()
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
try:
api_response = api_instance.instance_summary()
pprint(api_response)
except ApiException as e:
Web API: changed namespace and some namings
2017-12-01 23:45:30 -05:00
print("Exception when calling InstanceApi->instanceSummary: %s\n" % e)</code></pre>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
<h2>Parameters</h2>
<h2>Responses</h2>
<h3> Status: 200 - Success </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceSummary-200-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceSummary-200-schema">
<div id='responses-instanceSummary-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Success",
"schema" : {
"$ref" : "#/definitions/InstanceSummaryResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceSummary-200-schema-data').val(stringify(schema));
var result = $('#responses-instanceSummary-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceSummary-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 500 - Error </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-instanceSummary-500-schema">Schema</a>
</li>
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-instanceSummary-500-schema">
<div id='responses-instanceSummary-500-schema-500' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
Server: changes to support DeviceSet
2017-12-17 17:15:42 -05:00
var schemaWrapper = {
"description" : "Error",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceSummary-500-schema-data').val(stringify(schema));
var result = $('#responses-instanceSummary-500-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceSummary-500-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3> Status: 501 - Function not implemented </h3>
<ul class="nav nav-tabs nav-tabs-examples" >
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<li class="active">
<a data-toggle="tab" href="#responses-instanceSummary-501-schema">Schema</a>
</li>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</ul>
<div class="tab-content" style='margin-bottom: 10px;'>
Web API: embellish a little bit the swagger.yaml file and factorize errors 500 and 501
2017-12-21 12:48:24 -05:00
<div class="tab-pane active" id="responses-instanceSummary-501-schema">
<div id='responses-instanceSummary-501-schema-501' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Function not implemented",
"schema" : {
"$ref" : "#/definitions/ErrorResponse"
}
};
var schema = schemaWrapper.schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}
//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-instanceSummary-501-schema-data').val(stringify(schema));
var result = $('#responses-instanceSummary-501-schema-501');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-instanceSummary-501-schema-data' type='hidden' value=''></input>
</div>
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</article>
</div>
<hr>
</section>
</div>
<div id="footer">
<div id="api-_footer">
<p>Suggestions, contact, support and error reporting;
<div class="app-desc">Information URL: <a href="https://github.com/f4exb/sdrangel">https://github.com/f4exb/sdrangel</a></div>
<div class="app-desc">Contact Info: <a href="f4exb06@gmail.com">f4exb06@gmail.com</a></div>
</p>
<div class="license-info">All rights reserved</div>
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
</div>
</div>
<div id="generator">
<div class="content">
Web API: AirspyHF: implemented settings entry points
2018-03-22 00:10:13 -04:00
Generated 2018-03-22T05:08:39.552+01:00
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
</div>
</div>
</div>
</div>
</div>
<script>
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory();
else if(typeof define === 'function' && define.amd)
define("JSONFormatter", [], factory);
else if(typeof exports === 'object')
exports["JSONFormatter"] = factory();
else
root["JSONFormatter"] = factory();
})(this, function() {
return /******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId])
/******/ return installedModules[moduleId].exports;
/******/
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ exports: {},
/******/ id: moduleId,
/******/ loaded: false
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.loaded = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "dist";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(0);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */
/***/ function(module, exports, __webpack_require__) {
module.exports = __webpack_require__(1);
/***/ },
/* 1 */
/***/ function(module, exports, __webpack_require__) {
"use strict";
__webpack_require__(2);
var helpers_ts_1 = __webpack_require__(6);
var DATE_STRING_REGEX = /(^\d{1,4}[\.|\\/|-]\d{1,2}[\.|\\/|-]\d{1,4})(\s*(?:0?[1-9]:[0-5]|1(?=[012])\d:[0-5])\d\s*[ap]m)?$/;
var PARTIAL_DATE_REGEX = /\d{2}:\d{2}:\d{2} GMT-\d{4}/;
var JSON_DATE_REGEX = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/;
// When toggleing, don't animated removal or addition of more than a few items
var MAX_ANIMATED_TOGGLE_ITEMS = 10;
var requestAnimationFrame = window.requestAnimationFrame || function (cb) { cb(); return 0; };
;
var _defaultConfig = {
hoverPreviewEnabled: false,
hoverPreviewArrayCount: 100,
hoverPreviewFieldCount: 5,
animateOpen: true,
animateClose: true,
theme: null
};
module.exports = (function () {
/**
* @param {object} json The JSON object you want to render. It has to be an
* object or array. Do NOT pass raw JSON string.
*
* @param {number} [open=1] his number indicates up to how many levels the
* rendered tree should expand. Set it to `0` to make the whole tree collapsed
* or set it to `Infinity` to expand the tree deeply
*
* @param {object} [config=defaultConfig] -
* defaultConfig = {
* hoverPreviewEnabled: false,
* hoverPreviewArrayCount: 100,
* hoverPreviewFieldCount: 5
* }
*
* Available configurations:
* #####Hover Preview
* * `hoverPreviewEnabled`: enable preview on hover
* * `hoverPreviewArrayCount`: number of array items to show in preview Any
* array larger than this number will be shown as `Array[XXX]` where `XXX`
* is length of the array.
* * `hoverPreviewFieldCount`: number of object properties to show for object
* preview. Any object with more properties that thin number will be
* truncated.
*
* @param {string} [key=undefined] The key that this object in it's parent
* context
*/
function JSONFormatter(json, open, config, key) {
if (open === void 0) { open = 1; }
if (config === void 0) { config = _defaultConfig; }
this.json = json;
this.open = open;
this.config = config;
this.key = key;
// Hold the open state after the toggler is used
this._isOpen = null;
// Setting default values for config object
if (this.config.hoverPreviewEnabled === undefined) {
this.config.hoverPreviewEnabled = _defaultConfig.hoverPreviewEnabled;
}
if (this.config.hoverPreviewArrayCount === undefined) {
this.config.hoverPreviewArrayCount = _defaultConfig.hoverPreviewArrayCount;
}
if (this.config.hoverPreviewFieldCount === undefined) {
this.config.hoverPreviewFieldCount = _defaultConfig.hoverPreviewFieldCount;
}
}
Object.defineProperty(JSONFormatter.prototype, "isOpen", {
/*
* is formatter open?
*/
get: function () {
if (this._isOpen !== null) {
return this._isOpen;
}
else {
return this.open > 0;
}
},
/*
* set open state (from toggler)
*/
set: function (value) {
this._isOpen = value;
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "isDate", {
/*
* is this a date string?
*/
get: function () {
return (this.type === 'string') &&
(DATE_STRING_REGEX.test(this.json) ||
JSON_DATE_REGEX.test(this.json) ||
PARTIAL_DATE_REGEX.test(this.json));
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "isUrl", {
/*
* is this a URL string?
*/
get: function () {
return this.type === 'string' && (this.json.indexOf('http') === 0);
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "isArray", {
/*
* is this an array?
*/
get: function () {
return Array.isArray(this.json);
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "isObject", {
/*
* is this an object?
* Note: In this context arrays are object as well
*/
get: function () {
return helpers_ts_1.isObject(this.json);
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "isEmptyObject", {
/*
* is this an empty object with no properties?
*/
get: function () {
return !this.keys.length && !this.isArray;
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "isEmpty", {
/*
* is this an empty object or array?
*/
get: function () {
return this.isEmptyObject || (this.keys && !this.keys.length && this.isArray);
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "hasKey", {
/*
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
* did we receive a key argument?
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
* This means that the formatter was called as a sub formatter of a parent formatter
*/
get: function () {
return typeof this.key !== 'undefined';
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "constructorName", {
/*
* if this is an object, get constructor function name
*/
get: function () {
return helpers_ts_1.getObjectName(this.json);
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "type", {
/*
* get type of this value
* Possible values: all JavaScript primitive types plus "array" and "null"
*/
get: function () {
return helpers_ts_1.getType(this.json);
},
enumerable: true,
configurable: true
});
Object.defineProperty(JSONFormatter.prototype, "keys", {
/*
* get object keys
* If there is an empty key we pad it wit quotes to make it visible
*/
get: function () {
if (this.isObject) {
return Object.keys(this.json).map(function (key) { return key ? key : '""'; });
}
else {
return [];
}
},
enumerable: true,
configurable: true
});
/**
* Toggles `isOpen` state
*
*/
JSONFormatter.prototype.toggleOpen = function () {
this.isOpen = !this.isOpen;
if (this.element) {
if (this.isOpen) {
this.appendChildren(this.config.animateOpen);
}
else {
this.removeChildren(this.config.animateClose);
}
this.element.classList.toggle(helpers_ts_1.cssClass('open'));
}
};
/**
* Open all children up to a certain depth.
* Allows actions such as expand all/collapse all
*
*/
JSONFormatter.prototype.openAtDepth = function (depth) {
if (depth === void 0) { depth = 1; }
if (depth < 0) {
return;
}
this.open = depth;
this.isOpen = (depth !== 0);
if (this.element) {
this.removeChildren(false);
if (depth === 0) {
this.element.classList.remove(helpers_ts_1.cssClass('open'));
}
else {
this.appendChildren(this.config.animateOpen);
this.element.classList.add(helpers_ts_1.cssClass('open'));
}
}
};
/**
* Generates inline preview
*
* @returns {string}
*/
JSONFormatter.prototype.getInlinepreview = function () {
var _this = this;
if (this.isArray) {
// if array length is greater then 100 it shows "Array[101]"
if (this.json.length > this.config.hoverPreviewArrayCount) {
return "Array[" + this.json.length + "]";
}
else {
return "[" + this.json.map(helpers_ts_1.getPreview).join(', ') + "]";
}
}
else {
var keys = this.keys;
// the first five keys (like Chrome Developer Tool)
var narrowKeys = keys.slice(0, this.config.hoverPreviewFieldCount);
// json value schematic information
var kvs = narrowKeys.map(function (key) { return (key + ":" + helpers_ts_1.getPreview(_this.json[key])); });
// if keys count greater then 5 then show ellipsis
var ellipsis = keys.length >= this.config.hoverPreviewFieldCount ? '…' : '';
return "{" + kvs.join(', ') + ellipsis + "}";
}
};
/**
* Renders an HTML element and installs event listeners
*
* @returns {HTMLDivElement}
*/
JSONFormatter.prototype.render = function () {
// construct the root element and assign it to this.element
this.element = helpers_ts_1.createElement('div', 'row');
// construct the toggler link
var togglerLink = helpers_ts_1.createElement('a', 'toggler-link');
// if this is an object we need a wrapper span (toggler)
if (this.isObject) {
togglerLink.appendChild(helpers_ts_1.createElement('span', 'toggler'));
}
// if this is child of a parent formatter we need to append the key
if (this.hasKey) {
togglerLink.appendChild(helpers_ts_1.createElement('span', 'key', this.key + ":"));
}
// Value for objects and arrays
if (this.isObject) {
// construct the value holder element
var value = helpers_ts_1.createElement('span', 'value');
// we need a wrapper span for objects
var objectWrapperSpan = helpers_ts_1.createElement('span');
// get constructor name and append it to wrapper span
var constructorName = helpers_ts_1.createElement('span', 'constructor-name', this.constructorName);
objectWrapperSpan.appendChild(constructorName);
// if it's an array append the array specific elements like brackets and length
if (this.isArray) {
var arrayWrapperSpan = helpers_ts_1.createElement('span');
arrayWrapperSpan.appendChild(helpers_ts_1.createElement('span', 'bracket', '['));
arrayWrapperSpan.appendChild(helpers_ts_1.createElement('span', 'number', (this.json.length)));
arrayWrapperSpan.appendChild(helpers_ts_1.createElement('span', 'bracket', ']'));
objectWrapperSpan.appendChild(arrayWrapperSpan);
}
// append object wrapper span to toggler link
value.appendChild(objectWrapperSpan);
togglerLink.appendChild(value);
}
else {
// make a value holder element
var value = this.isUrl ? helpers_ts_1.createElement('a') : helpers_ts_1.createElement('span');
// add type and other type related CSS classes
value.classList.add(helpers_ts_1.cssClass(this.type));
if (this.isDate) {
value.classList.add(helpers_ts_1.cssClass('date'));
}
if (this.isUrl) {
value.classList.add(helpers_ts_1.cssClass('url'));
value.setAttribute('href', this.json);
}
// Append value content to value element
var valuePreview = helpers_ts_1.getValuePreview(this.json, this.json);
value.appendChild(document.createTextNode(valuePreview));
// append the value element to toggler link
togglerLink.appendChild(value);
}
// if hover preview is enabled, append the inline preview element
if (this.isObject && this.config.hoverPreviewEnabled) {
var preview = helpers_ts_1.createElement('span', 'preview-text');
preview.appendChild(document.createTextNode(this.getInlinepreview()));
togglerLink.appendChild(preview);
}
// construct a children element
var children = helpers_ts_1.createElement('div', 'children');
// set CSS classes for children
if (this.isObject) {
children.classList.add(helpers_ts_1.cssClass('object'));
}
if (this.isArray) {
children.classList.add(helpers_ts_1.cssClass('array'));
}
if (this.isEmpty) {
children.classList.add(helpers_ts_1.cssClass('empty'));
}
// set CSS classes for root element
if (this.config && this.config.theme) {
this.element.classList.add(helpers_ts_1.cssClass(this.config.theme));
}
if (this.isOpen) {
this.element.classList.add(helpers_ts_1.cssClass('open'));
}
// append toggler and children elements to root element
this.element.appendChild(togglerLink);
this.element.appendChild(children);
// if formatter is set to be open call appendChildren
if (this.isObject && this.isOpen) {
this.appendChildren();
}
// add event listener for toggling
if (this.isObject) {
togglerLink.addEventListener('click', this.toggleOpen.bind(this));
}
return this.element;
};
/**
* Appends all the children to children element
* Animated option is used when user triggers this via a click
*/
JSONFormatter.prototype.appendChildren = function (animated) {
var _this = this;
if (animated === void 0) { animated = false; }
var children = this.element.querySelector("div." + helpers_ts_1.cssClass('children'));
if (!children || this.isEmpty) {
return;
}
if (animated) {
var index_1 = 0;
var addAChild_1 = function () {
var key = _this.keys[index_1];
var formatter = new JSONFormatter(_this.json[key], _this.open - 1, _this.config, key);
children.appendChild(formatter.render());
index_1 += 1;
if (index_1 < _this.keys.length) {
if (index_1 > MAX_ANIMATED_TOGGLE_ITEMS) {
addAChild_1();
}
else {
requestAnimationFrame(addAChild_1);
}
}
};
requestAnimationFrame(addAChild_1);
}
else {
this.keys.forEach(function (key) {
var formatter = new JSONFormatter(_this.json[key], _this.open - 1, _this.config, key);
children.appendChild(formatter.render());
});
}
};
/**
* Removes all the children from children element
* Animated option is used when user triggers this via a click
*/
JSONFormatter.prototype.removeChildren = function (animated) {
if (animated === void 0) { animated = false; }
var childrenElement = this.element.querySelector("div." + helpers_ts_1.cssClass('children'));
if (animated) {
var childrenRemoved_1 = 0;
var removeAChild_1 = function () {
if (childrenElement && childrenElement.children.length) {
childrenElement.removeChild(childrenElement.children[0]);
childrenRemoved_1 += 1;
if (childrenRemoved_1 > MAX_ANIMATED_TOGGLE_ITEMS) {
removeAChild_1();
}
else {
requestAnimationFrame(removeAChild_1);
}
}
};
requestAnimationFrame(removeAChild_1);
}
else {
if (childrenElement) {
childrenElement.innerHTML = '';
}
}
};
return JSONFormatter;
}());
/***/ },
/* 2 */
/***/ function(module, exports, __webpack_require__) {
// style-loader: Adds some css to the DOM by adding a <style> tag
// load the styles
var content = __webpack_require__(3);
if(typeof content === 'string') content = [[module.id, content, '']];
// add the styles to the DOM
var update = __webpack_require__(5)(content, {"sourceMap":true});
if(content.locals) module.exports = content.locals;
// Hot Module Replacement
if(false) {
// When the styles change, update the <style> tags
if(!content.locals) {
module.hot.accept("!!./../node_modules/css-loader/index.js?sourceMap!./../node_modules/less-loader/index.js?sourceMap!./style.less", function() {
var newContent = require("!!./../node_modules/css-loader/index.js?sourceMap!./../node_modules/less-loader/index.js?sourceMap!./style.less");
if(typeof newContent === 'string') newContent = [[module.id, newContent, '']];
update(newContent);
});
}
// When the module is disposed, remove the <style> tags
module.hot.dispose(function() { update(); });
}
/***/ },
/* 3 */
/***/ function(module, exports, __webpack_require__) {
exports = module.exports = __webpack_require__(4)();
// imports
// module
exports.push([module.id, ".json-formatter-row {\n font-family: monospace;\n}\n.json-formatter-row,\n.json-formatter-row a,\n.json-formatter-row a:hover {\n color: black;\n text-decoration: none;\n}\n.json-formatter-row .json-formatter-row {\n margin-left: 1rem;\n}\n.json-formatter-row .json-formatter-children.json-formatter-empty {\n opacity: 0.5;\n margin-left: 1rem;\n}\n.json-formatter-row .json-formatter-children.json-formatter-empty:after {\n display: none;\n}\n.json-formatter-row .json-formatter-children.json-formatter-empty.json-formatter-object:after {\n content: \"No properties\";\n}\n.json-formatter-row .json-formatter-children.json-formatter-empty.json-formatter-array:after {\n content: \"[]\";\n}\n.json-formatter-row .json-formatter-string {\n color: green;\n white-space: pre;\n word-wrap: break-word;\n}\n.json-formatter-row .json-formatter-number {\n color: blue;\n}\n.json-formatter-row .json-formatter-boolean {\n color: red;\n}\n.json-formatter-row .json-formatter-null {\n color: #855A00;\n}\n.json-formatter-row .json-formatter-undefined {\n color: #ca0b69;\n}\n.json-formatter-row .json-formatter-function {\n color: #FF20ED;\n}\n.json-formatter-row .json-formatter-date {\n background-color: rgba(0, 0, 0, 0.05);\n}\n.json-formatter-row .json-formatter-url {\n text-decoration: underline;\n color: blue;\n cursor: pointer;\n}\n.json-formatter-row .json-formatter-bracket {\n color: blue;\n}\n.json-formatter-row .json-formatter-key {\n color: #00008B;\n cursor: pointer;\n padding-right: 0.2rem;\n}\n.json-formatter-row .json-formatter-constructor-name {\n cursor: pointer;\n}\n.json-formatter-row .json-formatter-toggler {\n line-height: 1.2rem;\n font-size: 0.7rem;\n vertical-align: middle;\n opacity: 0.6;\n cursor: pointer;\n padding-right: 0.2rem;\n}\n.json-formatter-row .json-formatter-toggler:after {\n display: inline-block;\n transition: transform 100ms ease-in;\n content: \"\\25BA\";\n}\n.json-formatter-row > a > .json-formatter-preview-text {\n opacity: 0;\n transition: opacity 0.15s ease-in;\n font-style: italic;\n}\n.json-formatter-row:hover > a > .json-formatter-preview-text {\n opacity: 0.6;\n}\n.json-formatter-row.json-formatter-open > .json-formatter-toggler-link .json-formatter-toggler:after {\n transform: rotate(90deg);\n}\n.json-formatter-row.json-formatter-open > .json-formatter-children:after {\n display: inline-block;\n}\n.json-formatter-row.json-formatter-open > a > .json-formatter-preview-text {\n display: none;\n}\n.json-formatter-row.json-formatter-open.json-formatter-empty:after {\n display: block;\n}\n.json-formatter-dark.json-formatter-row {\n font-family: monospace;\n}\n.json-formatter-dark.json-formatter-row,\n.json-formatter-dark.json-formatter-row a,\n.json-formatter-dark.json-formatter-row a:hover {\n color: white;\n text-decoration: none;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-row {\n margin-left: 1rem;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-children.json-formatter-empty {\n opacity: 0.5;\n margin-left: 1rem;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-children.json-formatter-empty:after {\n display: none;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-children.json-formatter-empty.json-formatter-object:after {\n content: \"No properties\";\n}\n.json-formatter-dark.json-formatter-row .json-formatter-children.json-formatter-empty.json-formatter-array:after {\n content: \"[]\";\n}\n.json-formatter-dark.json-formatter-row .json-formatter-string {\n color: #31F031;\n white-space: pre;\n word-wrap: break-word;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-number {\n color: #66C2FF;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-boolean {\n color: #EC4242;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-null {\n color: #EEC97D;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-undefined {\n color: #ef8fbe;\n}\n.json-formatter-dark.json-formatter-row .json-formatter-function {\n color: #FD48CB;\n}\n.json-formatte
// exports
/***/ },
/* 4 */
/***/ function(module, exports) {
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
// css base code, injected by the css-loader
module.exports = function() {
var list = [];
// return the list of modules as css string
list.toString = function toString() {
var result = [];
for(var i = 0; i < this.length; i++) {
var item = this[i];
if(item[2]) {
result.push("@media " + item[2] + "{" + item[1] + "}");
} else {
result.push(item[1]);
}
}
return result.join("");
};
// import a list of modules into the list
list.i = function(modules, mediaQuery) {
if(typeof modules === "string")
modules = [[null, modules, ""]];
var alreadyImportedModules = {};
for(var i = 0; i < this.length; i++) {
var id = this[i][0];
if(typeof id === "number")
alreadyImportedModules[id] = true;
}
for(i = 0; i < modules.length; i++) {
var item = modules[i];
// skip already imported module
// this implementation is not 100% perfect for weird media query combinations
// when a module is imported multiple times with different media queries.
// I hope this will never occur (Hey this way we have smaller bundles)
if(typeof item[0] !== "number" || !alreadyImportedModules[item[0]]) {
if(mediaQuery && !item[2]) {
item[2] = mediaQuery;
} else if(mediaQuery) {
item[2] = "(" + item[2] + ") and (" + mediaQuery + ")";
}
list.push(item);
}
}
};
return list;
};
/***/ },
/* 5 */
/***/ function(module, exports, __webpack_require__) {
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
var stylesInDom = {},
memoize = function(fn) {
var memo;
return function () {
if (typeof memo === "undefined") memo = fn.apply(this, arguments);
return memo;
};
},
isOldIE = memoize(function() {
return /msie [6-9]\b/.test(window.navigator.userAgent.toLowerCase());
}),
getHeadElement = memoize(function () {
return document.head || document.getElementsByTagName("head")[0];
}),
singletonElement = null,
singletonCounter = 0,
styleElementsInsertedAtTop = [];
module.exports = function(list, options) {
if(false) {
if(typeof document !== "object") throw new Error("The style-loader cannot be used in a non-browser environment");
}
options = options || {};
// Force single-tag solution on IE6-9, which has a hard limit on the # of <style>
// tags it will allow on a page
if (typeof options.singleton === "undefined") options.singleton = isOldIE();
// By default, add <style> tags to the bottom of <head>.
if (typeof options.insertAt === "undefined") options.insertAt = "bottom";
var styles = listToStyles(list);
addStylesToDom(styles, options);
return function update(newList) {
var mayRemove = [];
for(var i = 0; i < styles.length; i++) {
var item = styles[i];
var domStyle = stylesInDom[item.id];
domStyle.refs--;
mayRemove.push(domStyle);
}
if(newList) {
var newStyles = listToStyles(newList);
addStylesToDom(newStyles, options);
}
for(var i = 0; i < mayRemove.length; i++) {
var domStyle = mayRemove[i];
if(domStyle.refs === 0) {
for(var j = 0; j < domStyle.parts.length; j++)
domStyle.parts[j]();
delete stylesInDom[domStyle.id];
}
}
};
}
function addStylesToDom(styles, options) {
for(var i = 0; i < styles.length; i++) {
var item = styles[i];
var domStyle = stylesInDom[item.id];
if(domStyle) {
domStyle.refs++;
for(var j = 0; j < domStyle.parts.length; j++) {
domStyle.parts[j](item.parts[j]);
}
for(; j < item.parts.length; j++) {
domStyle.parts.push(addStyle(item.parts[j], options));
}
} else {
var parts = [];
for(var j = 0; j < item.parts.length; j++) {
parts.push(addStyle(item.parts[j], options));
}
stylesInDom[item.id] = {id: item.id, refs: 1, parts: parts};
}
}
}
function listToStyles(list) {
var styles = [];
var newStyles = {};
for(var i = 0; i < list.length; i++) {
var item = list[i];
var id = item[0];
var css = item[1];
var media = item[2];
var sourceMap = item[3];
var part = {css: css, media: media, sourceMap: sourceMap};
if(!newStyles[id])
styles.push(newStyles[id] = {id: id, parts: [part]});
else
newStyles[id].parts.push(part);
}
return styles;
}
function insertStyleElement(options, styleElement) {
var head = getHeadElement();
var lastStyleElementInsertedAtTop = styleElementsInsertedAtTop[styleElementsInsertedAtTop.length - 1];
if (options.insertAt === "top") {
if(!lastStyleElementInsertedAtTop) {
head.insertBefore(styleElement, head.firstChild);
} else if(lastStyleElementInsertedAtTop.nextSibling) {
head.insertBefore(styleElement, lastStyleElementInsertedAtTop.nextSibling);
} else {
head.appendChild(styleElement);
}
styleElementsInsertedAtTop.push(styleElement);
} else if (options.insertAt === "bottom") {
head.appendChild(styleElement);
} else {
throw new Error("Invalid value for parameter 'insertAt'. Must be 'top' or 'bottom'.");
}
}
function removeStyleElement(styleElement) {
styleElement.parentNode.removeChild(styleElement);
var idx = styleElementsInsertedAtTop.indexOf(styleElement);
if(idx >= 0) {
styleElementsInsertedAtTop.splice(idx, 1);
}
}
function createStyleElement(options) {
var styleElement = document.createElement("style");
styleElement.type = "text/css";
insertStyleElement(options, styleElement);
return styleElement;
}
function createLinkElement(options) {
var linkElement = document.createElement("link");
linkElement.rel = "stylesheet";
insertStyleElement(options, linkElement);
return linkElement;
}
function addStyle(obj, options) {
var styleElement, update, remove;
if (options.singleton) {
var styleIndex = singletonCounter++;
styleElement = singletonElement || (singletonElement = createStyleElement(options));
update = applyToSingletonTag.bind(null, styleElement, styleIndex, false);
remove = applyToSingletonTag.bind(null, styleElement, styleIndex, true);
} else if(obj.sourceMap &&
typeof URL === "function" &&
typeof URL.createObjectURL === "function" &&
typeof URL.revokeObjectURL === "function" &&
typeof Blob === "function" &&
typeof btoa === "function") {
styleElement = createLinkElement(options);
update = updateLink.bind(null, styleElement);
remove = function() {
removeStyleElement(styleElement);
if(styleElement.href)
URL.revokeObjectURL(styleElement.href);
};
} else {
styleElement = createStyleElement(options);
update = applyToTag.bind(null, styleElement);
remove = function() {
removeStyleElement(styleElement);
};
}
update(obj);
return function updateStyle(newObj) {
if(newObj) {
if(newObj.css === obj.css && newObj.media === obj.media && newObj.sourceMap === obj.sourceMap)
return;
update(obj = newObj);
} else {
remove();
}
};
}
var replaceText = (function () {
var textStore = [];
return function (index, replacement) {
textStore[index] = replacement;
return textStore.filter(Boolean).join('\n');
};
})();
function applyToSingletonTag(styleElement, index, remove, obj) {
var css = remove ? "" : obj.css;
if (styleElement.styleSheet) {
styleElement.styleSheet.cssText = replaceText(index, css);
} else {
var cssNode = document.createTextNode(css);
var childNodes = styleElement.childNodes;
if (childNodes[index]) styleElement.removeChild(childNodes[index]);
if (childNodes.length) {
styleElement.insertBefore(cssNode, childNodes[index]);
} else {
styleElement.appendChild(cssNode);
}
}
}
function applyToTag(styleElement, obj) {
var css = obj.css;
var media = obj.media;
if(media) {
styleElement.setAttribute("media", media)
}
if(styleElement.styleSheet) {
styleElement.styleSheet.cssText = css;
} else {
while(styleElement.firstChild) {
styleElement.removeChild(styleElement.firstChild);
}
styleElement.appendChild(document.createTextNode(css));
}
}
function updateLink(linkElement, obj) {
var css = obj.css;
var sourceMap = obj.sourceMap;
if(sourceMap) {
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
// https://developer.mozilla.org/en/docs/Web/API/WindowBase64/Base64_encoding_and_decoding
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
css += "\n/*# sourceMappingURL=data:application/json;base64," + btoa(unescape(encodeURIComponent(JSON.stringify(sourceMap)))) + " */";
}
var blob = new Blob([css], { type: "text/css" });
var oldSrc = linkElement.href;
linkElement.href = URL.createObjectURL(blob);
if(oldSrc)
URL.revokeObjectURL(oldSrc);
}
/***/ },
/* 6 */
/***/ function(module, exports) {
"use strict";
/*
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
* Escapes `"` characters from string
*/
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
function escapeString(str) {
return str.replace('"', '\"');
}
/*
* Determines if a value is an object
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
*/
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
function isObject(value) {
var type = typeof value;
return !!value && (type == 'object');
}
exports.isObject = isObject;
/*
* Gets constructor name of an object.
*
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
*/
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
function getObjectName(object) {
if (object === undefined) {
return '';
}
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
if (object === null || (typeof object === 'object' && !object.constructor)) {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
return 'Object';
}
var funcNameRegex = /function ([^(]*)/;
var results = (funcNameRegex).exec((object).constructor.toString());
if (results && results.length > 1) {
return results[1];
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
} else {
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
return '';
}
}
exports.getObjectName = getObjectName;
/*
* Gets type of an object. Returns "null" for null objects
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
*/
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
function getType(object) {
if (object === null) {
return 'null';
}
return typeof object;
}
exports.getType = getType;
/*
* Generates inline preview for a JavaScript object based on a value
*/
function getValuePreview(object, value) {
var type = getType(object);
if (type === 'null' || type === 'undefined') {
return type;
}
if (type === 'string') {
value = '"' + escapeString(value) + '"';
}
if (type === 'function') {
// Remove content of the function
return object.toString()
.replace(/[\r\n]/g, '')
.replace(/\{.*\}/, '') + '{…}';
}
return value;
}
exports.getValuePreview = getValuePreview;
/*
* Generates inline preview for a JavaScript object
*/
function getPreview(object) {
var value = '';
if (isObject(object)) {
value = getObjectName(object);
if (Array.isArray(object))
value += '[' + object.length + ']';
}
else {
value = getValuePreview(object, object);
}
return value;
}
exports.getPreview = getPreview;
/*
* Generates a prefixed CSS class name
*/
function cssClass(className) {
return "json-formatter-" + className;
}
exports.cssClass = cssClass;
/*
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
* Creates a new DOM element with given type and class
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
* TODO: move me to helpers
*/
function createElement(type, className, content) {
var el = document.createElement(type);
if (className) {
el.classList.add(cssClass(className));
}
if (content !== undefined) {
if (content instanceof Node) {
el.appendChild(content);
}
else {
el.appendChild(document.createTextNode(String(content)));
}
}
return el;
}
exports.createElement = createElement;
/***/ }
/******/ ])
});
;
//# sourceMappingURL=json-formatter.js.map
</script>
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
<script>
(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSONSchemaView = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
'use strict';
/*
* Converts anyOf, allOf and oneOf to human readable string
*/
Object.defineProperty(exports, '__esModule', {
value: true
});
exports.convertXOf = convertXOf;
exports._if = _if;
function convertXOf(type) {
return type.substring(0, 3) + ' of';
}
/*
* if condition for ES6 template strings
* to be used only in template string
*
* @example mystr = `Random is ${_if(Math.random() > 0.5)`greater than 0.5``
*
* @param {boolean} condition
*
* @returns {function} the template function
*/
function _if(condition) {
return condition ? normal : empty;
}
function empty() {
return '';
}
function normal(template) {
for (var _len = arguments.length, expressions = Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
expressions[_key - 1] = arguments[_key];
}
return template.slice(1).reduce(function (accumulator, part, i) {
return accumulator + expressions[i] + part;
}, template[0]);
}
},{}],2:[function(require,module,exports){
'use strict';
/* globals JSONSchemaView */
Object.defineProperty(exports, '__esModule', {
value: true
});
var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ('value' in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
var _templateObject = _taggedTemplateLiteral(['\n <div class="any">\n ', '\n\n <span class="type type-any">&lt;any&gt;</span>\n\n ', '\n\t\t \n\t\t ', '\n\t\t ', '\n\t\t ', '\n </div>\n '], ['\n <div class="any">\n ', '\n\n <span class="type type-any">&lt;any&gt;</span>\n\n ', '\n\t\t \n\t\t ', '\n\t\t ', '\n\t\t ', '\n </div>\n ']),
_templateObject2 = _taggedTemplateLiteral(['\n <a class="title"><span class="toggle-handle"></span>', ' </a>\n '], ['\n <a class="title"><span class="toggle-handle"></span>', ' </a>\n ']),
_templateObject3 = _taggedTemplateLiteral(['\n <div class="inner description marked">', '</div>\n '], ['\n <div class="inner description marked">', '</div>\n ']),
_templateObject4 = _taggedTemplateLiteral(['\n <div class="inner required">Required: ', '</div>\n '], ['\n <div class="inner required">Required: ', '</div>\n ']),
_templateObject5 = _taggedTemplateLiteral(['\n <div class="inner default">Default: ', '</div>\n '], ['\n <div class="inner default">Default: ', '</div>\n ']),
_templateObject6 = _taggedTemplateLiteral(['\n <div class="inner pattern">Pattern: ', '</div>\n '], ['\n <div class="inner pattern">Pattern: ', '</div>\n ']),
_templateObject7 = _taggedTemplateLiteral(['\n <div class="primitive">\n ', '\n\n <span class="type">', '</span>\n\n \n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\t\t \n\t\t \n\t\t \n\t\t ', '\n\t\t ', '\n\t\t ', '\n\n ', '\n\n ', '\n ', '\n ', '\n </div>\n '], ['\n <div class="primitive">\n ', '\n\n <span class="type">', '</span>\n\n \n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\n ', '\n\t\t \n\t\t \n\t\t \n\t\t ', '\n\t\t ', '\n\t\t ', '\n\n ', '\n\n ', '\n ', '\n ', '\n </div>\n ']),
_templateObject8 = _taggedTemplateLiteral(['\n <span class="format">(', ')</span>\n '], ['\n <span class="format">(', ')</span>\n ']),
_templateObject9 = _taggedTemplateLiteral(['\n <span class="range minimum">minimum:', '</span>\n '], ['\n <span class="range minimum">minimum:', '</span>\n ']),
_templateObject10 = _taggedTemplateLiteral(['\n <span class="range exclusiveMinimum">(ex)minimum:', '</span>\n '], ['\n <span class="range exclusiveMinimum">(ex)minimum:', '</span>\n ']),
_templateObject11 = _taggedTemplateLiteral(['\n <span class="range maximum">maximum:', '</span>\n '], ['\n <span class="range maximum">maximum:', '</span>\n ']),
_templateObject12 = _taggedTemplateLiteral(['\n <span class="range exclusiveMaximum">(ex)maximum:', '</span>\n '], ['\n <span class="range exclusiveMaximum">(ex)maximum:', '</span>\n ']),
_templateObject13 = _taggedTemplateLiteral(['\n <span class="range minLength">minLength:', '</span>\n '], ['\n <span class="range minLength">minLength:', '</span>\n ']),
_templateObject14 = _taggedTemplateLiteral(['\n <span class="range maxLength">maxLength:', '</span>\n '], ['\n <span class="range maxLength">maxLength:', '</span>\n ']),
_templateObject15 = _taggedTemplateLiteral(['\n <div class="inner required">Required</div>\n '], ['\n <div class="inner required">Required</div>\n ']),
_templateObject16 = _taggedTemplateLiteral(['\n ', '\n '], ['\n ', '\n ']),
_templateObject17 = _taggedTemplateLiteral(['', ''], ['', '']),
_templateObject18 = _taggedTemplateLiteral(['\n <div class="array">\n <a class="title"><span class="toggle-handle"></span>', '<span class="opening bracket">[</span>', '</a>\n ', '\n <div class="inner">\n ', '\n </div>\n\n ', '\n\n ', '\n ', '\n ', '\n\n ', '\n </div>\n '], ['\n <div class="array">\n <a class="title"><span class="toggle-handle"></span>', '<span class="opening bracket">[</span>', '</a>\n ', '\n <div class="inner">\n ', '\n </div>\n\n ', '\n\n ', '\n ', '\n ', '\n\n ', '\n </div>\n ']),
_templateObject19 = _taggedTemplateLiteral(['<span class="closing bracket">]</span>'], ['<span class="closing bracket">]</span>']),
_templateObject20 = _taggedTemplateLiteral(['\n <span>\n <span title="items range">(', '..', ')</span>\n ', '\n </span>\n '], ['\n <span>\n <span title="items range">(', '..', ')</span>\n ', '\n </span>\n ']),
_templateObject21 = _taggedTemplateLiteral(['<span title="unique" class="uniqueItems">♦</span>'], ['<span title="unique" class="uniqueItems">♦</span>']),
_templateObject22 = _taggedTemplateLiteral(['\n <div class="description">', '</div>\n '], ['\n <div class="description">', '</div>\n ']),
_templateObject23 = _taggedTemplateLiteral(['\n <span class="closing bracket">]</span>\n '], ['\n <span class="closing bracket">]</span>\n ']),
_templateObject24 = _taggedTemplateLiteral(['\n <div class="object">\n <a class="title"><span\n class="toggle-handle"></span>', ' <span\n class="opening brace">{</span>', '</a>\n\n <div class="inner">\n ', '\n <!-- children go here -->\n\t\t \n\t\t ', '\n\t\t ', '\n\t\t \n\t\t\t', '\n </div>\n\n ', '\n\n ', '\n ', '\n ', '\n\n ', '\n </div>\n '], ['\n <div class="object">\n <a class="title"><span\n class="toggle-handle"></span>', ' <span\n class="opening brace">{</span>', '</a>\n\n <div class="inner">\n ', '\n <!-- children go here -->\n\t\t \n\t\t ', '\n\t\t ', '\n\t\t \n\t\t\t', '\n </div>\n\n ', '\n\n ', '\n ', '\n ', '\n\n ', '\n </div>\n ']),
_templateObject25 = _taggedTemplateLiteral(['\n <span class="closing brace" ng-if="isCollapsed">}</span>\n '], ['\n <span class="closing brace" ng-if="isCollapsed">}</span>\n ']),
_templateObject26 = _taggedTemplateLiteral(['\n <div class="required">Required: ', '</div>\n '], ['\n <div class="required">Required: ', '</div>\n ']),
_templateObject266 = _taggedTemplateLiteral(['\n <div class="required">Required: ', '</div>\n '], ['\n <div class="required">Required: ', '</div>\n ']),
_templateObject27 = _taggedTemplateLiteral(['\n <div class="default">Default: ', '</div>\n '], ['\n <div class="default">Default: ', '</div>\n ']),
_templateObject28 = _taggedTemplateLiteral(['\n <div class="pattern">Pattern: ', '</div>\n '], ['\n <div class="pattern">Pattern: ', '</div>\n ']),
_templateObject29 = _taggedTemplateLiteral(['\n <span class="closing brace">}</span>\n '], ['\n <span class="closing brace">}</span>\n ']),
_templateObject30 = _taggedTemplateLiteral(['\n <div class="inner enums">\n <b>Enum:</b>\n </div>\n '], ['\n <div class="inner enums">\n <b>Enum:</b>\n </div>\n ']);
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError('Cannot call a class as a function'); } }
function _taggedTemplateLiteral(strings, raw) { return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
var _helpersJs = require('./helpers.js');
/**
* @class JSONSchemaView
*
* A pure JavaScript component for rendering JSON Schema in HTML.
*/
var JSONSchemaView = (function () {
/**
* @param {object} schema The JSON Schema object
*
* @param {number} [open=1] his number indicates up to how many levels the
* rendered tree should expand. Set it to `0` to make the whole tree collapsed
* or set it to `Infinity` to expand the tree deeply
* @param {object} options.
* theme {string}: one of the following options: ['dark']
*/
function JSONSchemaView(schema, open) {
var _this = this;
var options = arguments.length <= 2 || arguments[2] === undefined ? { theme: null } : arguments[2];
_classCallCheck(this, JSONSchemaView);
this.schema = schema; //console.log(schema);
this.open = open;
this.options = options;
this.isCollapsed = open <= 0;
// if schema is an empty object which means any JOSN
this.isAny = typeof schema === 'object' && !Array.isArray(schema) && !Object.keys(schema).filter(function (k) {
return ['title', 'description'].indexOf(k) === -1;
}).length;
// Determine if a schema is an array
this.isArray = !this.isAny && this.schema && this.schema.type === 'array';
this.isObject = this.schema && (this.schema.type === 'object' || this.schema.properties || this.schema.anyOf || this.schema.oneof || this.schema.allOf);
// Determine if a schema is a primitive
this.isPrimitive = !this.isAny && !this.isArray && !this.isObject;
//
this.showToggle = this.schema.description || this.schema.title || this.isPrimitive && (this.schema.minimum || this.schema.maximum || this.schema.exclusiveMinimum || this.schema.exclusiveMaximum);
// populate isRequired property down to properties
if (this.schema && Array.isArray(this.schema.required)) {
this.schema.required.forEach(function (requiredProperty) {
if (typeof _this.schema.properties[requiredProperty] === 'object') {
_this.schema.properties[requiredProperty].isRequired = true;
}
});
}
}
/*
* Returns the template with populated properties.
* This template does not have the children
*/
_createClass(JSONSchemaView, [{
key: 'template',
value: function template() {
if (!this.schema) {
return '';
}
return ('\n <!-- Any -->\n ' + (0, _helpersJs._if)(this.isAny)(_templateObject, (0, _helpersJs._if)(this.showToggle)(_templateObject2, this.schema.title || ''), (0, _helpersJs._if)(this.schema.description && !this.isCollapsed)(_templateObject3, marked(this.schema.description || "")), (0, _helpersJs._if)(this.schema.required && !this.isCollapsed)(_templateObject4, this.schema.required), (0, _helpersJs._if)(this.schema['default'] && !this.isCollapsed)(_templateObject5, this.schema['default']), (0, _helpersJs._if)(this.schema.pattern && !this.isCollapsed)(_templateObject6, this.schema.pattern)) + '\n\n <!-- Primitive -->\n ' + (0, _helpersJs._if)(this.isPrimitive)(_templateObject7, (0, _helpersJs._if)(this.showToggle)(_templateObject2, this.schema.title || ''), this.schema.type, (0, _helpersJs._if)(!this.isCollapsed && this.schema.format)(_templateObject8, this.schema.format), (0, _helpersJs._if)(!this.isCollapsed && this.schema.minimum)(_templateObject9, this.schema.minimum), (0, _helpersJs._if)(!this.isCollapsed && this.schema.exclusiveMinimum)(_templateObject10, this.schema.exclusiveMinimum), (0, _helpersJs._if)(!this.isCollapsed && this.schema.maximum)(_templateObject11, this.schema.maximum), (0, _helpersJs._if)(!this.isCollapsed && this.schema.exclusiveMaximum)(_templateObject12, this.schema.exclusiveMaximum), (0, _helpersJs._if)(!this.isCollapsed && this.schema.minLength)(_templateObject13, this.schema.minLength), (0, _helpersJs._if)(!this.isCollapsed && this.schema.maxLength)(_templateObject14, this.schema.maxLength), (0, _helpersJs._if)(this.schema.description && !this.isCollapsed)(_templateObject3, marked(this.schema.description || "")), (0, _helpersJs._if)(this.schema.required && !this.isCollapsed)(_templateObject15), (0, _helpersJs._if)(this.schema['default'] && !this.isCollapsed)(_templateObject5, this.schema['default']), (0, _helpersJs._if)(this.schema.pattern && !this.isCollapsed)(_templateObject6, this.schema.pattern), (0, _helpersJs._if)(!this.isCollapsed && this.schema['enum'])(_templateObject16, this['enum'](this.schema, this.isCollapsed, this.open)), (0, _helpersJs._if)(this.schema.allOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'allOf')), (0, _helpersJs._if)(this.schema.oneOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'oneOf')), (0, _helpersJs._if)(this.schema.anyOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'anyOf'))) + '\n\n\n <!-- Array -->\n ' + (0, _helpersJs._if)(this.isArray)(_templateObject18, this.schema.title || '', (0, _helpersJs._if)(this.isCollapsed)(_templateObject19), (0, _helpersJs._if)(!this.isCollapsed && (this.schema.uniqueItems || this.schema.minItems || this.schema.maxItems))(_templateObject20, this.schema.minItems || 0, this.schema.maxItems || '∞', (0, _helpersJs._if)(!this.isCollapsed && this.schema.uniqueItems)(_templateObject21)), (0, _helpersJs._if)(!this.isCollapsed && this.schema.description)(_templateObject22, marked(this.schema.description || "")), (0, _helpersJs._if)(!this.isCollapsed && this.schema['enum'])(_templateObject16, this['enum'](this.schema, this.isCollapsed, this.open)), (0, _helpersJs._if)(this.schema.allOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'allOf')), (0, _helpersJs._if)(this.schema.oneOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'oneOf')), (0, _helpersJs._if)(this.schema.anyOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'anyOf')), (0, _helpersJs._if)(!this.isCollapsed)(_templateObject23)) + '\n\n <!-- Object -->\n ' + (0, _helpersJs._if)(!this.isPrimitive && !this.isArray && !this.isAny)(_templateObject24, this.schema.title || '', (0, _helpersJs._if)(this.isCollapsed)(_templateObject25), (0, _helpersJs._if)(!this.isCollapsed && this.schema.description)(_templateObject22, marked(this.schema.description || "")),
(0, _helpersJs._if)(this.schema.required && !this.isCollapsed && this.options.isBodyParam != true)(_templateObject26, this.schema.required),
(0, _helpersJs._if)(this.schema.required && !this.isCollapsed && this.options.isBodyParam == true)(_templateObject266, this.schema.required),
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
(0, _helpersJs._if)(this.schema['default'] && !this.isCollapsed)(_templateObject27, this.schema['default']),(0, _helpersJs._if)(!this.isCollapsed)(_templateObject29),
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
(0, _helpersJs._if)(!this.isCollapsed && this.schema.pattern)(_templateObject28, this.schema.pattern),
Web API: use a fixed version of the Qt5/cpp generator that does not create memory leaks
2018-02-12 12:20:27 -05:00
(0, _helpersJs._if)(!this.isCollapsed && this.schema['enum'])(_templateObject16, this['enum'](this.schema, this.isCollapsed, this.open)), (0, _helpersJs._if)(this.schema.allOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'allOf')), (0, _helpersJs._if)(this.schema.oneOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'oneOf')), (0, _helpersJs._if)(this.schema.anyOf && !this.isCollapsed)(_templateObject17, this.xOf(this.schema, 'anyOf'))) + '\n').replace(/\s*\n/g, '\n').replace(/(\<\!\-\-).+/g, '').trim();
Web API: send API documentation if path is invalid
2017-11-20 12:38:26 -05:00
}
/*
* Template for oneOf, anyOf and allOf
*/
}, {
key: 'xOf',
value: function xOf(schema, type) {
return '\n <div class="inner ' + type + '">\n <b>' + (0, _helpersJs.convertXOf)(type) + ':</b>\n </div>\n ';
}
/*
* Template for enums
*/
}, {
key: 'enum',
value: function _enum(schema, isCollapsed, open) {
return '\n ' + (0, _helpersJs._if)(!isCollapsed && schema['enum'])(_templateObject30) + '\n ';
}
/*
* Toggles the 'collapsed' state
*/
}, {
key: 'toggle',
value: function toggle() {
this.isCollapsed = !this.isCollapsed;
this.render();
}
/*
* Renders the element and returns it
*/
}, {
key: 'render',
value: function render() {
if (!this.element) {
this.element = document.createElement('div');
this.element.classList.add('json-schema-view');
}
if (this.isCollapsed) {
this.element.classList.add('collapsed');
} else {
this.element.classList.remove('collapsed');
}
if (this.options.theme) {
this.element.classList.add('json-schema-view-' + this.options.theme);
}
this.element.innerHTML = this.template();
if (!this.schema) {
return this.element;
}
if (!this.isCollapsed) {
this.appendChildren(this.element);
}
// add event listener for toggling
if (this.element.querySelector('a.title')) {
this.element.querySelector('a.title').addEventListener('click', this.toggle.bind(this));
}
return this.element;
}
/*
* Appends children to given element based on current schema
*/
}, {
key: 'appendChildren',
value: function appendChildren(element) {
var _this2 = this;
var inner = element.querySelector('.inner');
if (!inner) {
return;
}
if (this.schema['enum']) {
var tempDiv = document.createElement('span');;
tempDiv.classList.add('inner');
tempDiv.innerHTML = '<code>' + this.schema['enum'].join('</code>, <code>') + '</code>';
element.querySelector('.enums.inner').appendChild(tempDiv);
}
if (this.isArray) {
var view = new JSONSchemaView(this.schema.items, Infinity);
inner.appendChild(view.render());
}
if (typeof this.schema.properties === 'object') {
Object.keys(this.schema.properties).forEach(function (propertyName) {
var property = _this2.schema.properties[propertyName];
var tempDiv = document.createElement('div');;
tempDiv.innerHTML = '<div class="property">\n <span class="name">' + propertyName + ':</span>\n </div>';
var view = new JSONSchemaView(property, _this2.open - 1);
tempDiv.querySelector('.property').appendChild(view.render());
inner.appendChild(tempDiv.querySelector('.property'));
});
}
if (this.schema.allOf) {
appendXOf.call(this, 'allOf');
}
if (this.schema.oneOf) {
appendXOf.call(this, 'oneOf');
}
if (this.schema.anyOf) {
appendXOf.call(this, 'anyOf');
}
function appendXOf(type) {
var _this3 = this;
var innerAllOf = element.querySelector('.inner.' + type);
this.schema[type].forEach(function (schema) {
var inner = document.createElement('div');
inner.classList.add('inner');
var view = new JSONSchemaView(schema, _this3.open - 1);
inner.appendChild(view.render());
innerAllOf.appendChild(inner);
});
}
}
}]);
return JSONSchemaView;
})();
exports['default'] = JSONSchemaView;
module.exports = exports['default'];
},{"./helpers.js":1}]},{},[2])(2)
});
//# sourceMappingURL=data:application/json;charset:utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIm5vZGVfbW9kdWxlcy9icm93c2VyaWZ5L25vZGVfbW9kdWxlcy9icm93c2VyLXBhY2svX3ByZWx1ZGUuanMiLCJDOi9Vc2Vycy9qYW1lc2hpL0Rlc2t0b3AvanNvbi1zY2hlbWEtdmlldy1qcy1tYXN0ZXIvc3JjL2hlbHBlcnMuanMiLCJDOi9Vc2Vycy9qYW1lc2hpL0Rlc2t0b3AvanNvbi1zY2hlbWEtdmlldy1qcy1tYXN0ZXIvc3JjL2luZGV4LmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBO0FDQUEsWUFBWSxDQUFDOzs7Ozs7Ozs7O0FBSU4sU0FBUyxVQUFVLENBQUMsSUFBSSxFQUFFO0FBQy9CLFNBQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEdBQUcsS0FBSyxDQUFDO0NBQ3JDOzs7Ozs7Ozs7Ozs7O0FBWU0sU0FBUyxHQUFHLENBQUMsU0FBUyxFQUFFO0FBQzdCLFNBQU8sU0FBUyxHQUFHLE1BQU0sR0FBRyxLQUFLLENBQUM7Q0FDbkM7O0FBQ0QsU0FBUyxLQUFLLEdBQUU7QUFDZCxTQUFPLEVBQUUsQ0FBQztDQUNYO0FBQ0QsU0FBUyxNQUFNLENBQUUsUUFBUSxFQUFrQjtvQ0FBYixXQUFXO0FBQVgsZUFBVzs7O0FBQ3ZDLFNBQU8sUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsVUFBQyxXQUFXLEVBQUUsSUFBSSxFQUFFLENBQUMsRUFBSztBQUN4RCxXQUFPLFdBQVcsR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLEdBQUcsSUFBSSxDQUFDO0dBQzVDLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7Q0FDakI7OztBQzVCRCxZQUFZLENBQUM7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozt5QkFPTixjQUFjOzs7Ozs7OztJQVFBLGNBQWM7Ozs7Ozs7Ozs7OztBQVd0QixXQVhRLGNBQWMsQ0FXckIsTUFBTSxFQUFFLElBQUksRUFBMkI7OztRQUF6QixPQUFPLHlEQUFHLEVBQUMsS0FBSyxFQUFFLElBQUksRUFBQzs7MEJBWDlCLGNBQWM7O0FBWS9CLFFBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0FBQ3JCLFFBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDO0FBQ2pCLFFBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0FBQ3ZCLFFBQUksQ0FBQyxXQUFXLEdBQUcsSUFBSSxJQUFJLENBQUMsQ0FBQzs7O0FBRzdCLFFBQUksQ0FBQyxLQUFLLEdBQUcsT0FBTyxNQUFNLEtBQUssUUFBUSxJQUNyQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQ3RCLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FDbkIsTUFBTSxDQUFDLFVBQUEsQ0FBQzthQUFHLENBQUMsT0FBTyxFQUFFLGFBQWEsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUM7S0FBQSxDQUFDLENBQUMsTUFBTSxDQUFDOzs7QUFHakUsUUFBSSxDQUFDLE9BQU8sR0FBRyxDQUFDLElBQUksQ0FBQyxLQUFLLElBQUksSUFBSSxDQUFDLE1BQU0sSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksS0FBSyxPQUFPLENBQUM7O0FBRTFFLFFBQUksQ0FBQyxRQUFRLEdBQUcsSUFBSSxDQUFDLE1BQU0sS0FDeEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEtBQUssUUFBUSxJQUM3QixJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsSUFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLElBQ2pCLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxJQUNqQixJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQSxBQUFDLENBQUM7OztBQUd0QixRQUFJLENBQUMsV0FBVyxHQUFHLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDOzs7QUFHbEUsUUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLFdBQVcsSUFDdkMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLElBQ2hCLElBQUksQ0FBQyxXQUFXLEtBQ2YsSUFBSSxDQUFDLE1BQU0sQ0FBQyxPQUFPLElBQ25CLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxJQUNuQixJQUFJLENBQUMsTUFBTSxDQUFDLGdCQUFnQixJQUM1QixJQUFJLENBQUMsTUFBTSxDQUFDLGdCQUFnQixDQUFBLEFBQUMsQUFDOUIsQ0FBQzs7O0FBR0osUUFBSSxJQUFJLENBQUMsTUFBTSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsRUFBRTtBQUN0RCxVQUFJLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsVUFBQSxnQkFBZ0IsRUFBSTtBQUMvQyxZQUFJLE9BQU8sTUFBSyxNQUFNLENBQUMsVUFBVSxDQUFDLGdCQUFnQixDQUFDLEtBQUssUUFBUSxFQUFFO0FBQ2hFLGdCQUFLLE1BQU0sQ0FBQyxVQUFVLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxVQUFVLEdBQUcsSUFBSSxDQUFDO1NBQzVEO09BQ0YsQ0FBQyxDQUFDO0tBQ0o7R0FDRjs7Ozs7OztlQXREa0IsY0FBYzs7V0E0RHpCLG9CQUFHO0FBQ1QsVUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUU7QUFDaEIsZUFBTyxFQUFFLENBQUM7T0FDWDs7QUFFRCxhQUFPLGtDQUVILG9CQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsa0JBRVgsb0JBQUksSUFBSSxDQUFDLFVBQVUsQ0FBQyxtQkFDa0MsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLElBQUksRUFBRSxHQUs3RSxvQkFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLFdBQVcsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsbUJBQ2hCLElBQUksQ0FBQyxNQUFNLENBQUMsV0FBVyxHQUc5RCxvQkFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLFFBQVEsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsbUJBQ0EsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLEdBRWxFLG9CQUFJLElBQUksQ0FBQyxNQUFNLFdBQVEsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsbUJBQ0QsSUFBSSxDQUFDLE1BQU0sV0FBUSxHQUU5RCxvQkFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsbUJBQ0YsSUFBSSxDQUFDLE1BQU0sQ0FBQyxPQUFPLDhDQU03RCxvQkFBSSxJQUFJLENBQUMsV0FBVyxDQUFDLG1CQUVqQixvQkFBSSxJQUFJLEN
</script>
<script>
(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.$RefParser = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
/** !
* JSON Schema $Ref Parser v3.1.2
*
* @link https://github.com/BigstickCarpet/json-schema-ref-parser
* @license MIT
*/
"use strict";function bundle(e,r){debug("Bundling $ref pointers in %s",e.$refs._root$Ref.path);var t=[];crawl(e,"schema",e.$refs._root$Ref.path+"#","#",t,e.$refs,r),remap(t)}function crawl(e,r,t,f,n,i,a){var o=null===r?e:e[r];if(o&&"object"==typeof o)if($Ref.is$Ref(o))inventory$Ref(e,r,t,f,n,i,a);else{var l=Object.keys(o),u=l.indexOf("definitions");u>0&&l.splice(0,0,l.splice(u,1)[0]),l.forEach(function(e){var r=Pointer.join(t,e),l=Pointer.join(f,e),u=o[e];$Ref.is$Ref(u)?inventory$Ref(o,e,t,l,n,i,a):crawl(o,e,r,l,n,i,a)})}}function inventory$Ref(e,r,t,f,n,i,a){if(!n.some(function(t){return t.parent===e&&t.key===r})){var o=null===r?e:e[r],l=url.resolve(t,o.$ref),u=i._resolve(l,a),h=Pointer.parse(f).length,s=url.stripHash(u.path),$=url.getHash(u.path),c=s!==i._root$Ref.path,p=$Ref.isExtended$Ref(o);n.push({$ref:o,parent:e,key:r,pathFromRoot:f,depth:h,file:s,hash:$,value:u.value,circular:u.circular,extended:p,external:c}),crawl(u.value,null,u.path,f,n,i,a)}}function remap(e){e.sort(function(e,r){return e.file!==r.file?e.file<r.file?-1:1:e.hash!==r.hash?e.hash<r.hash?-1:1:e.circular!==r.circular?e.circular?-1:1:e.extended!==r.extended?e.extended?1:-1:e.depth!==r.depth?e.depth-r.depth:r.pathFromRoot.lastIndexOf("/definitions")-e.pathFromRoot.lastIndexOf("/definitions")});var r,t,f;e.forEach(function(e){debug('Re-mapping $ref pointer "%s" at %s',e.$ref.$ref,e.pathFromRoot),e.external?e.file===r&&e.hash===t?e.$ref.$ref=f:e.file===r&&0===e.hash.indexOf(t+"/")?e.$ref.$ref=Pointer.join(f,Pointer.parse(e.hash)):(r=e.file,t=e.hash,f=e.pathFromRoot,e.$ref=e.parent[e.key]=$Ref.dereference(e.$ref,e.value),e.circular&&(e.$ref.$ref=e.pathFromRoot)):e.$ref.$ref=e.hash,debug(" new value: %s",e.$ref&&e.$ref.$ref?e.$ref.$ref:"[object Object]")})}var $Ref=require("./ref"),Pointer=require("./pointer"),debug=require("./util/debug"),url=require("./util/url");module.exports=bundle;
},{"./pointer":10,"./ref":11,"./util/debug":16,"./util/url":19}],2:[function(require,module,exports){
"use strict";function dereference(e,r){debug("Dereferencing $ref pointers in %s",e.$refs._root$Ref.path);var c=crawl(e.schema,e.$refs._root$Ref.path,"#",[],e.$refs,r);e.$refs.circular=c.circular,e.schema=c.value}function crawl(e,r,c,u,f,i){var n,a={value:e,circular:!1};return e&&"object"==typeof e&&(u.push(e),$Ref.isAllowed$Ref(e,i)?(n=dereference$Ref(e,r,c,u,f,i),a.circular=n.circular,a.value=n.value):Object.keys(e).forEach(function(l){var o=Pointer.join(r,l),t=Pointer.join(c,l),d=e[l],$=!1;$Ref.isAllowed$Ref(d,i)?(n=dereference$Ref(d,o,t,u,f,i),$=n.circular,e[l]=n.value):-1===u.indexOf(d)?(n=crawl(d,o,t,u,f,i),$=n.circular,e[l]=n.value):$=foundCircularReference(o,f,i),a.circular=a.circular||$}),u.pop()),a}function dereference$Ref(e,r,c,u,f,i){debug('Dereferencing $ref pointer "%s" at %s',e.$ref,r);var n=url.resolve(r,e.$ref),a=f._resolve(n,i),l=a.circular,o=l||-1!==u.indexOf(a.value);o&&foundCircularReference(r,f,i);var t=$Ref.dereference(e,a.value);if(!o){var d=crawl(t,a.path,c,u,f,i);o=d.circular,t=d.value}return o&&!l&&"ignore"===i.dereference.circular&&(t=e),l&&(t.$ref=c),{circular:o,value:t}}function foundCircularReference(e,r,c){if(r.circular=!0,!c.dereference.circular)throw ono.reference("Circular $ref pointer found at %s",e);return!0}var $Ref=require("./ref"),Pointer=require("./pointer"),ono=require("ono"),debug=require("./util/debug"),url=require("./util/url");module.exports=dereference;
},{"./pointer":10,"./ref":11,"./util/debug":16,"./util/url":19,"ono":69}],3:[function(require,module,exports){
(function (Buffer){
"use strict";function $RefParser(){this.schema=null,this.$refs=new $Refs}function normalizeArgs(e){var r,t,a,s;return e=Array.prototype.slice.call(e),"function"==typeof e[e.length-1]&&(s=e.pop()),"string"==typeof e[0]?(r=e[0],"object"==typeof e[2]?(t=e[1],a=e[2]):(t=void 0,a=e[1])):(r="",t=e[0],a=e[1]),a instanceof Options||(a=new Options(a)),{path:r,schema:t,options:a,callback:s}}var Promise=require("./util/promise"),Options=require("./options"),$Refs=require("./refs"),parse=require("./parse"),resolveExternal=require("./resolve-external"),bundle=require("./bundle"),dereference=require("./dereference"),url=require("./util/url"),maybe=require("call-me-maybe"),ono=require("ono");module.exports=$RefParser,module.exports.YAML=require("./util/yaml"),$RefParser.parse=function(e,r,t){var a=this,s=new a;return s.parse.apply(s,arguments)},$RefParser.prototype.parse=function(e,r,t){var a,s=normalizeArgs(arguments);if(!s.path&&!s.schema){var n=ono("Expected a file path, URL, or object. Got %s",s.path||s.schema);return maybe(s.callback,Promise.reject(n))}this.schema=null,this.$refs=new $Refs,url.isFileSystemPath(s.path)&&(s.path=url.fromFileSystemPath(s.path)),s.path=url.resolve(url.cwd(),s.path),s.schema&&"object"==typeof s.schema?(this.$refs._add(s.path,s.schema),a=Promise.resolve(s.schema)):a=parse(s.path,this.$refs,s.options);var o=this;return a.then(function(e){if(!e||"object"!=typeof e||Buffer.isBuffer(e))throw ono.syntax('"%s" is not a valid JSON Schema',o.$refs._root$Ref.path||e);return o.schema=e,maybe(s.callback,Promise.resolve(o.schema))})["catch"](function(e){return maybe(s.callback,Promise.reject(e))})},$RefParser.resolve=function(e,r,t){var a=this,s=new a;return s.resolve.apply(s,arguments)},$RefParser.prototype.resolve=function(e,r,t){var a=this,s=normalizeArgs(arguments);return this.parse(s.path,s.schema,s.options).then(function(){return resolveExternal(a,s.options)}).then(function(){return maybe(s.callback,Promise.resolve(a.$refs))})["catch"](function(e){return maybe(s.callback,Promise.reject(e))})},$RefParser.bundle=function(e,r,t){var a=this,s=new a;return s.bundle.apply(s,arguments)},$RefParser.prototype.bundle=function(e,r,t){var a=this,s=normalizeArgs(arguments);return this.resolve(s.path,s.schema,s.options).then(function(){return bundle(a,s.options),maybe(s.callback,Promise.resolve(a.schema))})["catch"](function(e){return maybe(s.callback,Promise.reject(e))})},$RefParser.dereference=function(e,r,t){var a=this,s=new a;return s.dereference.apply(s,arguments)},$RefParser.prototype.dereference=function(e,r,t){var a=this,s=normalizeArgs(arguments);return this.resolve(s.path,s.schema,s.options).then(function(){return dereference(a,s.options),maybe(s.callback,Promise.resolve(a.schema))})["catch"](function(e){return maybe(s.callback,Promise.reject(e))})};
}).call(this,{"isBuffer":require("../node_modules/is-buffer/index.js")})
},{"../node_modules/is-buffer/index.js":36,"./bundle":1,"./dereference":2,"./options":4,"./parse":5,"./refs":12,"./resolve-external":13,"./util/promise":18,"./util/url":19,"./util/yaml":20,"call-me-maybe":27,"ono":69}],4:[function(require,module,exports){
"use strict";function $RefParserOptions(e){merge(this,$RefParserOptions.defaults),merge(this,e)}function merge(e,r){if(isMergeable(r))for(var s=Object.keys(r),a=0;a<s.length;a++){var t=s[a],i=r[t],o=e[t];isMergeable(i)?e[t]=merge(o||{},i):void 0!==i&&(e[t]=i)}return e}function isMergeable(e){return e&&"object"==typeof e&&!Array.isArray(e)&&!(e instanceof RegExp)&&!(e instanceof Date)}var jsonParser=require("./parsers/json"),yamlParser=require("./parsers/yaml"),textParser=require("./parsers/text"),binaryParser=require("./parsers/binary"),fileResolver=require("./resolvers/file"),httpResolver=require("./resolvers/http"),zschemaValidator=require("./validators/z-schema");module.exports=$RefParserOptions,$RefParserOptions.defaults={parse:{json:jsonParser,yaml:yamlParser,text:textParser,binary:binaryParser},resolve:{file:fileResolver,http:httpResolver,external:!0},dereference:{circular:!0},validate:{zschema:zschemaValidator}};
},{"./parsers/binary":6,"./parsers/json":7,"./parsers/text":8,"./parsers/yaml":9,"./resolvers/file":14,"./resolvers/http":15,"./validators/z-schema":21}],5:[function(require,module,exports){
(function (Buffer){
"use strict";function parse(r,e,n){try{r=url.stripHash(r);var t=e._add(r),u={url:r,extension:url.getExtension(r)};return readFile(u,n).then(function(r){return t.pathType=r.plugin.name,u.data=r.result,parseFile(u,n)}).then(function(r){return t.value=r.result,r.result})}catch(i){return Promise.reject(i)}}function readFile(r,e){return new Promise(function(n,t){function u(e){t(!e||e instanceof SyntaxError?ono.syntax('Unable to resolve $ref pointer "%s"',r.url):e)}debug("Reading %s",r.url);var i=plugins.all(e.resolve);i=plugins.filter(i,"canRead",r),plugins.sort(i),plugins.run(i,"read",r).then(n,u)})}function parseFile(r,e){return new Promise(function(n,t){function u(e){!e.plugin.allowEmpty&&isEmpty(e.result)?t(ono.syntax('Error parsing "%s" as %s. \nParsed value is empty',r.url,e.plugin.name)):n(e)}function i(e){e?(e=e instanceof Error?e:new Error(e),t(ono.syntax(e,"Error parsing %s",r.url))):t(ono.syntax("Unable to parse %s",r.url))}debug("Parsing %s",r.url);var s=plugins.all(e.parse),l=plugins.filter(s,"canParse",r),o=l.length>0?l:s;plugins.sort(o),plugins.run(o,"parse",r).then(u,i)})}function isEmpty(r){return void 0===r||"object"==typeof r&&0===Object.keys(r).length||"string"==typeof r&&0===r.trim().length||Buffer.isBuffer(r)&&0===r.length}var ono=require("ono"),debug=require("./util/debug"),url=require("./util/url"),plugins=require("./util/plugins"),Promise=require("./util/promise");module.exports=parse;
}).call(this,{"isBuffer":require("../node_modules/is-buffer/index.js")})
},{"../node_modules/is-buffer/index.js":36,"./util/debug":16,"./util/plugins":17,"./util/promise":18,"./util/url":19,"ono":69}],6:[function(require,module,exports){
(function (Buffer){
"use strict";var BINARY_REGEXP=/\.(jpeg|jpg|gif|png|bmp|ico)$/i;module.exports={order:400,allowEmpty:!0,canParse:function(r){return Buffer.isBuffer(r.data)&&BINARY_REGEXP.test(r.url)},parse:function(r){return Buffer.isBuffer(r.data)?r.data:new Buffer(r.data)}};
}).call(this,require("buffer").Buffer)
},{"buffer":25}],7:[function(require,module,exports){
(function (Buffer){
"use strict";var Promise=require("../util/promise");module.exports={order:100,allowEmpty:!0,canParse:".json",parse:function(r){return new Promise(function(e,t){var i=r.data;Buffer.isBuffer(i)&&(i=i.toString()),e("string"==typeof i?0===i.trim().length?void 0:JSON.parse(i):i)})}};
}).call(this,{"isBuffer":require("../../node_modules/is-buffer/index.js")})
},{"../../node_modules/is-buffer/index.js":36,"../util/promise":18}],8:[function(require,module,exports){
(function (Buffer){
"use strict";var TEXT_REGEXP=/\.(txt|htm|html|md|xml|js|min|map|css|scss|less|svg)$/i;module.exports={order:300,allowEmpty:!0,encoding:"utf8",canParse:function(t){return("string"==typeof t.data||Buffer.isBuffer(t.data))&&TEXT_REGEXP.test(t.url)},parse:function(t){if("string"==typeof t.data)return t.data;if(Buffer.isBuffer(t.data))return t.data.toString(this.encoding);throw new Error("data is not text")}};
}).call(this,{"isBuffer":require("../../node_modules/is-buffer/index.js")})
},{"../../node_modules/is-buffer/index.js":36}],9:[function(require,module,exports){
(function (Buffer){
"use strict";var Promise=require("../util/promise"),YAML=require("../util/yaml");module.exports={order:200,allowEmpty:!0,canParse:[".yaml",".yml",".json"],parse:function(r){return new Promise(function(e,t){var i=r.data;Buffer.isBuffer(i)&&(i=i.toString()),e("string"==typeof i?YAML.parse(i):i)})}};
}).call(this,{"isBuffer":require("../../node_modules/is-buffer/index.js")})
},{"../../node_modules/is-buffer/index.js":36,"../util/promise":18,"../util/yaml":20}],10:[function(require,module,exports){
"use strict";function Pointer(e,r){this.$ref=e,this.path=r,this.value=void 0,this.circular=!1}function resolveIf$Ref(e,r){if($Ref.isAllowed$Ref(e.value,r)){var t=url.resolve(e.path,e.value.$ref);if(t!==e.path){var s=e.$ref.$refs._resolve(t,r);return $Ref.isExtended$Ref(e.value)?e.value=$Ref.dereference(e.value,s.value):(e.$ref=s.$ref,e.path=s.path,e.value=s.value),!0}e.circular=!0}}function setValue(e,r,t){if(!e.value||"object"!=typeof e.value)throw ono.syntax('Error assigning $ref pointer "%s". \nCannot set "%s" of a non-object.',e.path,r);return"-"===r&&Array.isArray(e.value)?e.value.push(t):e.value[r]=t,t}module.exports=Pointer;var $Ref=require("./ref"),url=require("./util/url"),ono=require("ono"),slashes=/\//g,tildes=/~/g,escapedSlash=/~1/g,escapedTilde=/~0/g;Pointer.prototype.resolve=function(e,r){var t=Pointer.parse(this.path);this.value=e;for(var s=0;s<t.length;s++){resolveIf$Ref(this,r)&&(this.path=Pointer.join(this.path,t.slice(s)));var i=t[s];if(void 0===this.value[i])throw ono.syntax('Error resolving $ref pointer "%s". \nToken "%s" does not exist.',this.path,i);this.value=this.value[i]}return resolveIf$Ref(this,r),this},Pointer.prototype.set=function(e,r,t){var s,i=Pointer.parse(this.path);if(0===i.length)return this.value=r,r;this.value=e;for(var a=0;a<i.length-1;a++)resolveIf$Ref(this,t),s=i[a],this.value&&void 0!==this.value[s]?this.value=this.value[s]:this.value=setValue(this,s,{});return resolveIf$Ref(this,t),s=i[i.length-1],setValue(this,s,r),e},Pointer.parse=function(e){var r=url.getHash(e).substr(1);if(!r)return[];r=r.split("/");for(var t=0;t<r.length;t++)r[t]=decodeURI(r[t].replace(escapedSlash,"/").replace(escapedTilde,"~"));if(""!==r[0])throw ono.syntax('Invalid $ref pointer "%s". Pointers must begin with "#/"',r);return r.slice(1)},Pointer.join=function(e,r){-1===e.indexOf("#")&&(e+="#"),r=Array.isArray(r)?r:[r];for(var t=0;t<r.length;t++){var s=r[t];e+="/"+encodeURI(s.replace(tildes,"~0").replace(slashes,"~1"))}return e};
},{"./ref":11,"./util/url":19,"ono":69}],11:[function(require,module,exports){
"use strict";function $Ref(){this.path=void 0,this.value=void 0,this.$refs=void 0,this.pathType=void 0}module.exports=$Ref;var Pointer=require("./pointer");$Ref.prototype.exists=function(e,t){try{return this.resolve(e,t),!0}catch(r){return!1}},$Ref.prototype.get=function(e,t){return this.resolve(e,t).value},$Ref.prototype.resolve=function(e,t){var r=new Pointer(this,e);return r.resolve(this.value,t)},$Ref.prototype.set=function(e,t){var r=new Pointer(this,e);this.value=r.set(this.value,t)},$Ref.is$Ref=function(e){return e&&"object"==typeof e&&"string"==typeof e.$ref&&e.$ref.length>0},$Ref.isExternal$Ref=function(e){return $Ref.is$Ref(e)&&"#"!==e.$ref[0]},$Ref.isAllowed$Ref=function(e,t){return!$Ref.is$Ref(e)||"#"!==e.$ref[0]&&t&&!t.resolve.external?void 0:!0},$Ref.isExtended$Ref=function(e){return $Ref.is$Ref(e)&&Object.keys(e).length>1},$Ref.dereference=function(e,t){if(t&&"object"==typeof t&&$Ref.isExtended$Ref(e)){var r={};return Object.keys(e).forEach(function(t){"$ref"!==t&&(r[t]=e[t])}),Object.keys(t).forEach(function(e){e in r||(r[e]=t[e])}),r}return t};
},{"./pointer":10}],12:[function(require,module,exports){
"use strict";function $Refs(){this.circular=!1,this._$refs={},this._root$Ref=null}function getPaths(e,r){var t=Object.keys(e);return r=Array.isArray(r[0])?r[0]:Array.prototype.slice.call(r),r.length>0&&r[0]&&(t=t.filter(function(t){return-1!==r.indexOf(e[t].pathType)})),t.map(function(r){return{encoded:r,decoded:"file"===e[r].pathType?url.toFileSystemPath(r,!0):r}})}var ono=require("ono"),$Ref=require("./ref"),url=require("./util/url");module.exports=$Refs,$Refs.prototype.paths=function(e){var r=getPaths(this._$refs,arguments);return r.map(function(e){return e.decoded})},$Refs.prototype.values=function(e){var r=this._$refs,t=getPaths(r,arguments);return t.reduce(function(e,t){return e[t.decoded]=r[t.encoded].value,e},{})},$Refs.prototype.toJSON=$Refs.prototype.values,$Refs.prototype.exists=function(e,r){try{return this._resolve(e,r),!0}catch(t){return!1}},$Refs.prototype.get=function(e,r){return this._resolve(e,r).value},$Refs.prototype.set=function(e,r){e=url.resolve(this._root$Ref.path,e);var t=url.stripHash(e),o=this._$refs[t];if(!o)throw ono('Error resolving $ref pointer "%s". \n"%s" not found.',e,t);o.set(e,r)},$Refs.prototype._add=function(e,r){var t=url.stripHash(e),o=new $Ref;return o.path=t,o.value=r,o.$refs=this,this._$refs[t]=o,this._root$Ref=this._root$Ref||o,o},$Refs.prototype._resolve=function(e,r){e=url.resolve(this._root$Ref.path,e);var t=url.stripHash(e),o=this._$refs[t];if(!o)throw ono('Error resolving $ref pointer "%s". \n"%s" not found.',e,t);return o.resolve(e,r)},$Refs.prototype._get$Ref=function(e){e=url.resolve(this._root$Ref.path,e);var r=url.stripHash(e);return this._$refs[r]};
},{"./ref":11,"./util/url":19,"ono":69}],13:[function(require,module,exports){
"use strict";function resolveExternal(e,r){if(!r.resolve.external)return Promise.resolve();try{debug("Resolving $ref pointers in %s",e.$refs._root$Ref.path);var s=crawl(e.schema,e.$refs._root$Ref.path+"#",e.$refs,r);return Promise.all(s)}catch(t){return Promise.reject(t)}}function crawl(e,r,s,t){var o=[];return e&&"object"==typeof e&&($Ref.isExternal$Ref(e)?o.push(resolve$Ref(e,r,s,t)):Object.keys(e).forEach(function(i){var n=Pointer.join(r,i),l=e[i];$Ref.isExternal$Ref(l)?o.push(resolve$Ref(l,n,s,t)):o=o.concat(crawl(l,n,s,t))})),o}function resolve$Ref(e,r,s,t){debug('Resolving $ref pointer "%s" at %s',e.$ref,r);var o=url.resolve(r,e.$ref),i=url.stripHash(o);return e=s._$refs[i],e?Promise.resolve(e.value):parse(o,s,t).then(function(e){debug("Resolving $ref pointers in %s",i);var r=crawl(e,i+"#",s,t);return Promise.all(r)})}var Promise=require("./util/promise"),$Ref=require("./ref"),Pointer=require("./pointer"),parse=require("./parse"),debug=require("./util/debug"),url=require("./util/url");module.exports=resolveExternal;
},{"./parse":5,"./pointer":10,"./ref":11,"./util/debug":16,"./util/promise":18,"./util/url":19}],14:[function(require,module,exports){
"use strict";var fs=require("fs"),ono=require("ono"),Promise=require("../util/promise"),url=require("../util/url"),debug=require("../util/debug");module.exports={order:100,canRead:function(r){return url.isFileSystemPath(r.url)},read:function(r){return new Promise(function(e,i){var u;try{u=url.toFileSystemPath(r.url)}catch(o){i(ono.uri(o,"Malformed URI: %s",r.url))}debug("Opening file: %s",u);try{fs.readFile(u,function(r,o){r?i(ono(r,'Error opening file "%s"',u)):e(o)})}catch(o){i(ono(o,'Error opening file "%s"',u))}})}};
},{"../util/debug":16,"../util/promise":18,"../util/url":19,"fs":24,"ono":69}],15:[function(require,module,exports){
(function (process,Buffer){
"use strict";function download(e,t,o){return new Promise(function(r,n){e=url.parse(e),o=o||[],o.push(e.href),get(e,t).then(function(s){if(s.statusCode>=400)throw ono({status:s.statusCode},"HTTP ERROR %d",s.statusCode);if(s.statusCode>=300)if(o.length>t.redirects)n(ono({status:s.statusCode},"Error downloading %s. \nToo many redirects: \n %s",o[0],o.join(" \n ")));else{if(!s.headers.location)throw ono({status:s.statusCode},"HTTP %d redirect with no location header",s.statusCode);debug("HTTP %d redirect %s -> %s",s.statusCode,e.href,s.headers.location);var u=url.resolve(e,s.headers.location);download(u,t,o).then(r,n)}else r(s.body||new Buffer(0))})["catch"](function(t){n(ono(t,"Error downloading",e.href))})})}function get(e,t){return new Promise(function(o,r){debug("GET",e.href);var n="https:"===e.protocol?https:http,s=n.get({hostname:e.hostname,port:e.port,path:e.path,auth:e.auth,headers:t.headers||{},withCredentials:t.withCredentials});"function"==typeof s.setTimeout&&s.setTimeout(t.timeout),s.on("timeout",function(){s.abort()}),s.on("error",r),s.once("response",function(e){e.body=new Buffer(0),e.on("data",function(t){e.body=Buffer.concat([e.body,new Buffer(t)])}),e.on("error",r),e.on("end",function(){o(e)})})})}var http=require("http"),https=require("https"),ono=require("ono"),url=require("../util/url"),debug=require("../util/debug"),Promise=require("../util/promise");module.exports={order:200,headers:null,timeout:5e3,redirects:5,withCredentials:!1,canRead:function(e){return url.isHttp(e.url)},read:function(e){var t=url.parse(e.url);return process.browser&&!t.protocol&&(t.protocol=url.parse(location.href).protocol),download(t,this)}};
}).call(this,require('_process'),require("buffer").Buffer)
},{"../util/debug":16,"../util/promise":18,"../util/url":19,"_process":71,"buffer":25,"http":87,"https":33,"ono":69}],16:[function(require,module,exports){
"use strict";var debug=require("debug");module.exports=debug("json-schema-ref-parser");
},{"debug":29}],17:[function(require,module,exports){
"use strict";function getResult(e,r,t,n){var u=e[r];if("function"==typeof u)return u.apply(e,[t,n]);if(!n){if(u instanceof RegExp)return u.test(t.url);if("string"==typeof u)return u===t.extension;if(Array.isArray(u))return-1!==u.indexOf(t.extension)}return u}var Promise=require("./promise"),debug=require("./debug");exports.all=function(e){return Object.keys(e).filter(function(r){return"object"==typeof e[r]}).map(function(r){return e[r].name=r,e[r]})},exports.filter=function(e,r,t){return e.filter(function(e){return!!getResult(e,r,t)})},exports.sort=function(e){return e.forEach(function(e){e.order=e.order||Number.MAX_SAFE_INTEGER}),e.sort(function(e,r){return e.order-r.order})},exports.run=function(e,r,t){var n,u,i=0;return new Promise(function(o,f){function s(){if(n=e[i++],!n)return f(u);try{debug(" %s",n.name);var o=getResult(n,r,t,c);o&&"function"==typeof o.then?o.then(a,p):void 0!==o&&a(o)}catch(s){p(s)}}function c(e,r){e?p(e):a(r)}function a(e){debug(" success"),o({plugin:n,result:e})}function p(e){debug(" %s",e.message||e),u=e,s()}s()})};
},{"./debug":16,"./promise":18}],18:[function(require,module,exports){
"use strict";module.exports="function"==typeof Promise?Promise:require("es6-promise").Promise;
},{"es6-promise":31}],19:[function(require,module,exports){
(function (process){
"use strict";var isWindows=/^win/.test(process.platform),forwardSlashPattern=/\//g,protocolPattern=/^([a-z0-9.+-]+):\/\//i,url=module.exports,urlEncodePatterns=[/\?/g,"%3F",/\#/g,"%23",isWindows?/\\/g:/\//,"/"],urlDecodePatterns=[/\%23/g,"#",/\%24/g,"$",/\%26/g,"&",/\%2C/g,",",/\%40/g,"@"];exports.parse=require("url").parse,exports.resolve=require("url").resolve,exports.cwd=function(){return process.browser?location.href:process.cwd()+"/"},exports.getProtocol=function(r){var e=protocolPattern.exec(r);return e?e[1].toLowerCase():void 0},exports.getExtension=function(r){var e=r.lastIndexOf(".");return e>=0?r.substr(e).toLowerCase():""},exports.getHash=function(r){var e=r.indexOf("#");return e>=0?r.substr(e):"#"},exports.stripHash=function(r){var e=r.indexOf("#");return e>=0&&(r=r.substr(0,e)),r},exports.isHttp=function(r){var e=url.getProtocol(r);return"http"===e||"https"===e?!0:void 0===e?process.browser:!1},exports.isFileSystemPath=function(r){if(process.browser)return!1;var e=url.getProtocol(r);return void 0===e||"file"===e},exports.fromFileSystemPath=function(r){for(var e=0;e<urlEncodePatterns.length;e+=2)r=r.replace(urlEncodePatterns[e],urlEncodePatterns[e+1]);return encodeURI(r)},exports.toFileSystemPath=function(r,e){r=decodeURI(r);for(var t=0;t<urlDecodePatterns.length;t+=2)r=r.replace(urlDecodePatterns[t],urlDecodePatterns[t+1]);var o="file://"===r.substr(0,7).toLowerCase();return o&&(r="/"===r[7]?r.substr(8):r.substr(7),isWindows&&"/"===r[1]&&(r=r[0]+":"+r.substr(1)),e?r="file:///"+r:(o=!1,r=isWindows?r:"/"+r)),isWindows&&!o&&(r=r.replace(forwardSlashPattern,"\\")),r};
}).call(this,require('_process'))
},{"_process":71,"url":93}],20:[function(require,module,exports){
"use strict";var yaml=require("js-yaml"),ono=require("ono");module.exports={parse:function(r,e){try{return yaml.safeLoad(r)}catch(o){throw o instanceof Error?o:ono(o,o.message)}},stringify:function(r,e,o){try{var t=("string"==typeof o?o.length:o)||2;return yaml.safeDump(r,{indent:t})}catch(n){throw n instanceof Error?n:ono(n,n.message)}}};
},{"js-yaml":38,"ono":69}],21:[function(require,module,exports){
"use strict";module.exports={order:100,canValidate:function(e){return!!e.resolved},validate:function(e){}};
},{}],22:[function(require,module,exports){
var lookup="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";!function(t){"use strict";function r(t){var r=t.charCodeAt(0);return r===h||r===u?62:r===c||r===f?63:o>r?-1:o+10>r?r-o+26+26:i+26>r?r-i:A+26>r?r-A+26:void 0}function e(t){function e(t){i[f++]=t}var n,h,c,o,A,i;if(t.length%4>0)throw new Error("Invalid string. Length must be a multiple of 4");var u=t.length;A="="===t.charAt(u-2)?2:"="===t.charAt(u-1)?1:0,i=new a(3*t.length/4-A),c=A>0?t.length-4:t.length;var f=0;for(n=0,h=0;c>n;n+=4,h+=3)o=r(t.charAt(n))<<18|r(t.charAt(n+1))<<12|r(t.charAt(n+2))<<6|r(t.charAt(n+3)),e((16711680&o)>>16),e((65280&o)>>8),e(255&o);return 2===A?(o=r(t.charAt(n))<<2|r(t.charAt(n+1))>>4,e(255&o)):1===A&&(o=r(t.charAt(n))<<10|r(t.charAt(n+1))<<4|r(t.charAt(n+2))>>2,e(o>>8&255),e(255&o)),i}function n(t){function r(t){return lookup.charAt(t)}function e(t){return r(t>>18&63)+r(t>>12&63)+r(t>>6&63)+r(63&t)}var n,a,h,c=t.length%3,o="";for(n=0,h=t.length-c;h>n;n+=3)a=(t[n]<<16)+(t[n+1]<<8)+t[n+2],o+=e(a);switch(c){case 1:a=t[t.length-1],o+=r(a>>2),o+=r(a<<4&63),o+="==";break;case 2:a=(t[t.length-2]<<8)+t[t.length-1],o+=r(a>>10),o+=r(a>>4&63),o+=r(a<<2&63),o+="="}return o}var a="undefined"!=typeof Uint8Array?Uint8Array:Array,h="+".charCodeAt(0),c="/".charCodeAt(0),o="0".charCodeAt(0),A="a".charCodeAt(0),i="A".charCodeAt(0),u="-".charCodeAt(0),f="_".charCodeAt(0);t.toByteArray=e,t.fromByteArray=n}("undefined"==typeof exports?this.base64js={}:exports);
},{}],23:[function(require,module,exports){
},{}],24:[function(require,module,exports){
},{}],25:[function(require,module,exports){
(function (global){
/*!
* The buffer module from node.js, for the browser.
*
* @author Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
* @license MIT
*/
"use strict";function typedArraySupport(){function t(){}try{var e=new Uint8Array(1);return e.foo=function(){return 42},e.constructor=t,42===e.foo()&&e.constructor===t&&"function"==typeof e.subarray&&0===e.subarray(1,1).byteLength}catch(r){return!1}}function kMaxLength(){return Buffer.TYPED_ARRAY_SUPPORT?2147483647:1073741823}function Buffer(t){return this instanceof Buffer?(Buffer.TYPED_ARRAY_SUPPORT||(this.length=0,this.parent=void 0),"number"==typeof t?fromNumber(this,t):"string"==typeof t?fromString(this,t,arguments.length>1?arguments[1]:"utf8"):fromObject(this,t)):arguments.length>1?new Buffer(t,arguments[1]):new Buffer(t)}function fromNumber(t,e){if(t=allocate(t,0>e?0:0|checked(e)),!Buffer.TYPED_ARRAY_SUPPORT)for(var r=0;e>r;r++)t[r]=0;return t}function fromString(t,e,r){"string"==typeof r&&""!==r||(r="utf8");var n=0|byteLength(e,r);return t=allocate(t,n),t.write(e,r),t}function fromObject(t,e){if(Buffer.isBuffer(e))return fromBuffer(t,e);if(isArray(e))return fromArray(t,e);if(null==e)throw new TypeError("must start with number, buffer, array or string");if("undefined"!=typeof ArrayBuffer){if(e.buffer instanceof ArrayBuffer)return fromTypedArray(t,e);if(e instanceof ArrayBuffer)return fromArrayBuffer(t,e)}return e.length?fromArrayLike(t,e):fromJsonObject(t,e)}function fromBuffer(t,e){var r=0|checked(e.length);return t=allocate(t,r),e.copy(t,0,0,r),t}function fromArray(t,e){var r=0|checked(e.length);t=allocate(t,r);for(var n=0;r>n;n+=1)t[n]=255&e[n];return t}function fromTypedArray(t,e){var r=0|checked(e.length);t=allocate(t,r);for(var n=0;r>n;n+=1)t[n]=255&e[n];return t}function fromArrayBuffer(t,e){return Buffer.TYPED_ARRAY_SUPPORT?(e.byteLength,t=Buffer._augment(new Uint8Array(e))):t=fromTypedArray(t,new Uint8Array(e)),t}function fromArrayLike(t,e){var r=0|checked(e.length);t=allocate(t,r);for(var n=0;r>n;n+=1)t[n]=255&e[n];return t}function fromJsonObject(t,e){var r,n=0;"Buffer"===e.type&&isArray(e.data)&&(r=e.data,n=0|checked(r.length)),t=allocate(t,n);for(var f=0;n>f;f+=1)t[f]=255&r[f];return t}function allocate(t,e){Buffer.TYPED_ARRAY_SUPPORT?(t=Buffer._augment(new Uint8Array(e)),t.__proto__=Buffer.prototype):(t.length=e,t._isBuffer=!0);var r=0!==e&&e<=Buffer.poolSize>>>1;return r&&(t.parent=rootParent),t}function checked(t){if(t>=kMaxLength())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+kMaxLength().toString(16)+" bytes");return 0|t}function SlowBuffer(t,e){if(!(this instanceof SlowBuffer))return new SlowBuffer(t,e);var r=new Buffer(t,e);return delete r.parent,r}function byteLength(t,e){"string"!=typeof t&&(t=""+t);var r=t.length;if(0===r)return 0;for(var n=!1;;)switch(e){case"ascii":case"binary":case"raw":case"raws":return r;case"utf8":case"utf-8":return utf8ToBytes(t).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*r;case"hex":return r>>>1;case"base64":return base64ToBytes(t).length;default:if(n)return utf8ToBytes(t).length;e=(""+e).toLowerCase(),n=!0}}function slowToString(t,e,r){var n=!1;if(e=0|e,r=void 0===r||r===1/0?this.length:0|r,t||(t="utf8"),0>e&&(e=0),r>this.length&&(r=this.length),e>=r)return"";for(;;)switch(t){case"hex":return hexSlice(this,e,r);case"utf8":case"utf-8":return utf8Slice(this,e,r);case"ascii":return asciiSlice(this,e,r);case"binary":return binarySlice(this,e,r);case"base64":return base64Slice(this,e,r);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return utf16leSlice(this,e,r);default:if(n)throw new TypeError("Unknown encoding: "+t);t=(t+"").toLowerCase(),n=!0}}function hexWrite(t,e,r,n){r=Number(r)||0;var f=t.length-r;n?(n=Number(n),n>f&&(n=f)):n=f;var i=e.length;if(i%2!==0)throw new Error("Invalid hex string");n>i/2&&(n=i/2);for(var o=0;n>o;o++){var u=parseInt(e.substr(2*o,2),16);if(isNaN(u))throw new Error("Invalid hex string");t[r+o]=u}return o}function utf8Write(t,e,r,n){return blitBuffer(utf8ToBytes(e,t.length-r),t,r,n)}function asciiWrite(t,e,r,n){return blitBuffer(asciiToBytes(e),t,r,n)}function binaryWrite(t,e,r,n){return asciiWrite(t,e,r,n)}function base64Write(t,e,r,n){return blitBuffer(base64ToBytes(e),t,r,n)}f
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{"base64-js":22,"ieee754":34,"isarray":37}],26:[function(require,module,exports){
module.exports={100:"Continue",101:"Switching Protocols",102:"Processing",200:"OK",201:"Created",202:"Accepted",203:"Non-Authoritative Information",204:"No Content",205:"Reset Content",206:"Partial Content",207:"Multi-Status",208:"Already Reported",226:"IM Used",300:"Multiple Choices",301:"Moved Permanently",302:"Found",303:"See Other",304:"Not Modified",305:"Use Proxy",307:"Temporary Redirect",308:"Permanent Redirect",400:"Bad Request",401:"Unauthorized",402:"Payment Required",403:"Forbidden",404:"Not Found",405:"Method Not Allowed",406:"Not Acceptable",407:"Proxy Authentication Required",408:"Request Timeout",409:"Conflict",410:"Gone",411:"Length Required",412:"Precondition Failed",413:"Payload Too Large",414:"URI Too Long",415:"Unsupported Media Type",416:"Range Not Satisfiable",417:"Expectation Failed",418:"I'm a teapot",421:"Misdirected Request",422:"Unprocessable Entity",423:"Locked",424:"Failed Dependency",425:"Unordered Collection",426:"Upgrade Required",428:"Precondition Required",429:"Too Many Requests",431:"Request Header Fields Too Large",500:"Internal Server Error",501:"Not Implemented",502:"Bad Gateway",503:"Service Unavailable",504:"Gateway Timeout",505:"HTTP Version Not Supported",506:"Variant Also Negotiates",507:"Insufficient Storage",508:"Loop Detected",509:"Bandwidth Limit Exceeded",510:"Not Extended",511:"Network Authentication Required"};
},{}],27:[function(require,module,exports){
(function (process,global){
"use strict";var next=global.process&&process.nextTick||global.setImmediate||function(n){setTimeout(n,0)};module.exports=function(n,t){return n?void t.then(function(t){next(function(){n(null,t)})},function(t){next(function(){n(t)})}):t};
}).call(this,require('_process'),typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{"_process":71}],28:[function(require,module,exports){
(function (Buffer){
function isArray(r){return Array.isArray?Array.isArray(r):"[object Array]"===objectToString(r)}function isBoolean(r){return"boolean"==typeof r}function isNull(r){return null===r}function isNullOrUndefined(r){return null==r}function isNumber(r){return"number"==typeof r}function isString(r){return"string"==typeof r}function isSymbol(r){return"symbol"==typeof r}function isUndefined(r){return void 0===r}function isRegExp(r){return"[object RegExp]"===objectToString(r)}function isObject(r){return"object"==typeof r&&null!==r}function isDate(r){return"[object Date]"===objectToString(r)}function isError(r){return"[object Error]"===objectToString(r)||r instanceof Error}function isFunction(r){return"function"==typeof r}function isPrimitive(r){return null===r||"boolean"==typeof r||"number"==typeof r||"string"==typeof r||"symbol"==typeof r||"undefined"==typeof r}function objectToString(r){return Object.prototype.toString.call(r)}exports.isArray=isArray,exports.isBoolean=isBoolean,exports.isNull=isNull,exports.isNullOrUndefined=isNullOrUndefined,exports.isNumber=isNumber,exports.isString=isString,exports.isSymbol=isSymbol,exports.isUndefined=isUndefined,exports.isRegExp=isRegExp,exports.isObject=isObject,exports.isDate=isDate,exports.isError=isError,exports.isFunction=isFunction,exports.isPrimitive=isPrimitive,exports.isBuffer=Buffer.isBuffer;
}).call(this,{"isBuffer":require("../../is-buffer/index.js")})
},{"../../is-buffer/index.js":36}],29:[function(require,module,exports){
function useColors(){return"WebkitAppearance"in document.documentElement.style||window.console&&(console.firebug||console.exception&&console.table)||navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/)&&parseInt(RegExp.$1,10)>=31}function formatArgs(){var o=arguments,e=this.useColors;if(o[0]=(e?"%c":"")+this.namespace+(e?" %c":" ")+o[0]+(e?"%c ":" ")+"+"+exports.humanize(this.diff),!e)return o;var r="color: "+this.color;o=[o[0],r,"color: inherit"].concat(Array.prototype.slice.call(o,1));var t=0,s=0;return o[0].replace(/%[a-z%]/g,function(o){"%%"!==o&&(t++,"%c"===o&&(s=t))}),o.splice(s,0,r),o}function log(){return"object"==typeof console&&console.log&&Function.prototype.apply.call(console.log,console,arguments)}function save(o){try{null==o?exports.storage.removeItem("debug"):exports.storage.debug=o}catch(e){}}function load(){var o;try{o=exports.storage.debug}catch(e){}return o}function localstorage(){try{return window.localStorage}catch(o){}}exports=module.exports=require("./debug"),exports.log=log,exports.formatArgs=formatArgs,exports.save=save,exports.load=load,exports.useColors=useColors,exports.storage="undefined"!=typeof chrome&&"undefined"!=typeof chrome.storage?chrome.storage.local:localstorage(),exports.colors=["lightseagreen","forestgreen","goldenrod","dodgerblue","darkorchid","crimson"],exports.formatters.j=function(o){return JSON.stringify(o)},exports.enable(load());
},{"./debug":30}],30:[function(require,module,exports){
function selectColor(){return exports.colors[prevColor++%exports.colors.length]}function debug(e){function r(){}function o(){var e=o,r=+new Date,s=r-(prevTime||r);e.diff=s,e.prev=prevTime,e.curr=r,prevTime=r,null==e.useColors&&(e.useColors=exports.useColors()),null==e.color&&e.useColors&&(e.color=selectColor());var t=Array.prototype.slice.call(arguments);t[0]=exports.coerce(t[0]),"string"!=typeof t[0]&&(t=["%o"].concat(t));var n=0;t[0]=t[0].replace(/%([a-z%])/g,function(r,o){if("%%"===r)return r;n++;var s=exports.formatters[o];if("function"==typeof s){var p=t[n];r=s.call(e,p),t.splice(n,1),n--}return r}),"function"==typeof exports.formatArgs&&(t=exports.formatArgs.apply(e,t));var p=o.log||exports.log||console.log.bind(console);p.apply(e,t)}r.enabled=!1,o.enabled=!0;var s=exports.enabled(e)?o:r;return s.namespace=e,s}function enable(e){exports.save(e);for(var r=(e||"").split(/[\s,]+/),o=r.length,s=0;o>s;s++)r[s]&&(e=r[s].replace(/\*/g,".*?"),"-"===e[0]?exports.skips.push(new RegExp("^"+e.substr(1)+"$")):exports.names.push(new RegExp("^"+e+"$")))}function disable(){exports.enable("")}function enabled(e){var r,o;for(r=0,o=exports.skips.length;o>r;r++)if(exports.skips[r].test(e))return!1;for(r=0,o=exports.names.length;o>r;r++)if(exports.names[r].test(e))return!0;return!1}function coerce(e){return e instanceof Error?e.stack||e.message:e}exports=module.exports=debug,exports.coerce=coerce,exports.disable=disable,exports.enable=enable,exports.enabled=enabled,exports.humanize=require("ms"),exports.names=[],exports.skips=[],exports.formatters={};var prevColor=0,prevTime;
},{"ms":68}],31:[function(require,module,exports){
(function (process,global){
/*!
* @overview es6-promise - a tiny implementation of Promises/A+.
* @copyright Copyright (c) 2014 Yehuda Katz, Tom Dale, Stefan Penner and contributors (Conversion to ES6 API by Jake Archibald)
* @license Licensed under MIT license
* See https://raw.githubusercontent.com/jakearchibald/es6-promise/master/LICENSE
* @version 3.1.2
*/
(function(){"use strict";function t(t){return"function"==typeof t||"object"==typeof t&&null!==t}function e(t){return"function"==typeof t}function n(t){W=t}function r(t){H=t}function o(){return function(){process.nextTick(a)}}function i(){return function(){U(a)}}function s(){var t=0,e=new Q(a),n=document.createTextNode("");return e.observe(n,{characterData:!0}),function(){n.data=t=++t%2}}function u(){var t=new MessageChannel;return t.port1.onmessage=a,function(){t.port2.postMessage(0)}}function c(){return function(){setTimeout(a,1)}}function a(){for(var t=0;G>t;t+=2){var e=X[t],n=X[t+1];e(n),X[t]=void 0,X[t+1]=void 0}G=0}function f(){try{var t=require,e=t("vertx");return U=e.runOnLoop||e.runOnContext,i()}catch(n){return c()}}function l(t,e){var n=this,r=n._state;if(r===et&&!t||r===nt&&!e)return this;var o=new this.constructor(p),i=n._result;if(r){var s=arguments[r-1];H(function(){C(r,o,s,i)})}else j(n,o,t,e);return o}function h(t){var e=this;if(t&&"object"==typeof t&&t.constructor===e)return t;var n=new e(p);return g(n,t),n}function p(){}function _(){return new TypeError("You cannot resolve a promise with itself")}function v(){return new TypeError("A promises callback cannot return that same promise.")}function d(t){try{return t.then}catch(e){return rt.error=e,rt}}function y(t,e,n,r){try{t.call(e,n,r)}catch(o){return o}}function m(t,e,n){H(function(t){var r=!1,o=y(n,e,function(n){r||(r=!0,e!==n?g(t,n):E(t,n))},function(e){r||(r=!0,S(t,e))},"Settle: "+(t._label||" unknown promise"));!r&&o&&(r=!0,S(t,o))},t)}function w(t,e){e._state===et?E(t,e._result):e._state===nt?S(t,e._result):j(e,void 0,function(e){g(t,e)},function(e){S(t,e)})}function b(t,n,r){n.constructor===t.constructor&&r===Z&&constructor.resolve===$?w(t,n):r===rt?S(t,rt.error):void 0===r?E(t,n):e(r)?m(t,n,r):E(t,n)}function g(e,n){e===n?S(e,_()):t(n)?b(e,n,d(n)):E(e,n)}function A(t){t._onerror&&t._onerror(t._result),T(t)}function E(t,e){t._state===tt&&(t._result=e,t._state=et,0!==t._subscribers.length&&H(T,t))}function S(t,e){t._state===tt&&(t._state=nt,t._result=e,H(A,t))}function j(t,e,n,r){var o=t._subscribers,i=o.length;t._onerror=null,o[i]=e,o[i+et]=n,o[i+nt]=r,0===i&&t._state&&H(T,t)}function T(t){var e=t._subscribers,n=t._state;if(0!==e.length){for(var r,o,i=t._result,s=0;s<e.length;s+=3)r=e[s],o=e[s+n],r?C(n,r,o,i):o(i);t._subscribers.length=0}}function P(){this.error=null}function x(t,e){try{return t(e)}catch(n){return ot.error=n,ot}}function C(t,n,r,o){var i,s,u,c,a=e(r);if(a){if(i=x(r,o),i===ot?(c=!0,s=i.error,i=null):u=!0,n===i)return void S(n,v())}else i=o,u=!0;n._state!==tt||(a&&u?g(n,i):c?S(n,s):t===et?E(n,i):t===nt&&S(n,i))}function M(t,e){try{e(function(e){g(t,e)},function(e){S(t,e)})}catch(n){S(t,n)}}function O(t){return new ft(this,t).promise}function k(t){function e(t){g(o,t)}function n(t){S(o,t)}var r=this,o=new r(p);if(!B(t))return S(o,new TypeError("You must pass an array to race.")),o;for(var i=t.length,s=0;o._state===tt&&i>s;s++)j(r.resolve(t[s]),void 0,e,n);return o}function Y(t){var e=this,n=new e(p);return S(n,t),n}function q(){throw new TypeError("You must pass a resolver function as the first argument to the promise constructor")}function F(){throw new TypeError("Failed to construct 'Promise': Please use the 'new' operator, this object constructor cannot be called as a function.")}function D(t){this._id=ct++,this._state=void 0,this._result=void 0,this._subscribers=[],p!==t&&("function"!=typeof t&&q(),this instanceof D?M(this,t):F())}function K(t,e){this._instanceConstructor=t,this.promise=new t(p),Array.isArray(e)?(this._input=e,this.length=e.length,this._remaining=e.length,this._result=new Array(this.length),0===this.length?E(this.promise,this._result):(this.length=this.length||0,this._enumerate(),0===this._remaining&&E(this.promise,this._result))):S(this.promise,this._validationError())}function L(){var t;if("undefined"!=typeof global)t=global;else if("undefined"!=typeof self)t=self;else try{t=Function("return this")()}catch(e){throw new Error("polyfill failed because global object is unavailable in this environment")}var n=t.Prom
}).call(this,require('_process'),typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{"_process":71}],32:[function(require,module,exports){
function EventEmitter(){this._events=this._events||{},this._maxListeners=this._maxListeners||void 0}function isFunction(e){return"function"==typeof e}function isNumber(e){return"number"==typeof e}function isObject(e){return"object"==typeof e&&null!==e}function isUndefined(e){return void 0===e}module.exports=EventEmitter,EventEmitter.EventEmitter=EventEmitter,EventEmitter.prototype._events=void 0,EventEmitter.prototype._maxListeners=void 0,EventEmitter.defaultMaxListeners=10,EventEmitter.prototype.setMaxListeners=function(e){if(!isNumber(e)||0>e||isNaN(e))throw TypeError("n must be a positive number");return this._maxListeners=e,this},EventEmitter.prototype.emit=function(e){var t,i,n,s,r,o;if(this._events||(this._events={}),"error"===e&&(!this._events.error||isObject(this._events.error)&&!this._events.error.length)){if(t=arguments[1],t instanceof Error)throw t;throw TypeError('Uncaught, unspecified "error" event.')}if(i=this._events[e],isUndefined(i))return!1;if(isFunction(i))switch(arguments.length){case 1:i.call(this);break;case 2:i.call(this,arguments[1]);break;case 3:i.call(this,arguments[1],arguments[2]);break;default:s=Array.prototype.slice.call(arguments,1),i.apply(this,s)}else if(isObject(i))for(s=Array.prototype.slice.call(arguments,1),o=i.slice(),n=o.length,r=0;n>r;r++)o[r].apply(this,s);return!0},EventEmitter.prototype.addListener=function(e,t){var i;if(!isFunction(t))throw TypeError("listener must be a function");return this._events||(this._events={}),this._events.newListener&&this.emit("newListener",e,isFunction(t.listener)?t.listener:t),this._events[e]?isObject(this._events[e])?this._events[e].push(t):this._events[e]=[this._events[e],t]:this._events[e]=t,isObject(this._events[e])&&!this._events[e].warned&&(i=isUndefined(this._maxListeners)?EventEmitter.defaultMaxListeners:this._maxListeners,i&&i>0&&this._events[e].length>i&&(this._events[e].warned=!0,console.error("(node) warning: possible EventEmitter memory leak detected. %d listeners added. Use emitter.setMaxListeners() to increase limit.",this._events[e].length),"function"==typeof console.trace&&console.trace())),this},EventEmitter.prototype.on=EventEmitter.prototype.addListener,EventEmitter.prototype.once=function(e,t){function i(){this.removeListener(e,i),n||(n=!0,t.apply(this,arguments))}if(!isFunction(t))throw TypeError("listener must be a function");var n=!1;return i.listener=t,this.on(e,i),this},EventEmitter.prototype.removeListener=function(e,t){var i,n,s,r;if(!isFunction(t))throw TypeError("listener must be a function");if(!this._events||!this._events[e])return this;if(i=this._events[e],s=i.length,n=-1,i===t||isFunction(i.listener)&&i.listener===t)delete this._events[e],this._events.removeListener&&this.emit("removeListener",e,t);else if(isObject(i)){for(r=s;r-- >0;)if(i[r]===t||i[r].listener&&i[r].listener===t){n=r;break}if(0>n)return this;1===i.length?(i.length=0,delete this._events[e]):i.splice(n,1),this._events.removeListener&&this.emit("removeListener",e,t)}return this},EventEmitter.prototype.removeAllListeners=function(e){var t,i;if(!this._events)return this;if(!this._events.removeListener)return 0===arguments.length?this._events={}:this._events[e]&&delete this._events[e],this;if(0===arguments.length){for(t in this._events)"removeListener"!==t&&this.removeAllListeners(t);return this.removeAllListeners("removeListener"),this._events={},this}if(i=this._events[e],isFunction(i))this.removeListener(e,i);else if(i)for(;i.length;)this.removeListener(e,i[i.length-1]);return delete this._events[e],this},EventEmitter.prototype.listeners=function(e){var t;return t=this._events&&this._events[e]?isFunction(this._events[e])?[this._events[e]]:this._events[e].slice():[]},EventEmitter.prototype.listenerCount=function(e){if(this._events){var t=this._events[e];if(isFunction(t))return 1;if(t)return t.length}return 0},EventEmitter.listenerCount=function(e,t){return e.listenerCount(t)};
},{}],33:[function(require,module,exports){
var http=require("http"),https=module.exports;for(var key in http)http.hasOwnProperty(key)&&(https[key]=http[key]);https.request=function(t,e){return t||(t={}),t.scheme="https",t.protocol="https:",http.request.call(this,t,e)};
},{"http":87}],34:[function(require,module,exports){
exports.read=function(a,o,t,r,h){var M,p,w=8*h-r-1,f=(1<<w)-1,e=f>>1,i=-7,N=t?h-1:0,n=t?-1:1,s=a[o+N];for(N+=n,M=s&(1<<-i)-1,s>>=-i,i+=w;i>0;M=256*M+a[o+N],N+=n,i-=8);for(p=M&(1<<-i)-1,M>>=-i,i+=r;i>0;p=256*p+a[o+N],N+=n,i-=8);if(0===M)M=1-e;else{if(M===f)return p?NaN:(s?-1:1)*(1/0);p+=Math.pow(2,r),M-=e}return(s?-1:1)*p*Math.pow(2,M-r)},exports.write=function(a,o,t,r,h,M){var p,w,f,e=8*M-h-1,i=(1<<e)-1,N=i>>1,n=23===h?Math.pow(2,-24)-Math.pow(2,-77):0,s=r?0:M-1,u=r?1:-1,l=0>o||0===o&&0>1/o?1:0;for(o=Math.abs(o),isNaN(o)||o===1/0?(w=isNaN(o)?1:0,p=i):(p=Math.floor(Math.log(o)/Math.LN2),o*(f=Math.pow(2,-p))<1&&(p--,f*=2),o+=p+N>=1?n/f:n*Math.pow(2,1-N),o*f>=2&&(p++,f/=2),p+N>=i?(w=0,p=i):p+N>=1?(w=(o*f-1)*Math.pow(2,h),p+=N):(w=o*Math.pow(2,N-1)*Math.pow(2,h),p=0));h>=8;a[t+s]=255&w,s+=u,w/=256,h-=8);for(p=p<<h|w,e+=h;e>0;a[t+s]=255&p,s+=u,p/=256,e-=8);a[t+s-u]|=128*l};
},{}],35:[function(require,module,exports){
"function"==typeof Object.create?module.exports=function(t,e){t.super_=e,t.prototype=Object.create(e.prototype,{constructor:{value:t,enumerable:!1,writable:!0,configurable:!0}})}:module.exports=function(t,e){t.super_=e;var o=function(){};o.prototype=e.prototype,t.prototype=new o,t.prototype.constructor=t};
},{}],36:[function(require,module,exports){
module.exports=function(r){return!(null==r||!(r._isBuffer||r.constructor&&"function"==typeof r.constructor.isBuffer&&r.constructor.isBuffer(r)))};
},{}],37:[function(require,module,exports){
var toString={}.toString;module.exports=Array.isArray||function(r){return"[object Array]"==toString.call(r)};
},{}],38:[function(require,module,exports){
"use strict";var yaml=require("./lib/js-yaml.js");module.exports=yaml;
},{"./lib/js-yaml.js":39}],39:[function(require,module,exports){
"use strict";function deprecated(e){return function(){throw new Error("Function "+e+" is deprecated and cannot be used.")}}var loader=require("./js-yaml/loader"),dumper=require("./js-yaml/dumper");module.exports.Type=require("./js-yaml/type"),module.exports.Schema=require("./js-yaml/schema"),module.exports.FAILSAFE_SCHEMA=require("./js-yaml/schema/failsafe"),module.exports.JSON_SCHEMA=require("./js-yaml/schema/json"),module.exports.CORE_SCHEMA=require("./js-yaml/schema/core"),module.exports.DEFAULT_SAFE_SCHEMA=require("./js-yaml/schema/default_safe"),module.exports.DEFAULT_FULL_SCHEMA=require("./js-yaml/schema/default_full"),module.exports.load=loader.load,module.exports.loadAll=loader.loadAll,module.exports.safeLoad=loader.safeLoad,module.exports.safeLoadAll=loader.safeLoadAll,module.exports.dump=dumper.dump,module.exports.safeDump=dumper.safeDump,module.exports.YAMLException=require("./js-yaml/exception"),module.exports.MINIMAL_SCHEMA=require("./js-yaml/schema/failsafe"),module.exports.SAFE_SCHEMA=require("./js-yaml/schema/default_safe"),module.exports.DEFAULT_SCHEMA=require("./js-yaml/schema/default_full"),module.exports.scan=deprecated("scan"),module.exports.parse=deprecated("parse"),module.exports.compose=deprecated("compose"),module.exports.addConstructor=deprecated("addConstructor");
},{"./js-yaml/dumper":41,"./js-yaml/exception":42,"./js-yaml/loader":43,"./js-yaml/schema":45,"./js-yaml/schema/core":46,"./js-yaml/schema/default_full":47,"./js-yaml/schema/default_safe":48,"./js-yaml/schema/failsafe":49,"./js-yaml/schema/json":50,"./js-yaml/type":51}],40:[function(require,module,exports){
"use strict";function isNothing(e){return"undefined"==typeof e||null===e}function isObject(e){return"object"==typeof e&&null!==e}function toArray(e){return Array.isArray(e)?e:isNothing(e)?[]:[e]}function extend(e,t){var r,o,n,i;if(t)for(i=Object.keys(t),r=0,o=i.length;o>r;r+=1)n=i[r],e[n]=t[n];return e}function repeat(e,t){var r,o="";for(r=0;t>r;r+=1)o+=e;return o}function isNegativeZero(e){return 0===e&&Number.NEGATIVE_INFINITY===1/e}module.exports.isNothing=isNothing,module.exports.isObject=isObject,module.exports.toArray=toArray,module.exports.repeat=repeat,module.exports.isNegativeZero=isNegativeZero,module.exports.extend=extend;
},{}],41:[function(require,module,exports){
"use strict";function compileStyleMap(e,t){var n,i,r,E,o,l,a;if(null===t)return{};for(n={},i=Object.keys(t),r=0,E=i.length;E>r;r+=1)o=i[r],l=String(t[o]),"!!"===o.slice(0,2)&&(o="tag:yaml.org,2002:"+o.slice(2)),a=e.compiledTypeMap[o],a&&_hasOwnProperty.call(a.styleAliases,l)&&(l=a.styleAliases[l]),n[o]=l;return n}function encodeHex(e){var t,n,i;if(t=e.toString(16).toUpperCase(),255>=e)n="x",i=2;else if(65535>=e)n="u",i=4;else{if(!(4294967295>=e))throw new YAMLException("code point within a string may not be greater than 0xFFFFFFFF");n="U",i=8}return"\\"+n+common.repeat("0",i-t.length)+t}function State(e){this.schema=e.schema||DEFAULT_FULL_SCHEMA,this.indent=Math.max(1,e.indent||2),this.skipInvalid=e.skipInvalid||!1,this.flowLevel=common.isNothing(e.flowLevel)?-1:e.flowLevel,this.styleMap=compileStyleMap(this.schema,e.styles||null),this.sortKeys=e.sortKeys||!1,this.lineWidth=e.lineWidth||80,this.noRefs=e.noRefs||!1,this.noCompatMode=e.noCompatMode||!1,this.implicitTypes=this.schema.compiledImplicit,this.explicitTypes=this.schema.compiledExplicit,this.tag=null,this.result="",this.duplicates=[],this.usedDuplicates=null}function indentString(e,t){for(var n,i=common.repeat(" ",t),r=0,E=-1,o="",l=e.length;l>r;)E=e.indexOf("\n",r),-1===E?(n=e.slice(r),r=l):(n=e.slice(r,E+1),r=E+1),n.length&&"\n"!==n&&(o+=i),o+=n;return o}function generateNextLine(e,t){return"\n"+common.repeat(" ",e.indent*t)}function testImplicitResolving(e,t){var n,i,r;for(n=0,i=e.implicitTypes.length;i>n;n+=1)if(r=e.implicitTypes[n],r.resolve(t))return!0;return!1}function isWhitespace(e){return e===CHAR_SPACE||e===CHAR_TAB}function isPrintable(e){return e>=32&&126>=e||e>=161&&55295>=e&&8232!==e&&8233!==e||e>=57344&&65533>=e&&65279!==e||e>=65536&&1114111>=e}function isPlainSafe(e){return isPrintable(e)&&65279!==e&&e!==CHAR_COMMA&&e!==CHAR_LEFT_SQUARE_BRACKET&&e!==CHAR_RIGHT_SQUARE_BRACKET&&e!==CHAR_LEFT_CURLY_BRACKET&&e!==CHAR_RIGHT_CURLY_BRACKET&&e!==CHAR_COLON&&e!==CHAR_SHARP}function isPlainSafeFirst(e){return isPrintable(e)&&65279!==e&&!isWhitespace(e)&&e!==CHAR_MINUS&&e!==CHAR_QUESTION&&e!==CHAR_COLON&&e!==CHAR_COMMA&&e!==CHAR_LEFT_SQUARE_BRACKET&&e!==CHAR_RIGHT_SQUARE_BRACKET&&e!==CHAR_LEFT_CURLY_BRACKET&&e!==CHAR_RIGHT_CURLY_BRACKET&&e!==CHAR_SHARP&&e!==CHAR_AMPERSAND&&e!==CHAR_ASTERISK&&e!==CHAR_EXCLAMATION&&e!==CHAR_VERTICAL_LINE&&e!==CHAR_GREATER_THAN&&e!==CHAR_SINGLE_QUOTE&&e!==CHAR_DOUBLE_QUOTE&&e!==CHAR_PERCENT&&e!==CHAR_COMMERCIAL_AT&&e!==CHAR_GRAVE_ACCENT}function chooseScalarStyle(e,t,n,i,r){var E,o,l=!1,a=!1,s=-1!==i,c=-1,A=isPlainSafeFirst(e.charCodeAt(0))&&!isWhitespace(e.charCodeAt(e.length-1));if(t)for(E=0;E<e.length;E++){if(o=e.charCodeAt(E),!isPrintable(o))return STYLE_DOUBLE;A=A&&isPlainSafe(o)}else{for(E=0;E<e.length;E++){if(o=e.charCodeAt(E),o===CHAR_LINE_FEED)l=!0,s&&(a=a||E-c-1>i&&" "!==e[c+1],c=E);else if(!isPrintable(o))return STYLE_DOUBLE;A=A&&isPlainSafe(o)}a=a||s&&E-c-1>i&&" "!==e[c+1]}return l||a?" "===e[0]&&n>9?STYLE_DOUBLE:a?STYLE_FOLDED:STYLE_LITERAL:A&&!r(e)?STYLE_PLAIN:STYLE_SINGLE}function writeScalar(e,t,n,i){e.dump=function(){function r(t){return testImplicitResolving(e,t)}if(0===t.length)return"''";if(!e.noCompatMode&&-1!==DEPRECATED_BOOLEANS_SYNTAX.indexOf(t))return"'"+t+"'";var E=e.indent*Math.max(1,n),o=-1===e.lineWidth?-1:Math.max(Math.min(e.lineWidth,40),e.lineWidth-E),l=i||e.flowLevel>-1&&n>=e.flowLevel;switch(chooseScalarStyle(t,l,e.indent,o,r)){case STYLE_PLAIN:return t;case STYLE_SINGLE:return"'"+t.replace(/'/g,"''")+"'";case STYLE_LITERAL:return"|"+blockHeader(t,e.indent)+dropEndingNewline(indentString(t,E));case STYLE_FOLDED:return">"+blockHeader(t,e.indent)+dropEndingNewline(indentString(foldString(t,o),E));case STYLE_DOUBLE:return'"'+escapeString(t,o)+'"';default:throw new YAMLException("impossible error: invalid scalar style")}}()}function blockHeader(e,t){var n=" "===e[0]?String(t):"",i="\n"===e[e.length-1],r=i&&("\n"===e[e.length-2]||"\n"===e),E=r?"+":i?"":"-";return n+E+"\n"}function dropEndingNewline(e){return"\n"===e[e.length-1]?e.slice(0,-1):e}function foldString(e,t){for(var n,i,r=/(\n+)([^\n]*)/
},{"./common":40,"./exception":42,"./schema/default_full":47,"./schema/default_safe":48}],42:[function(require,module,exports){
"use strict";function YAMLException(t,r){Error.call(this),Error.captureStackTrace?Error.captureStackTrace(this,this.constructor):this.stack=(new Error).stack||"",this.name="YAMLException",this.reason=t,this.mark=r,this.message=(this.reason||"(unknown reason)")+(this.mark?" "+this.mark.toString():"")}YAMLException.prototype=Object.create(Error.prototype),YAMLException.prototype.constructor=YAMLException,YAMLException.prototype.toString=function(t){var r=this.name+": ";return r+=this.reason||"(unknown reason)",!t&&this.mark&&(r+=" "+this.mark.toString()),r},module.exports=YAMLException;
},{}],43:[function(require,module,exports){
"use strict";function is_EOL(e){return 10===e||13===e}function is_WHITE_SPACE(e){return 9===e||32===e}function is_WS_OR_EOL(e){return 9===e||32===e||10===e||13===e}function is_FLOW_INDICATOR(e){return 44===e||91===e||93===e||123===e||125===e}function fromHexCode(e){var t;return e>=48&&57>=e?e-48:(t=32|e,t>=97&&102>=t?t-97+10:-1)}function escapedHexLen(e){return 120===e?2:117===e?4:85===e?8:0}function fromDecimalCode(e){return e>=48&&57>=e?e-48:-1}function simpleEscapeSequence(e){return 48===e?"\x00":97===e?"":98===e?"\b":116===e?" ":9===e?" ":110===e?"\n":118===e?"\x0B":102===e?"\f":114===e?"\r":101===e?"":32===e?" ":34===e?'"':47===e?"/":92===e?"\\":78===e?"…":95===e?" ":76===e?"\u2028":80===e?"\u2029":""}function charFromCodepoint(e){return 65535>=e?String.fromCharCode(e):String.fromCharCode((e-65536>>10)+55296,(e-65536&1023)+56320)}function State(e,t){this.input=e,this.filename=t.filename||null,this.schema=t.schema||DEFAULT_FULL_SCHEMA,this.onWarning=t.onWarning||null,this.legacy=t.legacy||!1,this.json=t.json||!1,this.listener=t.listener||null,this.implicitTypes=this.schema.compiledImplicit,this.typeMap=this.schema.compiledTypeMap,this.length=e.length,this.position=0,this.line=0,this.lineStart=0,this.lineIndent=0,this.documents=[]}function generateError(e,t){return new YAMLException(t,new Mark(e.filename,e.input,e.position,e.line,e.position-e.lineStart))}function throwError(e,t){throw generateError(e,t)}function throwWarning(e,t){e.onWarning&&e.onWarning.call(null,generateError(e,t))}function captureSegment(e,t,n,i){var o,r,a,s;if(n>t){if(s=e.input.slice(t,n),i)for(o=0,r=s.length;r>o;o+=1)a=s.charCodeAt(o),9===a||a>=32&&1114111>=a||throwError(e,"expected valid JSON character");else PATTERN_NON_PRINTABLE.test(s)&&throwError(e,"the stream contains non-printable characters");e.result+=s}}function mergeMappings(e,t,n,i){var o,r,a,s;for(common.isObject(n)||throwError(e,"cannot merge mappings; the provided source object is unacceptable"),o=Object.keys(n),a=0,s=o.length;s>a;a+=1)r=o[a],_hasOwnProperty.call(t,r)||(t[r]=n[r],i[r]=!0)}function storeMappingPair(e,t,n,i,o,r){var a,s;if(o=String(o),null===t&&(t={}),"tag:yaml.org,2002:merge"===i)if(Array.isArray(r))for(a=0,s=r.length;s>a;a+=1)mergeMappings(e,t,r[a],n);else mergeMappings(e,t,r,n);else e.json||_hasOwnProperty.call(n,o)||!_hasOwnProperty.call(t,o)||throwError(e,"duplicated mapping key"),t[o]=r,delete n[o];return t}function readLineBreak(e){var t;t=e.input.charCodeAt(e.position),10===t?e.position++:13===t?(e.position++,10===e.input.charCodeAt(e.position)&&e.position++):throwError(e,"a line break is expected"),e.line+=1,e.lineStart=e.position}function skipSeparationSpace(e,t,n){for(var i=0,o=e.input.charCodeAt(e.position);0!==o;){for(;is_WHITE_SPACE(o);)o=e.input.charCodeAt(++e.position);if(t&&35===o)do o=e.input.charCodeAt(++e.position);while(10!==o&&13!==o&&0!==o);if(!is_EOL(o))break;for(readLineBreak(e),o=e.input.charCodeAt(e.position),i++,e.lineIndent=0;32===o;)e.lineIndent++,o=e.input.charCodeAt(++e.position)}return-1!==n&&0!==i&&e.lineIndent<n&&throwWarning(e,"deficient indentation"),i}function testDocumentSeparator(e){var t,n=e.position;return t=e.input.charCodeAt(n),(45===t||46===t)&&t===e.input.charCodeAt(n+1)&&t===e.input.charCodeAt(n+2)&&(n+=3,t=e.input.charCodeAt(n),0===t||is_WS_OR_EOL(t))}function writeFoldedLines(e,t){1===t?e.result+=" ":t>1&&(e.result+=common.repeat("\n",t-1))}function readPlainScalar(e,t,n){var i,o,r,a,s,p,c,l,u,d=e.kind,h=e.result;if(u=e.input.charCodeAt(e.position),is_WS_OR_EOL(u)||is_FLOW_INDICATOR(u)||35===u||38===u||42===u||33===u||124===u||62===u||39===u||34===u||37===u||64===u||96===u)return!1;if((63===u||45===u)&&(o=e.input.charCodeAt(e.position+1),is_WS_OR_EOL(o)||n&&is_FLOW_INDICATOR(o)))return!1;for(e.kind="scalar",e.result="",r=a=e.position,s=!1;0!==u;){if(58===u){if(o=e.input.charCodeAt(e.position+1),is_WS_OR_EOL(o)||n&&is_FLOW_INDICATOR(o))break}else if(35===u){if(i=e.input.charCodeAt(e.position-1),is_WS_OR_EOL(i))break}else{if(e.position===e.lineStart&&testDocumentSeparator(e)||n&&is_FLOW_INDICATOR(u))break;if(is_E
},{"./common":40,"./exception":42,"./mark":44,"./schema/default_full":47,"./schema/default_safe":48}],44:[function(require,module,exports){
"use strict";function Mark(t,i,n,e,r){this.name=t,this.buffer=i,this.position=n,this.line=e,this.column=r}var common=require("./common");Mark.prototype.getSnippet=function(t,i){var n,e,r,o,s;if(!this.buffer)return null;for(t=t||4,i=i||75,n="",e=this.position;e>0&&-1==="\x00\r\n…\u2028\u2029".indexOf(this.buffer.charAt(e-1));)if(e-=1,this.position-e>i/2-1){n=" ... ",e+=5;break}for(r="",o=this.position;o<this.buffer.length&&-1==="\x00\r\n…\u2028\u2029".indexOf(this.buffer.charAt(o));)if(o+=1,o-this.position>i/2-1){r=" ... ",o-=5;break}return s=this.buffer.slice(e,o),common.repeat(" ",t)+n+s+r+"\n"+common.repeat(" ",t+this.position-e+n.length)+"^"},Mark.prototype.toString=function(t){var i,n="";return this.name&&(n+='in "'+this.name+'" '),n+="at line "+(this.line+1)+", column "+(this.column+1),t||(i=this.getSnippet(),i&&(n+=":\n"+i)),n},module.exports=Mark;
},{"./common":40}],45:[function(require,module,exports){
"use strict";function compileList(i,e,t){var c=[];return i.include.forEach(function(i){t=compileList(i,e,t)}),i[e].forEach(function(i){t.forEach(function(e,t){e.tag===i.tag&&c.push(t)}),t.push(i)}),t.filter(function(i,e){return-1===c.indexOf(e)})}function compileMap(){function i(i){c[i.tag]=i}var e,t,c={};for(e=0,t=arguments.length;t>e;e+=1)arguments[e].forEach(i);return c}function Schema(i){this.include=i.include||[],this.implicit=i.implicit||[],this.explicit=i.explicit||[],this.implicit.forEach(function(i){if(i.loadKind&&"scalar"!==i.loadKind)throw new YAMLException("There is a non-scalar type in the implicit list of a schema. Implicit resolving of such types is not supported.")}),this.compiledImplicit=compileList(this,"implicit",[]),this.compiledExplicit=compileList(this,"explicit",[]),this.compiledTypeMap=compileMap(this.compiledImplicit,this.compiledExplicit)}var common=require("./common"),YAMLException=require("./exception"),Type=require("./type");Schema.DEFAULT=null,Schema.create=function(){var i,e;switch(arguments.length){case 1:i=Schema.DEFAULT,e=arguments[0];break;case 2:i=arguments[0],e=arguments[1];break;default:throw new YAMLException("Wrong number of arguments for Schema.create function")}if(i=common.toArray(i),e=common.toArray(e),!i.every(function(i){return i instanceof Schema}))throw new YAMLException("Specified list of super schemas (or a single Schema object) contains a non-Schema object.");if(!e.every(function(i){return i instanceof Type}))throw new YAMLException("Specified list of YAML types (or a single Type object) contains a non-Type object.");return new Schema({include:i,explicit:e})},module.exports=Schema;
},{"./common":40,"./exception":42,"./type":51}],46:[function(require,module,exports){
"use strict";var Schema=require("../schema");module.exports=new Schema({include:[require("./json")]});
},{"../schema":45,"./json":50}],47:[function(require,module,exports){
"use strict";var Schema=require("../schema");module.exports=Schema.DEFAULT=new Schema({include:[require("./default_safe")],explicit:[require("../type/js/undefined"),require("../type/js/regexp"),require("../type/js/function")]});
},{"../schema":45,"../type/js/function":56,"../type/js/regexp":57,"../type/js/undefined":58,"./default_safe":48}],48:[function(require,module,exports){
"use strict";var Schema=require("../schema");module.exports=new Schema({include:[require("./core")],implicit:[require("../type/timestamp"),require("../type/merge")],explicit:[require("../type/binary"),require("../type/omap"),require("../type/pairs"),require("../type/set")]});
},{"../schema":45,"../type/binary":52,"../type/merge":60,"../type/omap":62,"../type/pairs":63,"../type/set":65,"../type/timestamp":67,"./core":46}],49:[function(require,module,exports){
"use strict";var Schema=require("../schema");module.exports=new Schema({explicit:[require("../type/str"),require("../type/seq"),require("../type/map")]});
},{"../schema":45,"../type/map":59,"../type/seq":64,"../type/str":66}],50:[function(require,module,exports){
"use strict";var Schema=require("../schema");module.exports=new Schema({include:[require("./failsafe")],implicit:[require("../type/null"),require("../type/bool"),require("../type/int"),require("../type/float")]});
},{"../schema":45,"../type/bool":53,"../type/float":54,"../type/int":55,"../type/null":61,"./failsafe":49}],51:[function(require,module,exports){
"use strict";function compileStyleAliases(e){var t={};return null!==e&&Object.keys(e).forEach(function(n){e[n].forEach(function(e){t[String(e)]=n})}),t}function Type(e,t){if(t=t||{},Object.keys(t).forEach(function(t){if(-1===TYPE_CONSTRUCTOR_OPTIONS.indexOf(t))throw new YAMLException('Unknown option "'+t+'" is met in definition of "'+e+'" YAML type.')}),this.tag=e,this.kind=t.kind||null,this.resolve=t.resolve||function(){return!0},this.construct=t.construct||function(e){return e},this.instanceOf=t.instanceOf||null,this.predicate=t.predicate||null,this.represent=t.represent||null,this.defaultStyle=t.defaultStyle||null,this.styleAliases=compileStyleAliases(t.styleAliases||null),-1===YAML_NODE_KINDS.indexOf(this.kind))throw new YAMLException('Unknown kind "'+this.kind+'" is specified for "'+e+'" YAML type.')}var YAMLException=require("./exception"),TYPE_CONSTRUCTOR_OPTIONS=["kind","resolve","construct","instanceOf","predicate","represent","defaultStyle","styleAliases"],YAML_NODE_KINDS=["scalar","sequence","mapping"];module.exports=Type;
},{"./exception":42}],52:[function(require,module,exports){
"use strict";function resolveYamlBinary(r){if(null===r)return!1;var e,n,u=0,t=r.length,a=BASE64_MAP;for(n=0;t>n;n++)if(e=a.indexOf(r.charAt(n)),!(e>64)){if(0>e)return!1;u+=6}return u%8===0}function constructYamlBinary(r){var e,n,u=r.replace(/[\r\n=]/g,""),t=u.length,a=BASE64_MAP,f=0,i=[];for(e=0;t>e;e++)e%4===0&&e&&(i.push(f>>16&255),i.push(f>>8&255),i.push(255&f)),f=f<<6|a.indexOf(u.charAt(e));return n=t%4*6,0===n?(i.push(f>>16&255),i.push(f>>8&255),i.push(255&f)):18===n?(i.push(f>>10&255),i.push(f>>2&255)):12===n&&i.push(f>>4&255),NodeBuffer?new NodeBuffer(i):i}function representYamlBinary(r){var e,n,u="",t=0,a=r.length,f=BASE64_MAP;for(e=0;a>e;e++)e%3===0&&e&&(u+=f[t>>18&63],u+=f[t>>12&63],u+=f[t>>6&63],u+=f[63&t]),t=(t<<8)+r[e];return n=a%3,0===n?(u+=f[t>>18&63],u+=f[t>>12&63],u+=f[t>>6&63],u+=f[63&t]):2===n?(u+=f[t>>10&63],u+=f[t>>4&63],u+=f[t<<2&63],u+=f[64]):1===n&&(u+=f[t>>2&63],u+=f[t<<4&63],u+=f[64],u+=f[64]),u}function isBinary(r){return NodeBuffer&&NodeBuffer.isBuffer(r)}var NodeBuffer;try{var _require=require;NodeBuffer=_require("buffer").Buffer}catch(__){}var Type=require("../type"),BASE64_MAP="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=\n\r";module.exports=new Type("tag:yaml.org,2002:binary",{kind:"scalar",resolve:resolveYamlBinary,construct:constructYamlBinary,predicate:isBinary,represent:representYamlBinary});
},{"../type":51}],53:[function(require,module,exports){
"use strict";function resolveYamlBoolean(e){if(null===e)return!1;var r=e.length;return 4===r&&("true"===e||"True"===e||"TRUE"===e)||5===r&&("false"===e||"False"===e||"FALSE"===e)}function constructYamlBoolean(e){return"true"===e||"True"===e||"TRUE"===e}function isBoolean(e){return"[object Boolean]"===Object.prototype.toString.call(e)}var Type=require("../type");module.exports=new Type("tag:yaml.org,2002:bool",{kind:"scalar",resolve:resolveYamlBoolean,construct:constructYamlBoolean,predicate:isBoolean,represent:{lowercase:function(e){return e?"true":"false"},uppercase:function(e){return e?"TRUE":"FALSE"},camelcase:function(e){return e?"True":"False"}},defaultStyle:"lowercase"});
},{"../type":51}],54:[function(require,module,exports){
"use strict";function resolveYamlFloat(e){return null===e?!1:!!YAML_FLOAT_PATTERN.test(e)}function constructYamlFloat(e){var r,t,a,n;return r=e.replace(/_/g,"").toLowerCase(),t="-"===r[0]?-1:1,n=[],"+-".indexOf(r[0])>=0&&(r=r.slice(1)),".inf"===r?1===t?Number.POSITIVE_INFINITY:Number.NEGATIVE_INFINITY:".nan"===r?NaN:r.indexOf(":")>=0?(r.split(":").forEach(function(e){n.unshift(parseFloat(e,10))}),r=0,a=1,n.forEach(function(e){r+=e*a,a*=60}),t*r):t*parseFloat(r,10)}function representYamlFloat(e,r){var t;if(isNaN(e))switch(r){case"lowercase":return".nan";case"uppercase":return".NAN";case"camelcase":return".NaN"}else if(Number.POSITIVE_INFINITY===e)switch(r){case"lowercase":return".inf";case"uppercase":return".INF";case"camelcase":return".Inf"}else if(Number.NEGATIVE_INFINITY===e)switch(r){case"lowercase":return"-.inf";case"uppercase":return"-.INF";case"camelcase":return"-.Inf"}else if(common.isNegativeZero(e))return"-0.0";return t=e.toString(10),SCIENTIFIC_WITHOUT_DOT.test(t)?t.replace("e",".e"):t}function isFloat(e){return"[object Number]"===Object.prototype.toString.call(e)&&(e%1!==0||common.isNegativeZero(e))}var common=require("../common"),Type=require("../type"),YAML_FLOAT_PATTERN=new RegExp("^(?:[-+]?(?:[0-9][0-9_]*)\\.[0-9_]*(?:[eE][-+][0-9]+)?|\\.[0-9_]+(?:[eE][-+][0-9]+)?|[-+]?[0-9][0-9_]*(?::[0-5]?[0-9])+\\.[0-9_]*|[-+]?\\.(?:inf|Inf|INF)|\\.(?:nan|NaN|NAN))$"),SCIENTIFIC_WITHOUT_DOT=/^[-+]?[0-9]+e/;module.exports=new Type("tag:yaml.org,2002:float",{kind:"scalar",resolve:resolveYamlFloat,construct:constructYamlFloat,predicate:isFloat,represent:representYamlFloat,defaultStyle:"lowercase"});
},{"../common":40,"../type":51}],55:[function(require,module,exports){
"use strict";function isHexCode(e){return e>=48&&57>=e||e>=65&&70>=e||e>=97&&102>=e}function isOctCode(e){return e>=48&&55>=e}function isDecCode(e){return e>=48&&57>=e}function resolveYamlInteger(e){if(null===e)return!1;var r,t=e.length,n=0,i=!1;if(!t)return!1;if(r=e[n],"-"!==r&&"+"!==r||(r=e[++n]),"0"===r){if(n+1===t)return!0;if(r=e[++n],"b"===r){for(n++;t>n;n++)if(r=e[n],"_"!==r){if("0"!==r&&"1"!==r)return!1;i=!0}return i}if("x"===r){for(n++;t>n;n++)if(r=e[n],"_"!==r){if(!isHexCode(e.charCodeAt(n)))return!1;i=!0}return i}for(;t>n;n++)if(r=e[n],"_"!==r){if(!isOctCode(e.charCodeAt(n)))return!1;i=!0}return i}for(;t>n;n++)if(r=e[n],"_"!==r){if(":"===r)break;if(!isDecCode(e.charCodeAt(n)))return!1;i=!0}return i?":"!==r?!0:/^(:[0-5]?[0-9])+$/.test(e.slice(n)):!1}function constructYamlInteger(e){var r,t,n=e,i=1,o=[];return-1!==n.indexOf("_")&&(n=n.replace(/_/g,"")),r=n[0],"-"!==r&&"+"!==r||("-"===r&&(i=-1),n=n.slice(1),r=n[0]),"0"===n?0:"0"===r?"b"===n[1]?i*parseInt(n.slice(2),2):"x"===n[1]?i*parseInt(n,16):i*parseInt(n,8):-1!==n.indexOf(":")?(n.split(":").forEach(function(e){o.unshift(parseInt(e,10))}),n=0,t=1,o.forEach(function(e){n+=e*t,t*=60}),i*n):i*parseInt(n,10)}function isInteger(e){return"[object Number]"===Object.prototype.toString.call(e)&&e%1===0&&!common.isNegativeZero(e)}var common=require("../common"),Type=require("../type");module.exports=new Type("tag:yaml.org,2002:int",{kind:"scalar",resolve:resolveYamlInteger,construct:constructYamlInteger,predicate:isInteger,represent:{binary:function(e){return"0b"+e.toString(2)},octal:function(e){return"0"+e.toString(8)},decimal:function(e){return e.toString(10)},hexadecimal:function(e){return"0x"+e.toString(16).toUpperCase()}},defaultStyle:"decimal",styleAliases:{binary:[2,"bin"],octal:[8,"oct"],decimal:[10,"dec"],hexadecimal:[16,"hex"]}});
},{"../common":40,"../type":51}],56:[function(require,module,exports){
"use strict";function resolveJavascriptFunction(e){if(null===e)return!1;try{var r="("+e+")",n=esprima.parse(r,{range:!0});return"Program"===n.type&&1===n.body.length&&"ExpressionStatement"===n.body[0].type&&"FunctionExpression"===n.body[0].expression.type}catch(t){return!1}}function constructJavascriptFunction(e){var r,n="("+e+")",t=esprima.parse(n,{range:!0}),o=[];if("Program"!==t.type||1!==t.body.length||"ExpressionStatement"!==t.body[0].type||"FunctionExpression"!==t.body[0].expression.type)throw new Error("Failed to resolve function");return t.body[0].expression.params.forEach(function(e){o.push(e.name)}),r=t.body[0].expression.body.range,new Function(o,n.slice(r[0]+1,r[1]-1))}function representJavascriptFunction(e){return e.toString()}function isFunction(e){return"[object Function]"===Object.prototype.toString.call(e)}var esprima;try{var _require=require;esprima=_require("esprima")}catch(_){"undefined"!=typeof window&&(esprima=window.esprima)}var Type=require("../../type");module.exports=new Type("tag:yaml.org,2002:js/function",{kind:"scalar",resolve:resolveJavascriptFunction,construct:constructJavascriptFunction,predicate:isFunction,represent:representJavascriptFunction});
},{"../../type":51}],57:[function(require,module,exports){
"use strict";function resolveJavascriptRegExp(e){if(null===e)return!1;if(0===e.length)return!1;var r=e,t=/\/([gim]*)$/.exec(e),n="";if("/"===r[0]){if(t&&(n=t[1]),n.length>3)return!1;if("/"!==r[r.length-n.length-1])return!1}return!0}function constructJavascriptRegExp(e){var r=e,t=/\/([gim]*)$/.exec(e),n="";return"/"===r[0]&&(t&&(n=t[1]),r=r.slice(1,r.length-n.length-1)),new RegExp(r,n)}function representJavascriptRegExp(e){var r="/"+e.source+"/";return e.global&&(r+="g"),e.multiline&&(r+="m"),e.ignoreCase&&(r+="i"),r}function isRegExp(e){return"[object RegExp]"===Object.prototype.toString.call(e)}var Type=require("../../type");module.exports=new Type("tag:yaml.org,2002:js/regexp",{kind:"scalar",resolve:resolveJavascriptRegExp,construct:constructJavascriptRegExp,predicate:isRegExp,represent:representJavascriptRegExp});
},{"../../type":51}],58:[function(require,module,exports){
"use strict";function resolveJavascriptUndefined(){return!0}function constructJavascriptUndefined(){}function representJavascriptUndefined(){return""}function isUndefined(e){return"undefined"==typeof e}var Type=require("../../type");module.exports=new Type("tag:yaml.org,2002:js/undefined",{kind:"scalar",resolve:resolveJavascriptUndefined,construct:constructJavascriptUndefined,predicate:isUndefined,represent:representJavascriptUndefined});
},{"../../type":51}],59:[function(require,module,exports){
"use strict";var Type=require("../type");module.exports=new Type("tag:yaml.org,2002:map",{kind:"mapping",construct:function(e){return null!==e?e:{}}});
},{"../type":51}],60:[function(require,module,exports){
"use strict";function resolveYamlMerge(e){return"<<"===e||null===e}var Type=require("../type");module.exports=new Type("tag:yaml.org,2002:merge",{kind:"scalar",resolve:resolveYamlMerge});
},{"../type":51}],61:[function(require,module,exports){
"use strict";function resolveYamlNull(l){if(null===l)return!0;var e=l.length;return 1===e&&"~"===l||4===e&&("null"===l||"Null"===l||"NULL"===l)}function constructYamlNull(){return null}function isNull(l){return null===l}var Type=require("../type");module.exports=new Type("tag:yaml.org,2002:null",{kind:"scalar",resolve:resolveYamlNull,construct:constructYamlNull,predicate:isNull,represent:{canonical:function(){return"~"},lowercase:function(){return"null"},uppercase:function(){return"NULL"},camelcase:function(){return"Null"}},defaultStyle:"lowercase"});
},{"../type":51}],62:[function(require,module,exports){
"use strict";function resolveYamlOmap(r){if(null===r)return!0;var t,e,n,o,u,a=[],l=r;for(t=0,e=l.length;e>t;t+=1){if(n=l[t],u=!1,"[object Object]"!==_toString.call(n))return!1;for(o in n)if(_hasOwnProperty.call(n,o)){if(u)return!1;u=!0}if(!u)return!1;if(-1!==a.indexOf(o))return!1;a.push(o)}return!0}function constructYamlOmap(r){return null!==r?r:[]}var Type=require("../type"),_hasOwnProperty=Object.prototype.hasOwnProperty,_toString=Object.prototype.toString;module.exports=new Type("tag:yaml.org,2002:omap",{kind:"sequence",resolve:resolveYamlOmap,construct:constructYamlOmap});
},{"../type":51}],63:[function(require,module,exports){
"use strict";function resolveYamlPairs(r){if(null===r)return!0;var e,t,n,l,o,a=r;for(o=new Array(a.length),e=0,t=a.length;t>e;e+=1){if(n=a[e],"[object Object]"!==_toString.call(n))return!1;if(l=Object.keys(n),1!==l.length)return!1;o[e]=[l[0],n[l[0]]]}return!0}function constructYamlPairs(r){if(null===r)return[];var e,t,n,l,o,a=r;for(o=new Array(a.length),e=0,t=a.length;t>e;e+=1)n=a[e],l=Object.keys(n),o[e]=[l[0],n[l[0]]];return o}var Type=require("../type"),_toString=Object.prototype.toString;module.exports=new Type("tag:yaml.org,2002:pairs",{kind:"sequence",resolve:resolveYamlPairs,construct:constructYamlPairs});
},{"../type":51}],64:[function(require,module,exports){
"use strict";var Type=require("../type");module.exports=new Type("tag:yaml.org,2002:seq",{kind:"sequence",construct:function(e){return null!==e?e:[]}});
},{"../type":51}],65:[function(require,module,exports){
"use strict";function resolveYamlSet(e){if(null===e)return!0;var r,t=e;for(r in t)if(_hasOwnProperty.call(t,r)&&null!==t[r])return!1;return!0}function constructYamlSet(e){return null!==e?e:{}}var Type=require("../type"),_hasOwnProperty=Object.prototype.hasOwnProperty;module.exports=new Type("tag:yaml.org,2002:set",{kind:"mapping",resolve:resolveYamlSet,construct:constructYamlSet});
},{"../type":51}],66:[function(require,module,exports){
"use strict";var Type=require("../type");module.exports=new Type("tag:yaml.org,2002:str",{kind:"scalar",construct:function(r){return null!==r?r:""}});
},{"../type":51}],67:[function(require,module,exports){
"use strict";function resolveYamlTimestamp(e){return null===e?!1:null!==YAML_DATE_REGEXP.exec(e)?!0:null!==YAML_TIMESTAMP_REGEXP.exec(e)}function constructYamlTimestamp(e){var t,r,n,l,a,m,s,T,i,E,u=0,o=null;if(t=YAML_DATE_REGEXP.exec(e),null===t&&(t=YAML_TIMESTAMP_REGEXP.exec(e)),null===t)throw new Error("Date resolve error");if(r=+t[1],n=+t[2]-1,l=+t[3],!t[4])return new Date(Date.UTC(r,n,l));if(a=+t[4],m=+t[5],s=+t[6],t[7]){for(u=t[7].slice(0,3);u.length<3;)u+="0";u=+u}return t[9]&&(T=+t[10],i=+(t[11]||0),o=6e4*(60*T+i),"-"===t[9]&&(o=-o)),E=new Date(Date.UTC(r,n,l,a,m,s,u)),o&&E.setTime(E.getTime()-o),E}function representYamlTimestamp(e){return e.toISOString()}var Type=require("../type"),YAML_DATE_REGEXP=new RegExp("^([0-9][0-9][0-9][0-9])-([0-9][0-9])-([0-9][0-9])$"),YAML_TIMESTAMP_REGEXP=new RegExp("^([0-9][0-9][0-9][0-9])-([0-9][0-9]?)-([0-9][0-9]?)(?:[Tt]|[ \\t]+)([0-9][0-9]?):([0-9][0-9]):([0-9][0-9])(?:\\.([0-9]*))?(?:[ \\t]*(Z|([-+])([0-9][0-9]?)(?::([0-9][0-9]))?))?$");module.exports=new Type("tag:yaml.org,2002:timestamp",{kind:"scalar",resolve:resolveYamlTimestamp,construct:constructYamlTimestamp,instanceOf:Date,represent:representYamlTimestamp});
},{"../type":51}],68:[function(require,module,exports){
function parse(e){if(e=""+e,!(e.length>1e4)){var a=/^((?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|years?|yrs?|y)?$/i.exec(e);if(a){var r=parseFloat(a[1]),c=(a[2]||"ms").toLowerCase();switch(c){case"years":case"year":case"yrs":case"yr":case"y":return r*y;case"days":case"day":case"d":return r*d;case"hours":case"hour":case"hrs":case"hr":case"h":return r*h;case"minutes":case"minute":case"mins":case"min":case"m":return r*m;case"seconds":case"second":case"secs":case"sec":case"s":return r*s;case"milliseconds":case"millisecond":case"msecs":case"msec":case"ms":return r}}}}function short(e){return e>=d?Math.round(e/d)+"d":e>=h?Math.round(e/h)+"h":e>=m?Math.round(e/m)+"m":e>=s?Math.round(e/s)+"s":e+"ms"}function long(e){return plural(e,d,"day")||plural(e,h,"hour")||plural(e,m,"minute")||plural(e,s,"second")||e+" ms"}function plural(s,e,a){return e>s?void 0:1.5*e>s?Math.floor(s/e)+" "+a:Math.ceil(s/e)+" "+a+"s"}var s=1e3,m=60*s,h=60*m,d=24*h,y=365.25*d;module.exports=function(s,e){return e=e||{},"string"==typeof s?parse(s):e["long"]?long(s):short(s)};
},{}],69:[function(require,module,exports){
/**!
* Ono v2.2.1
*
* @link https://github.com/BigstickCarpet/ono
* @license MIT
*/
"use strict";function create(e){return function(r,t,o,n){var c,a=module.exports.formatter;"string"==typeof r?(c=a.apply(null,arguments),r=t=void 0):c="string"==typeof t?a.apply(null,slice.call(arguments,1)):a.apply(null,slice.call(arguments,2)),r instanceof Error||(t=r,r=void 0),r&&(c+=(c?" \n":"")+r.message);var i=new e(c);return extendError(i,r),extendToJSON(i),extend(i,t),i}}function extendError(e,r){r&&(extendStack(e,r),extend(e,r,!0))}function extendToJSON(e){e.toJSON=errorToJSON,e.inspect=errorToString}function extend(e,r,t){if(r&&"object"==typeof r)for(var o=Object.keys(r),n=0;n<o.length;n++){var c=o[n];if(!(t&&vendorSpecificErrorProperties.indexOf(c)>=0))try{e[c]=r[c]}catch(a){}}}function errorToJSON(){var e={},r=Object.keys(this);r=r.concat(vendorSpecificErrorProperties);for(var t=0;t<r.length;t++){var o=r[t],n=this[o],c=typeof n;"undefined"!==c&&"function"!==c&&(e[o]=n)}return e}function errorToString(){return JSON.stringify(this,null,2).replace(/\\n/g,"\n")}function extendStack(e,r){if(hasLazyStack(r))extendStackProperty(e,r);else{var t=r.stack;t&&(e.stack+=" \n\n"+r.stack)}}function hasLazyStack(e){if(!supportsLazyStack)return!1;var r=Object.getOwnPropertyDescriptor(e,"stack");return r?"function"==typeof r.get:!1}function extendStackProperty(e,r){var t=Object.getOwnPropertyDescriptor(r,"stack");if(t){var o=Object.getOwnPropertyDescriptor(e,"stack");Object.defineProperty(e,"stack",{get:function(){return o.get.apply(e)+" \n\n"+r.stack},enumerable:!1,configurable:!0})}}var util=require("util"),slice=Array.prototype.slice,vendorSpecificErrorProperties=["name","message","description","number","fileName","lineNumber","columnNumber","sourceURL","line","column","stack"];module.exports=create(Error),module.exports.error=create(Error),module.exports.eval=create(EvalError),module.exports.range=create(RangeError),module.exports.reference=create(ReferenceError),module.exports.syntax=create(SyntaxError),module.exports.type=create(TypeError),module.exports.uri=create(URIError),module.exports.formatter=util.format;var supportsLazyStack=function(){return!(!Object.getOwnPropertyDescriptor||!Object.defineProperty||"undefined"!=typeof navigator&&/Android/.test(navigator.userAgent))}();
},{"util":97}],70:[function(require,module,exports){
(function (process){
"use strict";function nextTick(e){for(var s=new Array(arguments.length-1),n=0;n<s.length;)s[n++]=arguments[n];process.nextTick(function(){e.apply(null,s)})}!process.version||0===process.version.indexOf("v0.")||0===process.version.indexOf("v1.")&&0!==process.version.indexOf("v1.8.")?module.exports=nextTick:module.exports=process.nextTick;
}).call(this,require('_process'))
},{"_process":71}],71:[function(require,module,exports){
function cleanUpNextTick(){draining=!1,currentQueue.length?queue=currentQueue.concat(queue):queueIndex=-1,queue.length&&drainQueue()}function drainQueue(){if(!draining){var e=setTimeout(cleanUpNextTick);draining=!0;for(var n=queue.length;n;){for(currentQueue=queue,queue=[];++queueIndex<n;)currentQueue&&currentQueue[queueIndex].run();queueIndex=-1,n=queue.length}currentQueue=null,draining=!1,clearTimeout(e)}}function Item(e,n){this.fun=e,this.array=n}function noop(){}var process=module.exports={},queue=[],draining=!1,currentQueue,queueIndex=-1;process.nextTick=function(e){var n=new Array(arguments.length-1);if(arguments.length>1)for(var r=1;r<arguments.length;r++)n[r-1]=arguments[r];queue.push(new Item(e,n)),1!==queue.length||draining||setTimeout(drainQueue,0)},Item.prototype.run=function(){this.fun.apply(null,this.array)},process.title="browser",process.browser=!0,process.env={},process.argv=[],process.version="",process.versions={},process.on=noop,process.addListener=noop,process.once=noop,process.off=noop,process.removeListener=noop,process.removeAllListeners=noop,process.emit=noop,process.binding=function(e){throw new Error("process.binding is not supported")},process.cwd=function(){return"/"},process.chdir=function(e){throw new Error("process.chdir is not supported")},process.umask=function(){return 0};
},{}],72:[function(require,module,exports){
(function (global){
/*! https://mths.be/punycode v1.4.1 by @mathias */
!function(e){function o(e){throw new RangeError(T[e])}function n(e,o){for(var n=e.length,r=[];n--;)r[n]=o(e[n]);return r}function r(e,o){var r=e.split("@"),t="";r.length>1&&(t=r[0]+"@",e=r[1]),e=e.replace(S,".");var u=e.split("."),i=n(u,o).join(".");return t+i}function t(e){for(var o,n,r=[],t=0,u=e.length;u>t;)o=e.charCodeAt(t++),o>=55296&&56319>=o&&u>t?(n=e.charCodeAt(t++),56320==(64512&n)?r.push(((1023&o)<<10)+(1023&n)+65536):(r.push(o),t--)):r.push(o);return r}function u(e){return n(e,function(e){var o="";return e>65535&&(e-=65536,o+=P(e>>>10&1023|55296),e=56320|1023&e),o+=P(e)}).join("")}function i(e){return 10>e-48?e-22:26>e-65?e-65:26>e-97?e-97:b}function f(e,o){return e+22+75*(26>e)-((0!=o)<<5)}function c(e,o,n){var r=0;for(e=n?M(e/j):e>>1,e+=M(e/o);e>L*C>>1;r+=b)e=M(e/L);return M(r+(L+1)*e/(e+m))}function l(e){var n,r,t,f,l,s,d,a,p,h,v=[],g=e.length,w=0,m=I,j=A;for(r=e.lastIndexOf(E),0>r&&(r=0),t=0;r>t;++t)e.charCodeAt(t)>=128&&o("not-basic"),v.push(e.charCodeAt(t));for(f=r>0?r+1:0;g>f;){for(l=w,s=1,d=b;f>=g&&o("invalid-input"),a=i(e.charCodeAt(f++)),(a>=b||a>M((x-w)/s))&&o("overflow"),w+=a*s,p=j>=d?y:d>=j+C?C:d-j,!(p>a);d+=b)h=b-p,s>M(x/h)&&o("overflow"),s*=h;n=v.length+1,j=c(w-l,n,0==l),M(w/n)>x-m&&o("overflow"),m+=M(w/n),w%=n,v.splice(w++,0,m)}return u(v)}function s(e){var n,r,u,i,l,s,d,a,p,h,v,g,w,m,j,F=[];for(e=t(e),g=e.length,n=I,r=0,l=A,s=0;g>s;++s)v=e[s],128>v&&F.push(P(v));for(u=i=F.length,i&&F.push(E);g>u;){for(d=x,s=0;g>s;++s)v=e[s],v>=n&&d>v&&(d=v);for(w=u+1,d-n>M((x-r)/w)&&o("overflow"),r+=(d-n)*w,n=d,s=0;g>s;++s)if(v=e[s],n>v&&++r>x&&o("overflow"),v==n){for(a=r,p=b;h=l>=p?y:p>=l+C?C:p-l,!(h>a);p+=b)j=a-h,m=b-h,F.push(P(f(h+j%m,0))),a=M(j/m);F.push(P(f(a,0))),l=c(r,w,u==i),r=0,++u}++r,++n}return F.join("")}function d(e){return r(e,function(e){return F.test(e)?l(e.slice(4).toLowerCase()):e})}function a(e){return r(e,function(e){return O.test(e)?"xn--"+s(e):e})}var p="object"==typeof exports&&exports&&!exports.nodeType&&exports,h="object"==typeof module&&module&&!module.nodeType&&module,v="object"==typeof global&&global;v.global!==v&&v.window!==v&&v.self!==v||(e=v);var g,w,x=2147483647,b=36,y=1,C=26,m=38,j=700,A=72,I=128,E="-",F=/^xn--/,O=/[^\x20-\x7E]/,S=/[\x2E\u3002\uFF0E\uFF61]/g,T={overflow:"Overflow: input needs wider integers to process","not-basic":"Illegal input >= 0x80 (not a basic code point)","invalid-input":"Invalid input"},L=b-y,M=Math.floor,P=String.fromCharCode;if(g={version:"1.4.1",ucs2:{decode:t,encode:u},decode:l,encode:s,toASCII:a,toUnicode:d},"function"==typeof define&&"object"==typeof define.amd&&define.amd)define("punycode",function(){return g});else if(p&&h)if(module.exports==p)h.exports=g;else for(w in g)g.hasOwnProperty(w)&&(p[w]=g[w]);else e.punycode=g}(this);
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{}],73:[function(require,module,exports){
"use strict";function hasOwnProperty(r,e){return Object.prototype.hasOwnProperty.call(r,e)}module.exports=function(r,e,t,n){e=e||"&",t=t||"=";var o={};if("string"!=typeof r||0===r.length)return o;var a=/\+/g;r=r.split(e);var s=1e3;n&&"number"==typeof n.maxKeys&&(s=n.maxKeys);var p=r.length;s>0&&p>s&&(p=s);for(var y=0;p>y;++y){var u,c,i,l,f=r[y].replace(a,"%20"),v=f.indexOf(t);v>=0?(u=f.substr(0,v),c=f.substr(v+1)):(u=f,c=""),i=decodeURIComponent(u),l=decodeURIComponent(c),hasOwnProperty(o,i)?isArray(o[i])?o[i].push(l):o[i]=[o[i],l]:o[i]=l}return o};var isArray=Array.isArray||function(r){return"[object Array]"===Object.prototype.toString.call(r)};
},{}],74:[function(require,module,exports){
"use strict";function map(r,e){if(r.map)return r.map(e);for(var t=[],n=0;n<r.length;n++)t.push(e(r[n],n));return t}var stringifyPrimitive=function(r){switch(typeof r){case"string":return r;case"boolean":return r?"true":"false";case"number":return isFinite(r)?r:"";default:return""}};module.exports=function(r,e,t,n){return e=e||"&",t=t||"=",null===r&&(r=void 0),"object"==typeof r?map(objectKeys(r),function(n){var i=encodeURIComponent(stringifyPrimitive(n))+t;return isArray(r[n])?map(r[n],function(r){return i+encodeURIComponent(stringifyPrimitive(r))}).join(e):i+encodeURIComponent(stringifyPrimitive(r[n]))}).join(e):n?encodeURIComponent(stringifyPrimitive(n))+t+encodeURIComponent(stringifyPrimitive(r)):""};var isArray=Array.isArray||function(r){return"[object Array]"===Object.prototype.toString.call(r)},objectKeys=Object.keys||function(r){var e=[];for(var t in r)Object.prototype.hasOwnProperty.call(r,t)&&e.push(t);return e};
},{}],75:[function(require,module,exports){
"use strict";exports.decode=exports.parse=require("./decode"),exports.encode=exports.stringify=require("./encode");
},{"./decode":73,"./encode":74}],76:[function(require,module,exports){
module.exports=require("./lib/_stream_duplex.js");
},{"./lib/_stream_duplex.js":77}],77:[function(require,module,exports){
"use strict";function Duplex(e){return this instanceof Duplex?(Readable.call(this,e),Writable.call(this,e),e&&e.readable===!1&&(this.readable=!1),e&&e.writable===!1&&(this.writable=!1),this.allowHalfOpen=!0,e&&e.allowHalfOpen===!1&&(this.allowHalfOpen=!1),void this.once("end",onend)):new Duplex(e)}function onend(){this.allowHalfOpen||this._writableState.ended||processNextTick(onEndNT,this)}function onEndNT(e){e.end()}function forEach(e,t){for(var r=0,i=e.length;i>r;r++)t(e[r],r)}var objectKeys=Object.keys||function(e){var t=[];for(var r in e)t.push(r);return t};module.exports=Duplex;var processNextTick=require("process-nextick-args"),util=require("core-util-is");util.inherits=require("inherits");var Readable=require("./_stream_readable"),Writable=require("./_stream_writable");util.inherits(Duplex,Readable);for(var keys=objectKeys(Writable.prototype),v=0;v<keys.length;v++){var method=keys[v];Duplex.prototype[method]||(Duplex.prototype[method]=Writable.prototype[method])}
},{"./_stream_readable":79,"./_stream_writable":81,"core-util-is":28,"inherits":35,"process-nextick-args":70}],78:[function(require,module,exports){
"use strict";function PassThrough(r){return this instanceof PassThrough?void Transform.call(this,r):new PassThrough(r)}module.exports=PassThrough;var Transform=require("./_stream_transform"),util=require("core-util-is");util.inherits=require("inherits"),util.inherits(PassThrough,Transform),PassThrough.prototype._transform=function(r,s,i){i(null,r)};
},{"./_stream_transform":80,"core-util-is":28,"inherits":35}],79:[function(require,module,exports){
(function (process){
"use strict";function ReadableState(e,t){Duplex=Duplex||require("./_stream_duplex"),e=e||{},this.objectMode=!!e.objectMode,t instanceof Duplex&&(this.objectMode=this.objectMode||!!e.readableObjectMode);var r=e.highWaterMark,n=this.objectMode?16:16384;this.highWaterMark=r||0===r?r:n,this.highWaterMark=~~this.highWaterMark,this.buffer=[],this.length=0,this.pipes=null,this.pipesCount=0,this.flowing=null,this.ended=!1,this.endEmitted=!1,this.reading=!1,this.sync=!0,this.needReadable=!1,this.emittedReadable=!1,this.readableListening=!1,this.resumeScheduled=!1,this.defaultEncoding=e.defaultEncoding||"utf8",this.ranOut=!1,this.awaitDrain=0,this.readingMore=!1,this.decoder=null,this.encoding=null,e.encoding&&(StringDecoder||(StringDecoder=require("string_decoder/").StringDecoder),this.decoder=new StringDecoder(e.encoding),this.encoding=e.encoding)}function Readable(e){return Duplex=Duplex||require("./_stream_duplex"),this instanceof Readable?(this._readableState=new ReadableState(e,this),this.readable=!0,e&&"function"==typeof e.read&&(this._read=e.read),void Stream.call(this)):new Readable(e)}function readableAddChunk(e,t,r,n,a){var i=chunkInvalid(t,r);if(i)e.emit("error",i);else if(null===r)t.reading=!1,onEofChunk(e,t);else if(t.objectMode||r&&r.length>0)if(t.ended&&!a){var d=new Error("stream.push() after EOF");e.emit("error",d)}else if(t.endEmitted&&a){var d=new Error("stream.unshift() after end event");e.emit("error",d)}else{var o;!t.decoder||a||n||(r=t.decoder.write(r),o=!t.objectMode&&0===r.length),a||(t.reading=!1),o||(t.flowing&&0===t.length&&!t.sync?(e.emit("data",r),e.read(0)):(t.length+=t.objectMode?1:r.length,a?t.buffer.unshift(r):t.buffer.push(r),t.needReadable&&emitReadable(e))),maybeReadMore(e,t)}else a||(t.reading=!1);return needMoreData(t)}function needMoreData(e){return!e.ended&&(e.needReadable||e.length<e.highWaterMark||0===e.length)}function computeNewHighWaterMark(e){return e>=MAX_HWM?e=MAX_HWM:(e--,e|=e>>>1,e|=e>>>2,e|=e>>>4,e|=e>>>8,e|=e>>>16,e++),e}function howMuchToRead(e,t){return 0===t.length&&t.ended?0:t.objectMode?0===e?0:1:null===e||isNaN(e)?t.flowing&&t.buffer.length?t.buffer[0].length:t.length:0>=e?0:(e>t.highWaterMark&&(t.highWaterMark=computeNewHighWaterMark(e)),e>t.length?t.ended?t.length:(t.needReadable=!0,0):e)}function chunkInvalid(e,t){var r=null;return Buffer.isBuffer(t)||"string"==typeof t||null===t||void 0===t||e.objectMode||(r=new TypeError("Invalid non-string/buffer chunk")),r}function onEofChunk(e,t){if(!t.ended){if(t.decoder){var r=t.decoder.end();r&&r.length&&(t.buffer.push(r),t.length+=t.objectMode?1:r.length)}t.ended=!0,emitReadable(e)}}function emitReadable(e){var t=e._readableState;t.needReadable=!1,t.emittedReadable||(debug("emitReadable",t.flowing),t.emittedReadable=!0,t.sync?processNextTick(emitReadable_,e):emitReadable_(e))}function emitReadable_(e){debug("emit readable"),e.emit("readable"),flow(e)}function maybeReadMore(e,t){t.readingMore||(t.readingMore=!0,processNextTick(maybeReadMore_,e,t))}function maybeReadMore_(e,t){for(var r=t.length;!t.reading&&!t.flowing&&!t.ended&&t.length<t.highWaterMark&&(debug("maybeReadMore read 0"),e.read(0),r!==t.length);)r=t.length;t.readingMore=!1}function pipeOnDrain(e){return function(){var t=e._readableState;debug("pipeOnDrain",t.awaitDrain),t.awaitDrain&&t.awaitDrain--,0===t.awaitDrain&&EElistenerCount(e,"data")&&(t.flowing=!0,flow(e))}}function nReadingNextTick(e){debug("readable nexttick read 0"),e.read(0)}function resume(e,t){t.resumeScheduled||(t.resumeScheduled=!0,processNextTick(resume_,e,t))}function resume_(e,t){t.reading||(debug("resume read 0"),e.read(0)),t.resumeScheduled=!1,e.emit("resume"),flow(e),t.flowing&&!t.reading&&e.read(0)}function flow(e){var t=e._readableState;if(debug("flow",t.flowing),t.flowing)do var r=e.read();while(null!==r&&t.flowing)}function fromList(e,t){var r,n=t.buffer,a=t.length,i=!!t.decoder,d=!!t.objectMode;if(0===n.length)return null;if(0===a)r=null;else if(d)r=n.shift();else if(!e||e>=a)r=i?n.join(""):1===n.length?n[0]:Buffer.concat(n,a),n.length=0;else if(e<n[0].length){var o=n[0];r=o.slice(0,e),
}).call(this,require('_process'))
},{"./_stream_duplex":77,"_process":71,"buffer":25,"core-util-is":28,"events":32,"inherits":35,"isarray":37,"process-nextick-args":70,"stream":86,"string_decoder/":91,"util":23}],80:[function(require,module,exports){
"use strict";function TransformState(r){this.afterTransform=function(t,n){return afterTransform(r,t,n)},this.needTransform=!1,this.transforming=!1,this.writecb=null,this.writechunk=null,this.writeencoding=null}function afterTransform(r,t,n){var e=r._transformState;e.transforming=!1;var i=e.writecb;if(!i)return r.emit("error",new Error("no writecb in Transform class"));e.writechunk=null,e.writecb=null,null!==n&&void 0!==n&&r.push(n),i(t);var a=r._readableState;a.reading=!1,(a.needReadable||a.length<a.highWaterMark)&&r._read(a.highWaterMark)}function Transform(r){if(!(this instanceof Transform))return new Transform(r);Duplex.call(this,r),this._transformState=new TransformState(this);var t=this;this._readableState.needReadable=!0,this._readableState.sync=!1,r&&("function"==typeof r.transform&&(this._transform=r.transform),"function"==typeof r.flush&&(this._flush=r.flush)),this.once("prefinish",function(){"function"==typeof this._flush?this._flush(function(r){done(t,r)}):done(t)})}function done(r,t){if(t)return r.emit("error",t);var n=r._writableState,e=r._transformState;if(n.length)throw new Error("calling transform done when ws.length != 0");if(e.transforming)throw new Error("calling transform done when still transforming");return r.push(null)}module.exports=Transform;var Duplex=require("./_stream_duplex"),util=require("core-util-is");util.inherits=require("inherits"),util.inherits(Transform,Duplex),Transform.prototype.push=function(r,t){return this._transformState.needTransform=!1,Duplex.prototype.push.call(this,r,t)},Transform.prototype._transform=function(r,t,n){throw new Error("not implemented")},Transform.prototype._write=function(r,t,n){var e=this._transformState;if(e.writecb=n,e.writechunk=r,e.writeencoding=t,!e.transforming){var i=this._readableState;(e.needTransform||i.needReadable||i.length<i.highWaterMark)&&this._read(i.highWaterMark)}},Transform.prototype._read=function(r){var t=this._transformState;null!==t.writechunk&&t.writecb&&!t.transforming?(t.transforming=!0,this._transform(t.writechunk,t.writeencoding,t.afterTransform)):t.needTransform=!0};
},{"./_stream_duplex":77,"core-util-is":28,"inherits":35}],81:[function(require,module,exports){
(function (process){
"use strict";function nop(){}function WriteReq(e,t,r){this.chunk=e,this.encoding=t,this.callback=r,this.next=null}function WritableState(e,t){Duplex=Duplex||require("./_stream_duplex"),e=e||{},this.objectMode=!!e.objectMode,t instanceof Duplex&&(this.objectMode=this.objectMode||!!e.writableObjectMode);var r=e.highWaterMark,i=this.objectMode?16:16384;this.highWaterMark=r||0===r?r:i,this.highWaterMark=~~this.highWaterMark,this.needDrain=!1,this.ending=!1,this.ended=!1,this.finished=!1;var n=e.decodeStrings===!1;this.decodeStrings=!n,this.defaultEncoding=e.defaultEncoding||"utf8",this.length=0,this.writing=!1,this.corked=0,this.sync=!0,this.bufferProcessing=!1,this.onwrite=function(e){onwrite(t,e)},this.writecb=null,this.writelen=0,this.bufferedRequest=null,this.lastBufferedRequest=null,this.pendingcb=0,this.prefinished=!1,this.errorEmitted=!1,this.bufferedRequestCount=0,this.corkedRequestsFree=new CorkedRequest(this),this.corkedRequestsFree.next=new CorkedRequest(this)}function Writable(e){return Duplex=Duplex||require("./_stream_duplex"),this instanceof Writable||this instanceof Duplex?(this._writableState=new WritableState(e,this),this.writable=!0,e&&("function"==typeof e.write&&(this._write=e.write),"function"==typeof e.writev&&(this._writev=e.writev)),void Stream.call(this)):new Writable(e)}function writeAfterEnd(e,t){var r=new Error("write after end");e.emit("error",r),processNextTick(t,r)}function validChunk(e,t,r,i){var n=!0;if(!Buffer.isBuffer(r)&&"string"!=typeof r&&null!==r&&void 0!==r&&!t.objectMode){var s=new TypeError("Invalid non-string/buffer chunk");e.emit("error",s),processNextTick(i,s),n=!1}return n}function decodeChunk(e,t,r){return e.objectMode||e.decodeStrings===!1||"string"!=typeof t||(t=new Buffer(t,r)),t}function writeOrBuffer(e,t,r,i,n){r=decodeChunk(t,r,i),Buffer.isBuffer(r)&&(i="buffer");var s=t.objectMode?1:r.length;t.length+=s;var f=t.length<t.highWaterMark;if(f||(t.needDrain=!0),t.writing||t.corked){var u=t.lastBufferedRequest;t.lastBufferedRequest=new WriteReq(r,i,n),u?u.next=t.lastBufferedRequest:t.bufferedRequest=t.lastBufferedRequest,t.bufferedRequestCount+=1}else doWrite(e,t,!1,s,r,i,n);return f}function doWrite(e,t,r,i,n,s,f){t.writelen=i,t.writecb=f,t.writing=!0,t.sync=!0,r?e._writev(n,t.onwrite):e._write(n,s,t.onwrite),t.sync=!1}function onwriteError(e,t,r,i,n){--t.pendingcb,r?processNextTick(n,i):n(i),e._writableState.errorEmitted=!0,e.emit("error",i)}function onwriteStateUpdate(e){e.writing=!1,e.writecb=null,e.length-=e.writelen,e.writelen=0}function onwrite(e,t){var r=e._writableState,i=r.sync,n=r.writecb;if(onwriteStateUpdate(r),t)onwriteError(e,r,i,t,n);else{var s=needFinish(r);s||r.corked||r.bufferProcessing||!r.bufferedRequest||clearBuffer(e,r),i?asyncWrite(afterWrite,e,r,s,n):afterWrite(e,r,s,n)}}function afterWrite(e,t,r,i){r||onwriteDrain(e,t),t.pendingcb--,i(),finishMaybe(e,t)}function onwriteDrain(e,t){0===t.length&&t.needDrain&&(t.needDrain=!1,e.emit("drain"))}function clearBuffer(e,t){t.bufferProcessing=!0;var r=t.bufferedRequest;if(e._writev&&r&&r.next){var i=t.bufferedRequestCount,n=new Array(i),s=t.corkedRequestsFree;s.entry=r;for(var f=0;r;)n[f]=r,r=r.next,f+=1;doWrite(e,t,!0,t.length,n,"",s.finish),t.pendingcb++,t.lastBufferedRequest=null,t.corkedRequestsFree=s.next,s.next=null}else{for(;r;){var u=r.chunk,o=r.encoding,a=r.callback,c=t.objectMode?1:u.length;if(doWrite(e,t,!1,c,u,o,a),r=r.next,t.writing)break}null===r&&(t.lastBufferedRequest=null)}t.bufferedRequestCount=0,t.bufferedRequest=r,t.bufferProcessing=!1}function needFinish(e){return e.ending&&0===e.length&&null===e.bufferedRequest&&!e.finished&&!e.writing}function prefinish(e,t){t.prefinished||(t.prefinished=!0,e.emit("prefinish"))}function finishMaybe(e,t){var r=needFinish(t);return r&&(0===t.pendingcb?(prefinish(e,t),t.finished=!0,e.emit("finish")):prefinish(e,t)),r}function endWritable(e,t,r){t.ending=!0,finishMaybe(e,t),r&&(t.finished?processNextTick(r):e.once("finish",r)),t.ended=!0,e.writable=!1}function CorkedRequest(e){var t=this;this.next=null,this.entry=null,this.finish=function(r){var i=t.entry;fo
}).call(this,require('_process'))
},{"./_stream_duplex":77,"_process":71,"buffer":25,"core-util-is":28,"events":32,"inherits":35,"process-nextick-args":70,"stream":86,"util-deprecate":95}],82:[function(require,module,exports){
module.exports=require("./lib/_stream_passthrough.js");
},{"./lib/_stream_passthrough.js":78}],83:[function(require,module,exports){
var Stream=function(){try{return require("stream")}catch(r){}}();exports=module.exports=require("./lib/_stream_readable.js"),exports.Stream=Stream||exports,exports.Readable=exports,exports.Writable=require("./lib/_stream_writable.js"),exports.Duplex=require("./lib/_stream_duplex.js"),exports.Transform=require("./lib/_stream_transform.js"),exports.PassThrough=require("./lib/_stream_passthrough.js");
},{"./lib/_stream_duplex.js":77,"./lib/_stream_passthrough.js":78,"./lib/_stream_readable.js":79,"./lib/_stream_transform.js":80,"./lib/_stream_writable.js":81,"stream":86}],84:[function(require,module,exports){
module.exports=require("./lib/_stream_transform.js");
},{"./lib/_stream_transform.js":80}],85:[function(require,module,exports){
module.exports=require("./lib/_stream_writable.js");
},{"./lib/_stream_writable.js":81}],86:[function(require,module,exports){
function Stream(){EE.call(this)}module.exports=Stream;var EE=require("events").EventEmitter,inherits=require("inherits");inherits(Stream,EE),Stream.Readable=require("readable-stream/readable.js"),Stream.Writable=require("readable-stream/writable.js"),Stream.Duplex=require("readable-stream/duplex.js"),Stream.Transform=require("readable-stream/transform.js"),Stream.PassThrough=require("readable-stream/passthrough.js"),Stream.Stream=Stream,Stream.prototype.pipe=function(e,r){function t(r){e.writable&&!1===e.write(r)&&m.pause&&m.pause()}function n(){m.readable&&m.resume&&m.resume()}function a(){u||(u=!0,e.end())}function o(){u||(u=!0,"function"==typeof e.destroy&&e.destroy())}function i(e){if(s(),0===EE.listenerCount(this,"error"))throw e}function s(){m.removeListener("data",t),e.removeListener("drain",n),m.removeListener("end",a),m.removeListener("close",o),m.removeListener("error",i),e.removeListener("error",i),m.removeListener("end",s),m.removeListener("close",s),e.removeListener("close",s)}var m=this;m.on("data",t),e.on("drain",n),e._isStdio||r&&r.end===!1||(m.on("end",a),m.on("close",o));var u=!1;return m.on("error",i),e.on("error",i),m.on("end",s),m.on("close",s),e.on("close",s),e.emit("pipe",m),e};
},{"events":32,"inherits":35,"readable-stream/duplex.js":76,"readable-stream/passthrough.js":82,"readable-stream/readable.js":83,"readable-stream/transform.js":84,"readable-stream/writable.js":85}],87:[function(require,module,exports){
(function (global){
var ClientRequest=require("./lib/request"),extend=require("xtend"),statusCodes=require("builtin-status-codes"),url=require("url"),http=exports;http.request=function(t,e){t="string"==typeof t?url.parse(t):extend(t);var r=-1===global.location.protocol.search(/^https?:$/)?"http:":"",s=t.protocol||r,o=t.hostname||t.host,n=t.port,u=t.path||"/";o&&-1!==o.indexOf(":")&&(o="["+o+"]"),t.url=(o?s+"//"+o:"")+(n?":"+n:"")+u,t.method=(t.method||"GET").toUpperCase(),t.headers=t.headers||{};var C=new ClientRequest(t);return e&&C.on("response",e),C},http.get=function(t,e){var r=http.request(t,e);return r.end(),r},http.Agent=function(){},http.Agent.defaultMaxSockets=4,http.STATUS_CODES=statusCodes,http.METHODS=["CHECKOUT","CONNECT","COPY","DELETE","GET","HEAD","LOCK","M-SEARCH","MERGE","MKACTIVITY","MKCOL","MOVE","NOTIFY","OPTIONS","PATCH","POST","PROPFIND","PROPPATCH","PURGE","PUT","REPORT","SEARCH","SUBSCRIBE","TRACE","UNLOCK","UNSUBSCRIBE"];
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{"./lib/request":89,"builtin-status-codes":26,"url":93,"xtend":98}],88:[function(require,module,exports){
(function (global){
function checkTypeSupport(e){try{return xhr.responseType=e,xhr.responseType===e}catch(r){}return!1}function isFunction(e){return"function"==typeof e}exports.fetch=isFunction(global.fetch)&&isFunction(global.ReadableByteStream),exports.blobConstructor=!1;try{new Blob([new ArrayBuffer(1)]),exports.blobConstructor=!0}catch(e){}var xhr=new global.XMLHttpRequest;xhr.open("GET",global.location.host?"/":"https://example.com");var haveArrayBuffer="undefined"!=typeof global.ArrayBuffer,haveSlice=haveArrayBuffer&&isFunction(global.ArrayBuffer.prototype.slice);exports.arraybuffer=haveArrayBuffer&&checkTypeSupport("arraybuffer"),exports.msstream=!exports.fetch&&haveSlice&&checkTypeSupport("ms-stream"),exports.mozchunkedarraybuffer=!exports.fetch&&haveArrayBuffer&&checkTypeSupport("moz-chunked-arraybuffer"),exports.overrideMimeType=isFunction(xhr.overrideMimeType),exports.vbArray=isFunction(global.VBArray),xhr=null;
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{}],89:[function(require,module,exports){
(function (process,global,Buffer){
function decideMode(e){return capability.fetch?"fetch":capability.mozchunkedarraybuffer?"moz-chunked-arraybuffer":capability.msstream?"ms-stream":capability.arraybuffer&&e?"arraybuffer":capability.vbArray&&e?"text:vbarray":"text"}function statusValid(e){try{var t=e.status;return null!==t&&0!==t}catch(r){return!1}}var capability=require("./capability"),inherits=require("inherits"),response=require("./response"),stream=require("stream"),toArrayBuffer=require("to-arraybuffer"),IncomingMessage=response.IncomingMessage,rStates=response.readyStates,ClientRequest=module.exports=function(e){var t=this;stream.Writable.call(t),t._opts=e,t._body=[],t._headers={},e.auth&&t.setHeader("Authorization","Basic "+new Buffer(e.auth).toString("base64")),Object.keys(e.headers).forEach(function(r){t.setHeader(r,e.headers[r])});var r;if("prefer-streaming"===e.mode)r=!1;else if("allow-wrong-content-type"===e.mode)r=!capability.overrideMimeType;else{if(e.mode&&"default"!==e.mode&&"prefer-fast"!==e.mode)throw new Error("Invalid value for opts.mode");r=!0}t._mode=decideMode(r),t.on("finish",function(){t._onFinish()})};inherits(ClientRequest,stream.Writable),ClientRequest.prototype.setHeader=function(e,t){var r=this,o=e.toLowerCase();-1===unsafeHeaders.indexOf(o)&&(r._headers[o]={name:e,value:t})},ClientRequest.prototype.getHeader=function(e){var t=this;return t._headers[e.toLowerCase()].value},ClientRequest.prototype.removeHeader=function(e){var t=this;delete t._headers[e.toLowerCase()]},ClientRequest.prototype._onFinish=function(){var e=this;if(!e._destroyed){var t,r=e._opts,o=e._headers;if("POST"!==r.method&&"PUT"!==r.method&&"PATCH"!==r.method||(t=capability.blobConstructor?new global.Blob(e._body.map(function(e){return toArrayBuffer(e)}),{type:(o["content-type"]||{}).value||""}):Buffer.concat(e._body).toString()),"fetch"===e._mode){var n=Object.keys(o).map(function(e){return[o[e].name,o[e].value]});global.fetch(e._opts.url,{method:e._opts.method,headers:n,body:t,mode:"cors",credentials:r.withCredentials?"include":"same-origin"}).then(function(t){e._fetchResponse=t,e._connect()},function(t){e.emit("error",t)})}else{var s=e._xhr=new global.XMLHttpRequest;try{s.open(e._opts.method,e._opts.url,!0)}catch(i){return void process.nextTick(function(){e.emit("error",i)})}"responseType"in s&&(s.responseType=e._mode.split(":")[0]),"withCredentials"in s&&(s.withCredentials=!!r.withCredentials),"text"===e._mode&&"overrideMimeType"in s&&s.overrideMimeType("text/plain; charset=x-user-defined"),Object.keys(o).forEach(function(e){s.setRequestHeader(o[e].name,o[e].value)}),e._response=null,s.onreadystatechange=function(){switch(s.readyState){case rStates.LOADING:case rStates.DONE:e._onXHRProgress()}},"moz-chunked-arraybuffer"===e._mode&&(s.onprogress=function(){e._onXHRProgress()}),s.onerror=function(){e._destroyed||e.emit("error",new Error("XHR error"))};try{s.send(t)}catch(i){return void process.nextTick(function(){e.emit("error",i)})}}}},ClientRequest.prototype._onXHRProgress=function(){var e=this;statusValid(e._xhr)&&!e._destroyed&&(e._response||e._connect(),e._response._onXHRProgress())},ClientRequest.prototype._connect=function(){var e=this;e._destroyed||(e._response=new IncomingMessage(e._xhr,e._fetchResponse,e._mode),e.emit("response",e._response))},ClientRequest.prototype._write=function(e,t,r){var o=this;o._body.push(e),r()},ClientRequest.prototype.abort=ClientRequest.prototype.destroy=function(){var e=this;e._destroyed=!0,e._response&&(e._response._destroyed=!0),e._xhr&&e._xhr.abort()},ClientRequest.prototype.end=function(e,t,r){var o=this;"function"==typeof e&&(r=e,e=void 0),stream.Writable.prototype.end.call(o,e,t,r)},ClientRequest.prototype.flushHeaders=function(){},ClientRequest.prototype.setTimeout=function(){},ClientRequest.prototype.setNoDelay=function(){},ClientRequest.prototype.setSocketKeepAlive=function(){};var unsafeHeaders=["accept-charset","accept-encoding","access-control-request-headers","access-control-request-method","connection","content-length","cookie","cookie2","date","dnt","expect","host","keep-alive","origin","referer","te","t
}).call(this,require('_process'),typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {},require("buffer").Buffer)
},{"./capability":88,"./response":90,"_process":71,"buffer":25,"inherits":35,"stream":86,"to-arraybuffer":92}],90:[function(require,module,exports){
(function (process,global,Buffer){
var capability=require("./capability"),inherits=require("inherits"),stream=require("stream"),rStates=exports.readyStates={UNSENT:0,OPENED:1,HEADERS_RECEIVED:2,LOADING:3,DONE:4},IncomingMessage=exports.IncomingMessage=function(e,r,s){function a(){u.read().then(function(e){if(!t._destroyed){if(e.done)return void t.push(null);t.push(new Buffer(e.value)),a()}})}var t=this;if(stream.Readable.call(t),t._mode=s,t.headers={},t.rawHeaders=[],t.trailers={},t.rawTrailers=[],t.on("end",function(){process.nextTick(function(){t.emit("close")})}),"fetch"===s){t._fetchResponse=r,t.statusCode=r.status,t.statusMessage=r.statusText;for(var n,o,i=r.headers[Symbol.iterator]();n=(o=i.next()).value,!o.done;)t.headers[n[0].toLowerCase()]=n[1],t.rawHeaders.push(n[0],n[1]);var u=r.body.getReader();a()}else{t._xhr=e,t._pos=0,t.statusCode=e.status,t.statusMessage=e.statusText;var h=e.getAllResponseHeaders().split(/\r?\n/);if(h.forEach(function(e){var r=e.match(/^([^:]+):\s*(.*)/);if(r){var s=r[1].toLowerCase();"set-cookie"===s?(void 0===t.headers[s]&&(t.headers[s]=[]),t.headers[s].push(r[2])):void 0!==t.headers[s]?t.headers[s]+=", "+r[2]:t.headers[s]=r[2],t.rawHeaders.push(r[1],r[2])}}),t._charset="x-user-defined",!capability.overrideMimeType){var d=t.rawHeaders["mime-type"];if(d){var f=d.match(/;\s*charset=([^;])(;|$)/);f&&(t._charset=f[1].toLowerCase())}t._charset||(t._charset="utf-8")}}};inherits(IncomingMessage,stream.Readable),IncomingMessage.prototype._read=function(){},IncomingMessage.prototype._onXHRProgress=function(){var e=this,r=e._xhr,s=null;switch(e._mode){case"text:vbarray":if(r.readyState!==rStates.DONE)break;try{s=new global.VBArray(r.responseBody).toArray()}catch(a){}if(null!==s){e.push(new Buffer(s));break}case"text":try{s=r.responseText}catch(a){e._mode="text:vbarray";break}if(s.length>e._pos){var t=s.substr(e._pos);if("x-user-defined"===e._charset){for(var n=new Buffer(t.length),o=0;o<t.length;o++)n[o]=255&t.charCodeAt(o);e.push(n)}else e.push(t,e._charset);e._pos=s.length}break;case"arraybuffer":if(r.readyState!==rStates.DONE)break;s=r.response,e.push(new Buffer(new Uint8Array(s)));break;case"moz-chunked-arraybuffer":if(s=r.response,r.readyState!==rStates.LOADING||!s)break;e.push(new Buffer(new Uint8Array(s)));break;case"ms-stream":if(s=r.response,r.readyState!==rStates.LOADING)break;var i=new global.MSStreamReader;i.onprogress=function(){i.result.byteLength>e._pos&&(e.push(new Buffer(new Uint8Array(i.result.slice(e._pos)))),e._pos=i.result.byteLength)},i.onload=function(){e.push(null)},i.readAsArrayBuffer(s)}e._xhr.readyState===rStates.DONE&&"ms-stream"!==e._mode&&e.push(null)};
}).call(this,require('_process'),typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {},require("buffer").Buffer)
},{"./capability":88,"_process":71,"buffer":25,"inherits":35,"stream":86}],91:[function(require,module,exports){
function assertEncoding(e){if(e&&!isBufferEncoding(e))throw new Error("Unknown encoding: "+e)}function passThroughWrite(e){return e.toString(this.encoding)}function utf16DetectIncompleteChar(e){this.charReceived=e.length%2,this.charLength=this.charReceived?2:0}function base64DetectIncompleteChar(e){this.charReceived=e.length%3,this.charLength=this.charReceived?3:0}var Buffer=require("buffer").Buffer,isBufferEncoding=Buffer.isEncoding||function(e){switch(e&&e.toLowerCase()){case"hex":case"utf8":case"utf-8":case"ascii":case"binary":case"base64":case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":case"raw":return!0;default:return!1}},StringDecoder=exports.StringDecoder=function(e){switch(this.encoding=(e||"utf8").toLowerCase().replace(/[-_]/,""),assertEncoding(e),this.encoding){case"utf8":this.surrogateSize=3;break;case"ucs2":case"utf16le":this.surrogateSize=2,this.detectIncompleteChar=utf16DetectIncompleteChar;break;case"base64":this.surrogateSize=3,this.detectIncompleteChar=base64DetectIncompleteChar;break;default:return void(this.write=passThroughWrite)}this.charBuffer=new Buffer(6),this.charReceived=0,this.charLength=0};StringDecoder.prototype.write=function(e){for(var t="";this.charLength;){var r=e.length>=this.charLength-this.charReceived?this.charLength-this.charReceived:e.length;if(e.copy(this.charBuffer,this.charReceived,0,r),this.charReceived+=r,this.charReceived<this.charLength)return"";e=e.slice(r,e.length),t=this.charBuffer.slice(0,this.charLength).toString(this.encoding);var h=t.charCodeAt(t.length-1);if(!(h>=55296&&56319>=h)){if(this.charReceived=this.charLength=0,0===e.length)return t;break}this.charLength+=this.surrogateSize,t=""}this.detectIncompleteChar(e);var i=e.length;this.charLength&&(e.copy(this.charBuffer,0,e.length-this.charReceived,i),i-=this.charReceived),t+=e.toString(this.encoding,0,i);var i=t.length-1,h=t.charCodeAt(i);if(h>=55296&&56319>=h){var c=this.surrogateSize;return this.charLength+=c,this.charReceived+=c,this.charBuffer.copy(this.charBuffer,c,0,c),e.copy(this.charBuffer,0,0,c),t.substring(0,i)}return t},StringDecoder.prototype.detectIncompleteChar=function(e){for(var t=e.length>=3?3:e.length;t>0;t--){var r=e[e.length-t];if(1==t&&r>>5==6){this.charLength=2;break}if(2>=t&&r>>4==14){this.charLength=3;break}if(3>=t&&r>>3==30){this.charLength=4;break}}this.charReceived=t},StringDecoder.prototype.end=function(e){var t="";if(e&&e.length&&(t=this.write(e)),this.charReceived){var r=this.charReceived,h=this.charBuffer,i=this.encoding;t+=h.slice(0,r).toString(i)}return t};
},{"buffer":25}],92:[function(require,module,exports){
var Buffer=require("buffer").Buffer;module.exports=function(e){if(e instanceof Uint8Array){if(0===e.byteOffset&&e.byteLength===e.buffer.byteLength)return e.buffer;if("function"==typeof e.buffer.slice)return e.buffer.slice(e.byteOffset,e.byteOffset+e.byteLength)}if(Buffer.isBuffer(e)){for(var f=new Uint8Array(e.length),r=e.length,t=0;r>t;t++)f[t]=e[t];return f.buffer}throw new Error("Argument must be a Buffer")};
},{"buffer":25}],93:[function(require,module,exports){
"use strict";function Url(){this.protocol=null,this.slashes=null,this.auth=null,this.host=null,this.port=null,this.hostname=null,this.hash=null,this.search=null,this.query=null,this.pathname=null,this.path=null,this.href=null}function urlParse(t,s,e){if(t&&util.isObject(t)&&t instanceof Url)return t;var h=new Url;return h.parse(t,s,e),h}function urlFormat(t){return util.isString(t)&&(t=urlParse(t)),t instanceof Url?t.format():Url.prototype.format.call(t)}function urlResolve(t,s){return urlParse(t,!1,!0).resolve(s)}function urlResolveObject(t,s){return t?urlParse(t,!1,!0).resolveObject(s):s}var punycode=require("punycode"),util=require("./util");exports.parse=urlParse,exports.resolve=urlResolve,exports.resolveObject=urlResolveObject,exports.format=urlFormat,exports.Url=Url;var protocolPattern=/^([a-z0-9.+-]+:)/i,portPattern=/:[0-9]*$/,simplePathPattern=/^(\/\/?(?!\/)[^\?\s]*)(\?[^\s]*)?$/,delims=["<",">",'"',"`"," ","\r","\n"," "],unwise=["{","}","|","\\","^","`"].concat(delims),autoEscape=["'"].concat(unwise),nonHostChars=["%","/","?",";","#"].concat(autoEscape),hostEndingChars=["/","?","#"],hostnameMaxLen=255,hostnamePartPattern=/^[+a-z0-9A-Z_-]{0,63}$/,hostnamePartStart=/^([+a-z0-9A-Z_-]{0,63})(.*)$/,unsafeProtocol={javascript:!0,"javascript:":!0},hostlessProtocol={javascript:!0,"javascript:":!0},slashedProtocol={http:!0,https:!0,ftp:!0,gopher:!0,file:!0,"http:":!0,"https:":!0,"ftp:":!0,"gopher:":!0,"file:":!0},querystring=require("querystring");Url.prototype.parse=function(t,s,e){if(!util.isString(t))throw new TypeError("Parameter 'url' must be a string, not "+typeof t);var h=t.indexOf("?"),r=-1!==h&&h<t.indexOf("#")?"?":"#",a=t.split(r),o=/\\/g;a[0]=a[0].replace(o,"/"),t=a.join(r);var n=t;if(n=n.trim(),!e&&1===t.split("#").length){var i=simplePathPattern.exec(n);if(i)return this.path=n,this.href=n,this.pathname=i[1],i[2]?(this.search=i[2],s?this.query=querystring.parse(this.search.substr(1)):this.query=this.search.substr(1)):s&&(this.search="",this.query={}),this}var l=protocolPattern.exec(n);if(l){l=l[0];var u=l.toLowerCase();this.protocol=u,n=n.substr(l.length)}if(e||l||n.match(/^\/\/[^@\/]+@[^@\/]+/)){var p="//"===n.substr(0,2);!p||l&&hostlessProtocol[l]||(n=n.substr(2),this.slashes=!0)}if(!hostlessProtocol[l]&&(p||l&&!slashedProtocol[l])){for(var c=-1,f=0;f<hostEndingChars.length;f++){var m=n.indexOf(hostEndingChars[f]);-1!==m&&(-1===c||c>m)&&(c=m)}var v,g;g=-1===c?n.lastIndexOf("@"):n.lastIndexOf("@",c),-1!==g&&(v=n.slice(0,g),n=n.slice(g+1),this.auth=decodeURIComponent(v)),c=-1;for(var f=0;f<nonHostChars.length;f++){var m=n.indexOf(nonHostChars[f]);-1!==m&&(-1===c||c>m)&&(c=m)}-1===c&&(c=n.length),this.host=n.slice(0,c),n=n.slice(c),this.parseHost(),this.hostname=this.hostname||"";var y="["===this.hostname[0]&&"]"===this.hostname[this.hostname.length-1];if(!y)for(var P=this.hostname.split(/\./),f=0,d=P.length;d>f;f++){var q=P[f];if(q&&!q.match(hostnamePartPattern)){for(var b="",O=0,j=q.length;j>O;O++)b+=q.charCodeAt(O)>127?"x":q[O];if(!b.match(hostnamePartPattern)){var x=P.slice(0,f),U=P.slice(f+1),C=q.match(hostnamePartStart);C&&(x.push(C[1]),U.unshift(C[2])),U.length&&(n="/"+U.join(".")+n),this.hostname=x.join(".");break}}}this.hostname.length>hostnameMaxLen?this.hostname="":this.hostname=this.hostname.toLowerCase(),y||(this.hostname=punycode.toASCII(this.hostname));var A=this.port?":"+this.port:"",w=this.hostname||"";this.host=w+A,this.href+=this.host,y&&(this.hostname=this.hostname.substr(1,this.hostname.length-2),"/"!==n[0]&&(n="/"+n))}if(!unsafeProtocol[u])for(var f=0,d=autoEscape.length;d>f;f++){var E=autoEscape[f];if(-1!==n.indexOf(E)){var I=encodeURIComponent(E);I===E&&(I=escape(E)),n=n.split(E).join(I)}}var R=n.indexOf("#");-1!==R&&(this.hash=n.substr(R),n=n.slice(0,R));var S=n.indexOf("?");if(-1!==S?(this.search=n.substr(S),this.query=n.substr(S+1),s&&(this.query=querystring.parse(this.query)),n=n.slice(0,S)):s&&(this.search="",this.query={}),n&&(this.pathname=n),slashedProtocol[u]&&this.hostname&&!this.pathname&&(this.pathname="/"),this.pathname||this.search){var A=this.pathname||"",k=this.searc
},{"./util":94,"punycode":72,"querystring":75}],94:[function(require,module,exports){
"use strict";module.exports={isString:function(n){return"string"==typeof n},isObject:function(n){return"object"==typeof n&&null!==n},isNull:function(n){return null===n},isNullOrUndefined:function(n){return null==n}};
},{}],95:[function(require,module,exports){
(function (global){
function deprecate(r,e){function o(){if(!t){if(config("throwDeprecation"))throw new Error(e);config("traceDeprecation")?console.trace(e):console.warn(e),t=!0}return r.apply(this,arguments)}if(config("noDeprecation"))return r;var t=!1;return o}function config(r){try{if(!global.localStorage)return!1}catch(e){return!1}var o=global.localStorage[r];return null==o?!1:"true"===String(o).toLowerCase()}module.exports=deprecate;
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{}],96:[function(require,module,exports){
module.exports=function(o){return o&&"object"==typeof o&&"function"==typeof o.copy&&"function"==typeof o.fill&&"function"==typeof o.readUInt8};
},{}],97:[function(require,module,exports){
(function (process,global){
function inspect(e,r){var t={seen:[],stylize:stylizeNoColor};return arguments.length>=3&&(t.depth=arguments[2]),arguments.length>=4&&(t.colors=arguments[3]),isBoolean(r)?t.showHidden=r:r&&exports._extend(t,r),isUndefined(t.showHidden)&&(t.showHidden=!1),isUndefined(t.depth)&&(t.depth=2),isUndefined(t.colors)&&(t.colors=!1),isUndefined(t.customInspect)&&(t.customInspect=!0),t.colors&&(t.stylize=stylizeWithColor),formatValue(t,e,t.depth)}function stylizeWithColor(e,r){var t=inspect.styles[r];return t?"["+inspect.colors[t][0]+"m"+e+"["+inspect.colors[t][1]+"m":e}function stylizeNoColor(e,r){return e}function arrayToHash(e){var r={};return e.forEach(function(e,t){r[e]=!0}),r}function formatValue(e,r,t){if(e.customInspect&&r&&isFunction(r.inspect)&&r.inspect!==exports.inspect&&(!r.constructor||r.constructor.prototype!==r)){var n=r.inspect(t,e);return isString(n)||(n=formatValue(e,n,t)),n}var i=formatPrimitive(e,r);if(i)return i;var o=Object.keys(r),s=arrayToHash(o);if(e.showHidden&&(o=Object.getOwnPropertyNames(r)),isError(r)&&(o.indexOf("message")>=0||o.indexOf("description")>=0))return formatError(r);if(0===o.length){if(isFunction(r)){var u=r.name?": "+r.name:"";return e.stylize("[Function"+u+"]","special")}if(isRegExp(r))return e.stylize(RegExp.prototype.toString.call(r),"regexp");if(isDate(r))return e.stylize(Date.prototype.toString.call(r),"date");if(isError(r))return formatError(r)}var c="",a=!1,l=["{","}"];if(isArray(r)&&(a=!0,l=["[","]"]),isFunction(r)){var p=r.name?": "+r.name:"";c=" [Function"+p+"]"}if(isRegExp(r)&&(c=" "+RegExp.prototype.toString.call(r)),isDate(r)&&(c=" "+Date.prototype.toUTCString.call(r)),isError(r)&&(c=" "+formatError(r)),0===o.length&&(!a||0==r.length))return l[0]+c+l[1];if(0>t)return isRegExp(r)?e.stylize(RegExp.prototype.toString.call(r),"regexp"):e.stylize("[Object]","special");e.seen.push(r);var f;return f=a?formatArray(e,r,t,s,o):o.map(function(n){return formatProperty(e,r,t,s,n,a)}),e.seen.pop(),reduceToSingleString(f,c,l)}function formatPrimitive(e,r){if(isUndefined(r))return e.stylize("undefined","undefined");if(isString(r)){var t="'"+JSON.stringify(r).replace(/^"|"$/g,"").replace(/'/g,"\\'").replace(/\\"/g,'"')+"'";return e.stylize(t,"string")}return isNumber(r)?e.stylize(""+r,"number"):isBoolean(r)?e.stylize(""+r,"boolean"):isNull(r)?e.stylize("null","null"):void 0}function formatError(e){return"["+Error.prototype.toString.call(e)+"]"}function formatArray(e,r,t,n,i){for(var o=[],s=0,u=r.length;u>s;++s)hasOwnProperty(r,String(s))?o.push(formatProperty(e,r,t,n,String(s),!0)):o.push("");return i.forEach(function(i){i.match(/^\d+$/)||o.push(formatProperty(e,r,t,n,i,!0))}),o}function formatProperty(e,r,t,n,i,o){var s,u,c;if(c=Object.getOwnPropertyDescriptor(r,i)||{value:r[i]},c.get?u=c.set?e.stylize("[Getter/Setter]","special"):e.stylize("[Getter]","special"):c.set&&(u=e.stylize("[Setter]","special")),hasOwnProperty(n,i)||(s="["+i+"]"),u||(e.seen.indexOf(c.value)<0?(u=isNull(t)?formatValue(e,c.value,null):formatValue(e,c.value,t-1),u.indexOf("\n")>-1&&(u=o?u.split("\n").map(function(e){return" "+e}).join("\n").substr(2):"\n"+u.split("\n").map(function(e){return" "+e}).join("\n"))):u=e.stylize("[Circular]","special")),isUndefined(s)){if(o&&i.match(/^\d+$/))return u;s=JSON.stringify(""+i),s.match(/^"([a-zA-Z_][a-zA-Z_0-9]*)"$/)?(s=s.substr(1,s.length-2),s=e.stylize(s,"name")):(s=s.replace(/'/g,"\\'").replace(/\\"/g,'"').replace(/(^"|"$)/g,"'"),s=e.stylize(s,"string"))}return s+": "+u}function reduceToSingleString(e,r,t){var n=0,i=e.reduce(function(e,r){return n++,r.indexOf("\n")>=0&&n++,e+r.replace(/\u001b\[\d\d?m/g,"").length+1},0);return i>60?t[0]+(""===r?"":r+"\n ")+" "+e.join(",\n ")+" "+t[1]:t[0]+r+" "+e.join(", ")+" "+t[1]}function isArray(e){return Array.isArray(e)}function isBoolean(e){return"boolean"==typeof e}function isNull(e){return null===e}function isNullOrUndefined(e){return null==e}function isNumber(e){return"number"==typeof e}function isString(e){return"string"==typeof e}function isSymbol(e){return"symbol"==typeof e}function isUndefined(e){return void 0===e}function
}).call(this,require('_process'),typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {})
},{"./support/isBuffer":96,"_process":71,"inherits":35}],98:[function(require,module,exports){
function extend(){for(var r={},e=0;e<arguments.length;e++){var t=arguments[e];for(var n in t)hasOwnProperty.call(t,n)&&(r[n]=t[n])}return r}module.exports=extend;var hasOwnProperty=Object.prototype.hasOwnProperty;
},{}]},{},[3])(3)
});
</script>
<script>
// https://github.com/isaacs/json-stringify-safe v5.0.1
function stringify(obj, replacer, spaces, cycleReplacer) {
return JSON.stringify(obj, serializer(replacer, cycleReplacer), spaces)
}
function serializer(replacer, cycleReplacer) {
var stack = [], keys = []
if (cycleReplacer == null) cycleReplacer = function(key, value) {
if (stack[0] === value) return "[Circular ~]"
return "[Circular ~." + keys.slice(0, stack.indexOf(value)).join(".") + "]"
}
return function(key, value) {
if (stack.length > 0) {
var thisPos = stack.indexOf(this)
~thisPos ? stack.splice(thisPos + 1) : stack.push(this)
~thisPos ? keys.splice(thisPos, Infinity, key) : keys.push(key)
if (~stack.indexOf(value)) value = cycleReplacer.call(this, key, value)
}
else stack.push(value)
return replacer == null ? value : replacer.call(this, key, value)
}
}
</script>
<script>
/* Web Font Loader v1.6.24 - (c) Adobe Systems, Google. License: Apache 2.0 */
(function(){function aa(a,b,d){return a.call.apply(a.bind,arguments)}function ba(a,b,d){if(!a)throw Error();if(2<arguments.length){var c=Array.prototype.slice.call(arguments,2);return function(){var d=Array.prototype.slice.call(arguments);Array.prototype.unshift.apply(d,c);return a.apply(b,d)}}return function(){return a.apply(b,arguments)}}function p(a,b,d){p=Function.prototype.bind&&-1!=Function.prototype.bind.toString().indexOf("native code")?aa:ba;return p.apply(null,arguments)}var q=Date.now||function(){return+new Date};function ca(a,b){this.a=a;this.m=b||a;this.c=this.m.document}var da=!!window.FontFace;function t(a,b,d,c){b=a.c.createElement(b);if(d)for(var e in d)d.hasOwnProperty(e)&&("style"==e?b.style.cssText=d[e]:b.setAttribute(e,d[e]));c&&b.appendChild(a.c.createTextNode(c));return b}function u(a,b,d){a=a.c.getElementsByTagName(b)[0];a||(a=document.documentElement);a.insertBefore(d,a.lastChild)}function v(a){a.parentNode&&a.parentNode.removeChild(a)}
function w(a,b,d){b=b||[];d=d||[];for(var c=a.className.split(/\s+/),e=0;e<b.length;e+=1){for(var f=!1,g=0;g<c.length;g+=1)if(b[e]===c[g]){f=!0;break}f||c.push(b[e])}b=[];for(e=0;e<c.length;e+=1){f=!1;for(g=0;g<d.length;g+=1)if(c[e]===d[g]){f=!0;break}f||b.push(c[e])}a.className=b.join(" ").replace(/\s+/g," ").replace(/^\s+|\s+$/,"")}function y(a,b){for(var d=a.className.split(/\s+/),c=0,e=d.length;c<e;c++)if(d[c]==b)return!0;return!1}
function z(a){if("string"===typeof a.f)return a.f;var b=a.m.location.protocol;"about:"==b&&(b=a.a.location.protocol);return"https:"==b?"https:":"http:"}function ea(a){return a.m.location.hostname||a.a.location.hostname}
function A(a,b,d){function c(){k&&e&&f&&(k(g),k=null)}b=t(a,"link",{rel:"stylesheet",href:b,media:"all"});var e=!1,f=!0,g=null,k=d||null;da?(b.onload=function(){e=!0;c()},b.onerror=function(){e=!0;g=Error("Stylesheet failed to load");c()}):setTimeout(function(){e=!0;c()},0);u(a,"head",b)}
function B(a,b,d,c){var e=a.c.getElementsByTagName("head")[0];if(e){var f=t(a,"script",{src:b}),g=!1;f.onload=f.onreadystatechange=function(){g||this.readyState&&"loaded"!=this.readyState&&"complete"!=this.readyState||(g=!0,d&&d(null),f.onload=f.onreadystatechange=null,"HEAD"==f.parentNode.tagName&&e.removeChild(f))};e.appendChild(f);setTimeout(function(){g||(g=!0,d&&d(Error("Script load timeout")))},c||5E3);return f}return null};function C(){this.a=0;this.c=null}function D(a){a.a++;return function(){a.a--;E(a)}}function F(a,b){a.c=b;E(a)}function E(a){0==a.a&&a.c&&(a.c(),a.c=null)};function G(a){this.a=a||"-"}G.prototype.c=function(a){for(var b=[],d=0;d<arguments.length;d++)b.push(arguments[d].replace(/[\W_]+/g,"").toLowerCase());return b.join(this.a)};function H(a,b){this.c=a;this.f=4;this.a="n";var d=(b||"n4").match(/^([nio])([1-9])$/i);d&&(this.a=d[1],this.f=parseInt(d[2],10))}function fa(a){return I(a)+" "+(a.f+"00")+" 300px "+J(a.c)}function J(a){var b=[];a=a.split(/,\s*/);for(var d=0;d<a.length;d++){var c=a[d].replace(/['"]/g,"");-1!=c.indexOf(" ")||/^\d/.test(c)?b.push("'"+c+"'"):b.push(c)}return b.join(",")}function K(a){return a.a+a.f}function I(a){var b="normal";"o"===a.a?b="oblique":"i"===a.a&&(b="italic");return b}
function ga(a){var b=4,d="n",c=null;a&&((c=a.match(/(normal|oblique|italic)/i))&&c[1]&&(d=c[1].substr(0,1).toLowerCase()),(c=a.match(/([1-9]00|normal|bold)/i))&&c[1]&&(/bold/i.test(c[1])?b=7:/[1-9]00/.test(c[1])&&(b=parseInt(c[1].substr(0,1),10))));return d+b};function ha(a,b){this.c=a;this.f=a.m.document.documentElement;this.h=b;this.a=new G("-");this.j=!1!==b.events;this.g=!1!==b.classes}function ia(a){a.g&&w(a.f,[a.a.c("wf","loading")]);L(a,"loading")}function M(a){if(a.g){var b=y(a.f,a.a.c("wf","active")),d=[],c=[a.a.c("wf","loading")];b||d.push(a.a.c("wf","inactive"));w(a.f,d,c)}L(a,"inactive")}function L(a,b,d){if(a.j&&a.h[b])if(d)a.h[b](d.c,K(d));else a.h[b]()};function ja(){this.c={}}function ka(a,b,d){var c=[],e;for(e in b)if(b.hasOwnProperty(e)){var f=a.c[e];f&&c.push(f(b[e],d))}return c};function N(a,b){this.c=a;this.f=b;this.a=t(this.c,"span",{"aria-hidden":"true"},this.f)}function O(a){u(a.c,"body",a.a)}function P(a){return"display:block;position:absolute;top:-9999px;left:-9999px;font-size:300px;width:auto;height:auto;line-height:normal;margin:0;padding:0;font-variant:normal;white-space:nowrap;font-family:"+J(a.c)+";"+("font-style:"+I(a)+";font-weight:"+(a.f+"00")+";")};function Q(a,b,d,c,e,f){this.g=a;this.j=b;this.a=c;this.c=d;this.f=e||3E3;this.h=f||void 0}Q.prototype.start=function(){var a=this.c.m.document,b=this,d=q(),c=new Promise(function(c,e){function k(){q()-d>=b.f?e():a.fonts.load(fa(b.a),b.h).then(function(a){1<=a.length?c():setTimeout(k,25)},function(){e()})}k()}),e=new Promise(function(a,c){setTimeout(c,b.f)});Promise.race([e,c]).then(function(){b.g(b.a)},function(){b.j(b.a)})};function R(a,b,d,c,e,f,g){this.v=a;this.B=b;this.c=d;this.a=c;this.s=g||"BESbswy";this.f={};this.w=e||3E3;this.u=f||null;this.o=this.j=this.h=this.g=null;this.g=new N(this.c,this.s);this.h=new N(this.c,this.s);this.j=new N(this.c,this.s);this.o=new N(this.c,this.s);a=new H(this.a.c+",serif",K(this.a));a=P(a);this.g.a.style.cssText=a;a=new H(this.a.c+",sans-serif",K(this.a));a=P(a);this.h.a.style.cssText=a;a=new H("serif",K(this.a));a=P(a);this.j.a.style.cssText=a;a=new H("sans-serif",K(this.a));a=
P(a);this.o.a.style.cssText=a;O(this.g);O(this.h);O(this.j);O(this.o)}var S={D:"serif",C:"sans-serif"},T=null;function U(){if(null===T){var a=/AppleWebKit\/([0-9]+)(?:\.([0-9]+))/.exec(window.navigator.userAgent);T=!!a&&(536>parseInt(a[1],10)||536===parseInt(a[1],10)&&11>=parseInt(a[2],10))}return T}R.prototype.start=function(){this.f.serif=this.j.a.offsetWidth;this.f["sans-serif"]=this.o.a.offsetWidth;this.A=q();la(this)};
function ma(a,b,d){for(var c in S)if(S.hasOwnProperty(c)&&b===a.f[S[c]]&&d===a.f[S[c]])return!0;return!1}function la(a){var b=a.g.a.offsetWidth,d=a.h.a.offsetWidth,c;(c=b===a.f.serif&&d===a.f["sans-serif"])||(c=U()&&ma(a,b,d));c?q()-a.A>=a.w?U()&&ma(a,b,d)&&(null===a.u||a.u.hasOwnProperty(a.a.c))?V(a,a.v):V(a,a.B):na(a):V(a,a.v)}function na(a){setTimeout(p(function(){la(this)},a),50)}function V(a,b){setTimeout(p(function(){v(this.g.a);v(this.h.a);v(this.j.a);v(this.o.a);b(this.a)},a),0)};function W(a,b,d){this.c=a;this.a=b;this.f=0;this.o=this.j=!1;this.s=d}var X=null;W.prototype.g=function(a){var b=this.a;b.g&&w(b.f,[b.a.c("wf",a.c,K(a).toString(),"active")],[b.a.c("wf",a.c,K(a).toString(),"loading"),b.a.c("wf",a.c,K(a).toString(),"inactive")]);L(b,"fontactive",a);this.o=!0;oa(this)};
W.prototype.h=function(a){var b=this.a;if(b.g){var d=y(b.f,b.a.c("wf",a.c,K(a).toString(),"active")),c=[],e=[b.a.c("wf",a.c,K(a).toString(),"loading")];d||c.push(b.a.c("wf",a.c,K(a).toString(),"inactive"));w(b.f,c,e)}L(b,"fontinactive",a);oa(this)};function oa(a){0==--a.f&&a.j&&(a.o?(a=a.a,a.g&&w(a.f,[a.a.c("wf","active")],[a.a.c("wf","loading"),a.a.c("wf","inactive")]),L(a,"active")):M(a.a))};function pa(a){this.j=a;this.a=new ja;this.h=0;this.f=this.g=!0}pa.prototype.load=function(a){this.c=new ca(this.j,a.context||this.j);this.g=!1!==a.events;this.f=!1!==a.classes;qa(this,new ha(this.c,a),a)};
function ra(a,b,d,c,e){var f=0==--a.h;(a.f||a.g)&&setTimeout(function(){var a=e||null,k=c||null||{};if(0===d.length&&f)M(b.a);else{b.f+=d.length;f&&(b.j=f);var h,m=[];for(h=0;h<d.length;h++){var l=d[h],n=k[l.c],r=b.a,x=l;r.g&&w(r.f,[r.a.c("wf",x.c,K(x).toString(),"loading")]);L(r,"fontloading",x);r=null;null===X&&(X=window.FontFace?(x=/Gecko.*Firefox\/(\d+)/.exec(window.navigator.userAgent))?42<parseInt(x[1],10):!0:!1);X?r=new Q(p(b.g,b),p(b.h,b),b.c,l,b.s,n):r=new R(p(b.g,b),p(b.h,b),b.c,l,b.s,a,
n);m.push(r)}for(h=0;h<m.length;h++)m[h].start()}},0)}function qa(a,b,d){var c=[],e=d.timeout;ia(b);var c=ka(a.a,d,a.c),f=new W(a.c,b,e);a.h=c.length;b=0;for(d=c.length;b<d;b++)c[b].load(function(b,c,d){ra(a,f,b,c,d)})};function sa(a,b){this.c=a;this.a=b}function ta(a,b,d){var c=z(a.c);a=(a.a.api||"fast.fonts.net/jsapi").replace(/^.*http(s?):(\/\/)?/,"");return c+"//"+a+"/"+b+".js"+(d?"?v="+d:"")}
sa.prototype.load=function(a){function b(){if(e["__mti_fntLst"+d]){var c=e["__mti_fntLst"+d](),g=[],k;if(c)for(var h=0;h<c.length;h++){var m=c[h].fontfamily;void 0!=c[h].fontStyle&&void 0!=c[h].fontWeight?(k=c[h].fontStyle+c[h].fontWeight,g.push(new H(m,k))):g.push(new H(m))}a(g)}else setTimeout(function(){b()},50)}var d=this.a.projectId,c=this.a.version;if(d){var e=this.c.m;B(this.c,ta(this,d,c),function(c){c?a([]):b()}).id="__MonotypeAPIScript__"+d}else a([])};function ua(a,b){this.c=a;this.a=b}ua.prototype.load=function(a){var b,d,c=this.a.urls||[],e=this.a.families||[],f=this.a.testStrings||{},g=new C;b=0;for(d=c.length;b<d;b++)A(this.c,c[b],D(g));var k=[];b=0;for(d=e.length;b<d;b++)if(c=e[b].split(":"),c[1])for(var h=c[1].split(","),m=0;m<h.length;m+=1)k.push(new H(c[0],h[m]));else k.push(new H(c[0]));F(g,function(){a(k,f)})};function va(a,b,d){a?this.c=a:this.c=b+wa;this.a=[];this.f=[];this.g=d||""}var wa="//fonts.googleapis.com/css";function xa(a,b){for(var d=b.length,c=0;c<d;c++){var e=b[c].split(":");3==e.length&&a.f.push(e.pop());var f="";2==e.length&&""!=e[1]&&(f=":");a.a.push(e.join(f))}}
function ya(a){if(0==a.a.length)throw Error("No fonts to load!");if(-1!=a.c.indexOf("kit="))return a.c;for(var b=a.a.length,d=[],c=0;c<b;c++)d.push(a.a[c].replace(/ /g,"+"));b=a.c+"?family="+d.join("%7C");0<a.f.length&&(b+="&subset="+a.f.join(","));0<a.g.length&&(b+="&text="+encodeURIComponent(a.g));return b};function za(a){this.f=a;this.a=[];this.c={}}
var Aa={latin:"BESbswy",cyrillic:"\u0439\u044f\u0416",greek:"\u03b1\u03b2\u03a3",khmer:"\u1780\u1781\u1782",Hanuman:"\u1780\u1781\u1782"},Ba={thin:"1",extralight:"2","extra-light":"2",ultralight:"2","ultra-light":"2",light:"3",regular:"4",book:"4",medium:"5","semi-bold":"6",semibold:"6","demi-bold":"6",demibold:"6",bold:"7","extra-bold":"8",extrabold:"8","ultra-bold":"8",ultrabold:"8",black:"9",heavy:"9",l:"3",r:"4",b:"7"},Ca={i:"i",italic:"i",n:"n",normal:"n"},Da=/^(thin|(?:(?:extra|ultra)-?)?light|regular|book|medium|(?:(?:semi|demi|extra|ultra)-?)?bold|black|heavy|l|r|b|[1-9]00)?(n|i|normal|italic)?$/;
function Ea(a){for(var b=a.f.length,d=0;d<b;d++){var c=a.f[d].split(":"),e=c[0].replace(/\+/g," "),f=["n4"];if(2<=c.length){var g;var k=c[1];g=[];if(k)for(var k=k.split(","),h=k.length,m=0;m<h;m++){var l;l=k[m];if(l.match(/^[\w-]+$/)){var n=Da.exec(l.toLowerCase());if(null==n)l="";else{l=n[2];l=null==l||""==l?"n":Ca[l];n=n[1];if(null==n||""==n)n="4";else var r=Ba[n],n=r?r:isNaN(n)?"4":n.substr(0,1);l=[l,n].join("")}}else l="";l&&g.push(l)}0<g.length&&(f=g);3==c.length&&(c=c[2],g=[],c=c?c.split(","):
g,0<c.length&&(c=Aa[c[0]])&&(a.c[e]=c))}a.c[e]||(c=Aa[e])&&(a.c[e]=c);for(c=0;c<f.length;c+=1)a.a.push(new H(e,f[c]))}};function Fa(a,b){this.c=a;this.a=b}var Ga={Arimo:!0,Cousine:!0,Tinos:!0};Fa.prototype.load=function(a){var b=new C,d=this.c,c=new va(this.a.api,z(d),this.a.text),e=this.a.families;xa(c,e);var f=new za(e);Ea(f);A(d,ya(c),D(b));F(b,function(){a(f.a,f.c,Ga)})};function Ha(a,b){this.c=a;this.a=b}Ha.prototype.load=function(a){var b=this.a.id,d=this.c.m;b?B(this.c,(this.a.api||"https://use.typekit.net")+"/"+b+".js",function(b){if(b)a([]);else if(d.Typekit&&d.Typekit.config&&d.Typekit.config.fn){b=d.Typekit.config.fn;for(var e=[],f=0;f<b.length;f+=2)for(var g=b[f],k=b[f+1],h=0;h<k.length;h++)e.push(new H(g,k[h]));try{d.Typekit.load({events:!1,classes:!1,async:!0})}catch(m){}a(e)}},2E3):a([])};function Ia(a,b){this.c=a;this.f=b;this.a=[]}Ia.prototype.load=function(a){var b=this.f.id,d=this.c.m,c=this;b?(d.__webfontfontdeckmodule__||(d.__webfontfontdeckmodule__={}),d.__webfontfontdeckmodule__[b]=function(b,d){for(var g=0,k=d.fonts.length;g<k;++g){var h=d.fonts[g];c.a.push(new H(h.name,ga("font-weight:"+h.weight+";font-style:"+h.style)))}a(c.a)},B(this.c,z(this.c)+(this.f.api||"//f.fontdeck.com/s/css/js/")+ea(this.c)+"/"+b+".js",function(b){b&&a([])})):a([])};var Y=new pa(window);Y.a.c.custom=function(a,b){return new ua(b,a)};Y.a.c.fontdeck=function(a,b){return new Ia(b,a)};Y.a.c.monotype=function(a,b){return new sa(b,a)};Y.a.c.typekit=function(a,b){return new Ha(b,a)};Y.a.c.google=function(a,b){return new Fa(b,a)};var Z={load:p(Y.load,Y)};"function"===typeof define&&define.amd?define(function(){return Z}):"undefined"!==typeof module&&module.exports?module.exports=Z:(window.WebFont=Z,window.WebFontConfig&&Y.load(window.WebFontConfig));}());
</script>
<script>
var schemaWrapper = {};
schemaWrapper.definitions = Object.assign({}, defs);
defsParser = new $RefParser();
defsParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
</script>
<script>
$(document).ready(function () {
$('.nav-tabs-examples').find('a:first').tab('show');
$(this).scrollspy({ target: '#scrollingNav', offset: 18 });
});
</script>
</body>
</html>