Skip to content

Commit

Permalink
Update OpenAPI docs for GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@tip-automation
tip-automation committed Mar 27, 2024
1 parent f32fc95 commit 7a40cd2
Showing 1 changed file with 39 additions and 9 deletions.
48 changes: 39 additions & 9 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25013,7 +25013,7 @@ <h3>Usage and SDK Samples</h3>
-H "X-API-KEY: [[apiKey]]" \
-H "Authorization: Bearer [[accessToken]]" \
-H "Accept: application/json" \
"https://localhost:16001/api/v1/devices?offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&serialOnly=true&countOnly=false&deviceWithStatus=true&orderBy=serialNumber:a,created:d&orderSpec=true&connectionStatistics=true&health=true&lowLimit=56&highLimits=56&platform=platform_example"
"https://localhost:16001/api/v1/devices?offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&serialOnly=true&countOnly=false&deviceWithStatus=true&orderBy=serialNumber:a,created:d&orderSpec=true&connectionStatistics=true&health=true&lowLimit=56&highLimits=56&platform=platform_example&includeProvisioned=true"
</code></pre>
</div>
<div class="tab-pane" id="examples-Devices-getDeviceList-0-java">
Expand Down Expand Up @@ -25055,9 +25055,10 @@ <h3>Usage and SDK Samples</h3>
Integer lowLimit = 56; // Integer | lowLimit for the health selection criteria
Integer highLimits = 56; // Integer | highLimit for the health selection criteria
String platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH
Boolean includeProvisioned = true; // Boolean | only devices which are not provisioned

try {
getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform);
getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevicesApi#getDeviceList");
Expand Down Expand Up @@ -25088,9 +25089,10 @@ <h3>Usage and SDK Samples</h3>
Integer lowLimit = 56; // Integer | lowLimit for the health selection criteria
Integer highLimits = 56; // Integer | highLimit for the health selection criteria
String platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH
Boolean includeProvisioned = true; // Boolean | only devices which are not provisioned

try {
getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform);
getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevicesApi#getDeviceList");
Expand Down Expand Up @@ -25130,6 +25132,7 @@ <h3>Usage and SDK Samples</h3>
Integer *lowLimit = 56; // lowLimit for the health selection criteria (optional) (default to 30)
Integer *highLimits = 56; // highLimit for the health selection criteria (optional) (default to 70)
String *platform = platform_example; // return only devices matching a certain platform of AP or SWITCH (optional) (default to ALL)
Boolean *includeProvisioned = true; // only devices which are not provisioned (optional) (default to null)

