diff --git a/dist/js/controllers/analyzer.endpoints.js b/dist/js/controllers/analyzer.endpoints.js index c39c3fe6d02d6d56c5cf4b5b17e1e190a04ef2ae..e80b9fa841f0ccb0d35318fef79584871c48b107 100644 --- a/dist/js/controllers/analyzer.endpoints.js +++ b/dist/js/controllers/analyzer.endpoints.js @@ -88,7 +88,7 @@ app.controller('analyzer.endpoints', ['$scope', 'analyzerNav', '$parse', functio } ]; - $scope.prettyDatapoints = function() { + $scope.prettyDatapointsReceiverExample = function() { var datapointsJson = "{"; for( x in $scope.datapoints ) { datapointsJson += "\"" + $scope.datapoints[x].key + "\" : \"" + exampleDatapointValue($scope.datapoints[x]) + "\","; @@ -98,8 +98,18 @@ app.controller('analyzer.endpoints', ['$scope', 'analyzerNav', '$parse', functio return toPrettyJSON(datapointsJson, 4); }; - $scope.prettySuccessResponse = function() { - var successJson = "{\"responseMessage\" : \"Success!\"}"; + $scope.prettySuccessResponseExample = function() { + var successJson = "{\"responseMessage\" : \"Ran in 0.054 seconds\"}"; + return toPrettyJSON(successJson, 4); + }; + + $scope.prettyInsightExample = function() { + var insightJson = "{\"given\": {\"educationMax\": \"Masters\",\"birthYear\": \"1980\"},\"target\": \"personalIncome > 100000 && politicalParty = Democrat\"}"; + return toPrettyJSON(insightJson, 4); + } + + $scope.prettySuccessResponseInsightExample = function() { + var successJson = "{\"responseMessage\" : \"Ran in 0.032 seconds\", \"probability\": \"0.89\"}"; return toPrettyJSON(successJson, 4); }; diff --git a/dist/json/insight.json b/dist/json/insight.json new file mode 100644 index 0000000000000000000000000000000000000000..29ea6fd337b959382cf762c4fb65b10fcf348b58 --- /dev/null +++ b/dist/json/insight.json @@ -0,0 +1,7 @@ +{ + "given": { + "educationMax": "Masters", + "birthYear": "1980" + }, + "target": "personalIncome > 100000 && politicalParty = Democrat" +} diff --git a/dist/views/analyzer.endpoints.html b/dist/views/analyzer.endpoints.html index dd966f46a26ed20415af00fa9e5a07a7abe0dc0b..b0d06bfbe726fc9531e2c3dc9b92bcf48861a0b8 100644 --- a/dist/views/analyzer.endpoints.html +++ b/dist/views/analyzer.endpoints.html @@ -14,7 +14,7 @@ <td class="datapoint-cell">{{datapoint.type}}</td> <td class="datapoint-cell">{{datapoint.description}}</td> </tr> - <tr ng-repeat-end=""> + <tr ng-repeat-end> <td colspan="3"></td> <td ng-if="datapoint.type == 'number'"><span ng-if="datapoint.rangeMin != null">{{datapoint.rangeMin}}</span><span ng-if="datapoint.rangeMin == null">-∞</span> to <span ng-if="datapoint.rangeMax != null">{{datapoint.rangeMax}}</span><span ng-if="datapoint.rangeMax == null">∞</span></td> <td ng-if="datapoint.type == 'discrete'">{{datapoint.states}}</td> @@ -24,18 +24,18 @@ <hr/> <div style="padding-bottom: 10px;">Request example</div> <div>Content-Type: application/json</div> - <div hljs source="prettyDatapoints()"></div> + <div hljs source="prettyDatapointsReceiverExample()"></div> <hr/> <div style="padding-bottom: 10px;">Response example</div> <div><span>201</span> Datapoint successfully recorded.</div> <div>Content-Type: application/json</div> - <div hljs source="prettySuccessResponse()"></div> + <div hljs source="prettySuccessResponseExample()"></div> </div> </div> <div class="datapoint-container"> <div class="datapoint-title"> - <h1>Insight detection</h1> + <h1>Insight analysis</h1> </div> <div class="datapoint-details"> <div><span class="datapoint-http-method get-method">GET</span> https://aide.syncleus.com/robotek/customers/insight</div> @@ -43,28 +43,49 @@ Request parameters <table> <tbody> - <tr ng-repeat-start="datapoint in datapoints"> + <tr> <td><i class="datapoint-cell datapoint-required optional"></i></td> - <td class="datapoint-cell">{{datapoint.key}}</td> - <td class="datapoint-cell">{{datapoint.type}}</td> - <td class="datapoint-cell">{{datapoint.description}}</td> + <td class="datapoint-cell">given</td> + <td class="datapoint-cell">Map</td> + <td class="datapoint-cell">A map describing the known properties of the datapoint</td> </tr> - <tr ng-repeat-end=""> - <td colspan="3"></td> - <td ng-if="datapoint.type == 'number'"><span ng-if="datapoint.rangeMin != null">{{datapoint.rangeMin}}</span><span ng-if="datapoint.rangeMin == null">-∞</span> to <span ng-if="datapoint.rangeMax != null">{{datapoint.rangeMax}}</span><span ng-if="datapoint.rangeMax == null">∞</span></td> - <td ng-if="datapoint.type == 'discrete'">{{datapoint.states}}</td> + <tr> + <td></td> + <td colspan="4"> + <table> + <tbody> + <tr ng-repeat-start="datapoint in datapoints"> + <td><i class="datapoint-cell datapoint-required optional"></i></td> + <td class="datapoint-cell">{{datapoint.key}}</td> + <td class="datapoint-cell">{{datapoint.type}}</td> + <td class="datapoint-cell">{{datapoint.description}}</td> + </tr> + <tr ng-repeat-end> + <td colspan="3"></td> + <td ng-if="datapoint.type == 'number'"><span ng-if="datapoint.rangeMin != null">{{datapoint.rangeMin}}</span><span ng-if="datapoint.rangeMin == null">-∞</span> to <span ng-if="datapoint.rangeMax != null">{{datapoint.rangeMax}}</span><span ng-if="datapoint.rangeMax == null">∞</span></td> + <td ng-if="datapoint.type == 'discrete'">{{datapoint.states}}</td> + </tr> + </tbody> + </table> + </td> + </tr> + <tr> + <td><i class="datapoint-cell datapoint-required optional"></i></td> + <td class="datapoint-cell">target</td> + <td class="datapoint-cell">String</td> + <td class="datapoint-cell">A string indicating the boolean logic for the fields being analyzed for.</td> </tr> </tbody> </table> <hr/> <div style="padding-bottom: 10px;">Request example</div> <div>Content-Type: application/json</div> - <div hljs source="prettyDatapoints()"></div> + <div hljs source="prettyInsightExample()"></div> <hr/> <div style="padding-bottom: 10px;">Response example</div> - <div><span>201</span> Datapoint successfully recorded.</div> + <div><span>201</span> Insight successfully analyzed.</div> <div>Content-Type: application/json</div> - <div hljs source="prettySuccessResponse()"></div> + <div hljs source="prettySuccessResponseInsightExample()"></div> </div> </div> @@ -95,12 +116,12 @@ <hr/> <div style="padding-bottom: 10px;">Request example</div> <div>Content-Type: application/json</div> - <div hljs source="prettyDatapoints()"></div> + <div hljs source="prettyDatapointsReceiverExample()"></div> <hr/> <div style="padding-bottom: 10px;">Response example</div> <div><span>201</span> Datapoint successfully recorded.</div> <div>Content-Type: application/json</div> - <div hljs source="prettySuccessResponse()"></div> + <div hljs source="prettySuccessResponseExample()"></div> </div> </div> @@ -130,11 +151,11 @@ <hr/> <div style="padding-bottom: 10px;">Request example</div> <div>Content-Type: application/json</div> - <div hljs source="prettyDatapoints()"></div> + <div hljs source="prettyDatapointsReceiverExample()"></div> <hr/> <div style="padding-bottom: 10px;">Response example</div> <div><span>201</span> Datapoint successfully recorded.</div> <div>Content-Type: application/json</div> - <div hljs source="prettySuccessResponse()"></div> + <div hljs source="prettySuccessResponseExample()"></div> </div> </div>