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 Aug 3, 2023
1 parent 7ae328c commit f1ce954
Showing 1 changed file with 38 additions and 64 deletions.
102 changes: 38 additions & 64 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1480,11 +1480,6 @@
}, {
"$ref" : "#/components/schemas/Dashboard"
} ]
};
defs["getSystemCommand_200_response"] = {
"oneOf" : [ {
"$ref" : "#/components/schemas/SystemInfoResults"
} ]
};
defs["getVenues_200_response"] = {
"oneOf" : [ {
Expand Down Expand Up @@ -2515,6 +2510,10 @@
defs["SystemCommandResults"] = {
"type" : "object",
"oneOf" : [ {
"$ref" : "#/components/schemas/SystemResources"
}, {
"$ref" : "#/components/schemas/SystemInfoResults"
}, {
"$ref" : "#/components/schemas/StringList"
}, {
"$ref" : "#/components/schemas/TagValuePairList"
Expand Down Expand Up @@ -2599,6 +2598,31 @@
"format" : "int64"
}
}
};
defs["SystemResources"] = {
"type" : "object",
"properties" : {
"numberOfFileDescriptors" : {
"type" : "integer",
"format" : "int64"
},
"currRealMem" : {
"type" : "integer",
"format" : "int64"
},
"peakRealMem" : {
"type" : "integer",
"format" : "int64"
},
"currVirtMem" : {
"type" : "integer",
"format" : "int64"
},
"peakVirtMem" : {
"type" : "integer",
"format" : "int64"
}
}
};
defs["TagIntPair"] = {
"type" : "object",
Expand Down Expand Up @@ -40804,7 +40828,6 @@ <h3>Usage and SDK Samples</h3>
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "Authorization: Bearer [[accessToken]]" \
-H "Accept: application/json" \
"https://localhost:16005/api/v1/system?command=command_example"
</code></pre>
</div>
Expand Down Expand Up @@ -40836,8 +40859,7 @@ <h3>Usage and SDK Samples</h3>
String command = command_example; // String | Get a value

try {
getSystemCommand_200_response result = apiInstance.getSystemCommand(command);
System.out.println(result);
apiInstance.getSystemCommand(command);
} catch (ApiException e) {
System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
e.printStackTrace();
Expand All @@ -40856,8 +40878,7 @@ <h3>Usage and SDK Samples</h3>
String command = command_example; // String | Get a value

try {
getSystemCommand_200_response result = apiInstance.getSystemCommand(command);
System.out.println(result);
apiInstance.getSystemCommand(command);
} catch (ApiException e) {
System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
e.printStackTrace();
Expand Down Expand Up @@ -40886,10 +40907,7 @@ <h3>Usage and SDK Samples</h3>

// Retrieve different values from the running service.
[apiInstance getSystemCommandWith:command
completionHandler: ^(getSystemCommand_200_response output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
Expand Down Expand Up @@ -40919,7 +40937,7 @@ <h3>Usage and SDK Samples</h3>
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
console.log('API called successfully.');
}
};
api.getSystemCommand(command, callback);
Expand Down Expand Up @@ -40955,8 +40973,7 @@ <h3>Usage and SDK Samples</h3>

try {
// Retrieve different values from the running service.
getSystemCommand_200_response result = apiInstance.getSystemCommand(command);
Debug.WriteLine(result);
apiInstance.getSystemCommand(command);
} catch (Exception e) {
Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message );
}
Expand All @@ -40983,8 +41000,7 @@ <h3>Usage and SDK Samples</h3>
$command = command_example; // String | Get a value

try {
$result = $api_instance->getSystemCommand($command);
print_r($result);
$api_instance->getSystemCommand($command);
} catch (Exception $e) {
echo 'Exception when calling SystemCommandsApi->getSystemCommand: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -41009,8 +41025,7 @@ <h3>Usage and SDK Samples</h3>
my $command = command_example; # String | Get a value

eval {
my $result = $api_instance->getSystemCommand(command => $command);
print Dumper($result);
$api_instance->getSystemCommand(command => $command);
};
if ($@) {
warn "Exception when calling SystemCommandsApi->getSystemCommand: $@\n";
Expand Down Expand Up @@ -41038,8 +41053,7 @@ <h3>Usage and SDK Samples</h3>

try:
# Retrieve different values from the running service.
api_response = api_instance.get_system_command(command)
pprint(api_response)
api_instance.get_system_command(command)
except ApiException as e:
print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)</code></pre>
</div>
Expand Down Expand Up @@ -41105,7 +41119,7 @@ <h2>Responses</h2>
<h3 id="examples-SystemCommands-getSystemCommand-title-200"></h3>
<p id="examples-SystemCommands-getSystemCommand-description-200" class="marked"></p>
<script>
var responseSystemCommands200_description = `Successful command execution`;
var responseSystemCommands200_description = ``;
var responseSystemCommands200_description_break = responseSystemCommands200_description.indexOf('\n');
if (responseSystemCommands200_description_break == -1) {
$("#examples-SystemCommands-getSystemCommand-title-200").text("Status: 200 - " + responseSystemCommands200_description);
Expand All @@ -41117,52 +41131,12 @@ <h3 id="examples-SystemCommands-getSystemCommand-title-200"></h3>


<ul id="responses-detail-SystemCommands-getSystemCommand-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-SystemCommands-getSystemCommand-200-schema">Schema</a>
</li>




</ul>


<div class="tab-content" id="responses-SystemCommands-getSystemCommand-200-wrapper" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-SystemCommands-getSystemCommand-200-schema">
<div id="responses-SystemCommands-getSystemCommand-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
Object.keys(schema.properties).forEach( (item) => {
if (schema.properties[item].$ref != null) {
schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
}
});
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
schemaWrapper.definitions = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}

var view = new JSONSchemaView(schema, 3);
$('#responses-SystemCommands-getSystemCommand-200-schema-data').val(JSON.stringify(schema));
var result = $('#responses-SystemCommands-getSystemCommand-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-SystemCommands-getSystemCommand-200-schema-data' type='hidden' value=''></input>
</div>
</div>
<h3 id="examples-SystemCommands-getSystemCommand-title-403"></h3>
<p id="examples-SystemCommands-getSystemCommand-description-403" class="marked"></p>
Expand Down

0 comments on commit f1ce954

Please sign in to comment.