// Returns a list of devices.
[apiInstance getDeviceListWith:offset
Expand All @@ -25146,6 +25149,7 @@ <h3>Usage and SDK Samples</h3>
lowLimit:lowLimit
highLimits:highLimits
platform:platform
includeProvisioned:includeProvisioned
completionHandler: ^(getDeviceList_200_response output, NSError* error) {
if (output) {
NSLog(@"%@", output);
Expand Down Expand Up @@ -25187,7 +25191,8 @@ <h3>Usage and SDK Samples</h3>
'health': true, // {Boolean} return devices with their health value in between lowLimit and highLimit
'lowLimit': 56, // {Integer} lowLimit for the health selection criteria
'highLimits': 56, // {Integer} highLimit for the health selection criteria
'platform': platform_example // {String} return only devices matching a certain platform of AP or SWITCH
'platform': platform_example, // {String} return only devices matching a certain platform of AP or SWITCH
'includeProvisioned': true // {Boolean} only devices which are not provisioned
};

var callback = function(error, data, response) {
Expand Down Expand Up @@ -25240,10 +25245,11 @@ <h3>Usage and SDK Samples</h3>
var lowLimit = 56; // Integer | lowLimit for the health selection criteria (optional) (default to 30)
var highLimits = 56; // Integer | highLimit for the health selection criteria (optional) (default to 70)
var platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH (optional) (default to ALL)
var includeProvisioned = true; // Boolean | only devices which are not provisioned (optional) (default to null)

try {
// Returns a list of devices.
getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform);
getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DevicesApi.getDeviceList: " + e.Message );
Expand Down Expand Up @@ -25282,9 +25288,10 @@ <h3>Usage and SDK Samples</h3>
$lowLimit = 56; // Integer | lowLimit for the health selection criteria
$highLimits = 56; // Integer | highLimit for the health selection criteria
$platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH
$includeProvisioned = true; // Boolean | only devices which are not provisioned

try {
$result = $api_instance->getDeviceList($offset, $limit, $filter, $select, $serialOnly, $countOnly, $deviceWithStatus, $orderBy, $orderSpec, $connectionStatistics, $health, $lowLimit, $highLimits, $platform);
$result = $api_instance->getDeviceList($offset, $limit, $filter, $select, $serialOnly, $countOnly, $deviceWithStatus, $orderBy, $orderSpec, $connectionStatistics, $health, $lowLimit, $highLimits, $platform, $includeProvisioned);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DevicesApi->getDeviceList: ', $e->getMessage(), PHP_EOL;
Expand Down Expand Up @@ -25321,9 +25328,10 @@ <h3>Usage and SDK Samples</h3>
my $lowLimit = 56; # Integer | lowLimit for the health selection criteria
my $highLimits = 56; # Integer | highLimit for the health selection criteria
my $platform = platform_example; # String | return only devices matching a certain platform of AP or SWITCH
my $includeProvisioned = true; # Boolean | only devices which are not provisioned

eval {
my $result = $api_instance->getDeviceList(offset => $offset, limit => $limit, filter => $filter, select => $select, serialOnly => $serialOnly, countOnly => $countOnly, deviceWithStatus => $deviceWithStatus, orderBy => $orderBy, orderSpec => $orderSpec, connectionStatistics => $connectionStatistics, health => $health, lowLimit => $lowLimit, highLimits => $highLimits, platform => $platform);
my $result = $api_instance->getDeviceList(offset => $offset, limit => $limit, filter => $filter, select => $select, serialOnly => $serialOnly, countOnly => $countOnly, deviceWithStatus => $deviceWithStatus, orderBy => $orderBy, orderSpec => $orderSpec, connectionStatistics => $connectionStatistics, health => $health, lowLimit => $lowLimit, highLimits => $highLimits, platform => $platform, includeProvisioned => $includeProvisioned);
print Dumper($result);
};
if ($@) {
Expand Down Expand Up @@ -25362,10 +25370,11 @@ <h3>Usage and SDK Samples</h3>
lowLimit = 56 # Integer | lowLimit for the health selection criteria (optional) (default to 30)
highLimits = 56 # Integer | highLimit for the health selection criteria (optional) (default to 70)
platform = platform_example # String | return only devices matching a certain platform of AP or SWITCH (optional) (default to ALL)
includeProvisioned = true # Boolean | only devices which are not provisioned (optional) (default to null)

try:
# Returns a list of devices.
api_response = api_instance.get_device_list(offset=offset, limit=limit, filter=filter, select=select, serialOnly=serialOnly, countOnly=countOnly, deviceWithStatus=deviceWithStatus, orderBy=orderBy, orderSpec=orderSpec, connectionStatistics=connectionStatistics, health=health, lowLimit=lowLimit, highLimits=highLimits, platform=platform)
api_response = api_instance.get_device_list(offset=offset, limit=limit, filter=filter, select=select, serialOnly=serialOnly, countOnly=countOnly, deviceWithStatus=deviceWithStatus, orderBy=orderBy, orderSpec=orderSpec, connectionStatistics=connectionStatistics, health=health, lowLimit=lowLimit, highLimits=highLimits, platform=platform, includeProvisioned=includeProvisioned)
pprint(api_response)
except ApiException as e:
print("Exception when calling DevicesApi->getDeviceList: %s\n" % e)</code></pre>
Expand All @@ -25389,9 +25398,10 @@ <h3>Usage and SDK Samples</h3>
let lowLimit = 56; // Integer
let highLimits = 56; // Integer
let platform = platform_example; // String
let includeProvisioned = true; // Boolean

let mut context = DevicesApi::Context::default();
let result = client.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, &context).wait();
let result = client.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned, &context).wait();

println!("{:?}", result);
}
Expand Down Expand Up @@ -25694,6 +25704,26 @@ <h2>Parameters</h2>
</div>
</div>
</td>
</tr>

<tr><td style="width:150px;">includeProvisioned</td>
<td>


<div id="d2e199_getDeviceList_includeProvisioned">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
Boolean
</span>

<div class="inner description marked">
only devices which are not provisioned
</div>
</div>
</div>
</div>
</td>
</tr>

</table>
Expand Down

0 comments on commit 7a40cd2

Please sign in to comment.