mirror of
				https://github.com/Telecominfraproject/wlan-cloud-owprov.git
				synced 2025-10-31 02:27:52 +00:00 
			
		
		
		
	Update OpenAPI docs for GitHub pages
This commit is contained in:
		
							
								
								
									
										102
									
								
								docs/index.html
									
									
									
									
									
								
							
							
						
						
									
										102
									
								
								docs/index.html
									
									
									
									
									
								
							| @@ -1480,11 +1480,6 @@ ul.nav-tabs { | |||||||
|   }, { |   }, { | ||||||
|     "$ref" : "#/components/schemas/Dashboard" |     "$ref" : "#/components/schemas/Dashboard" | ||||||
|   } ] |   } ] | ||||||
| }; |  | ||||||
|     defs["getSystemCommand_200_response"] = { |  | ||||||
|   "oneOf" : [ { |  | ||||||
|     "$ref" : "#/components/schemas/SystemInfoResults" |  | ||||||
|   } ] |  | ||||||
| }; | }; | ||||||
|     defs["getVenues_200_response"] = { |     defs["getVenues_200_response"] = { | ||||||
|   "oneOf" : [ { |   "oneOf" : [ { | ||||||
| @@ -2515,6 +2510,10 @@ ul.nav-tabs { | |||||||
|     defs["SystemCommandResults"] = { |     defs["SystemCommandResults"] = { | ||||||
|   "type" : "object", |   "type" : "object", | ||||||
|   "oneOf" : [ { |   "oneOf" : [ { | ||||||
|  |     "$ref" : "#/components/schemas/SystemResources" | ||||||
|  |   }, { | ||||||
|  |     "$ref" : "#/components/schemas/SystemInfoResults" | ||||||
|  |   }, { | ||||||
|     "$ref" : "#/components/schemas/StringList" |     "$ref" : "#/components/schemas/StringList" | ||||||
|   }, { |   }, { | ||||||
|     "$ref" : "#/components/schemas/TagValuePairList" |     "$ref" : "#/components/schemas/TagValuePairList" | ||||||
| @@ -2599,6 +2598,31 @@ ul.nav-tabs { | |||||||
|       "format" : "int64" |       "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"] = { |     defs["TagIntPair"] = { | ||||||
|   "type" : "object", |   "type" : "object", | ||||||
| @@ -40804,7 +40828,6 @@ pub fn main() { | |||||||
|                             <pre class="prettyprint"><code class="language-bsh">curl -X GET \ |                             <pre class="prettyprint"><code class="language-bsh">curl -X GET \ | ||||||
| -H "X-API-KEY: [[apiKey]]" \ | -H "X-API-KEY: [[apiKey]]" \ | ||||||
|  -H "Authorization: Bearer [[accessToken]]" \ |  -H "Authorization: Bearer [[accessToken]]" \ | ||||||
|  -H "Accept: application/json" \ |  | ||||||
|  "https://localhost:16005/api/v1/system?command=command_example" |  "https://localhost:16005/api/v1/system?command=command_example" | ||||||
| </code></pre> | </code></pre> | ||||||
|                           </div> |                           </div> | ||||||
| @@ -40836,8 +40859,7 @@ public class SystemCommandsApiExample { | |||||||
|         String command = command_example; // String | Get a value |         String command = command_example; // String | Get a value | ||||||
| 
 | 
 | ||||||
|         try { |         try { | ||||||
|             getSystemCommand_200_response result = apiInstance.getSystemCommand(command); |             apiInstance.getSystemCommand(command); | ||||||
|             System.out.println(result); |  | ||||||
|         } catch (ApiException e) { |         } catch (ApiException e) { | ||||||
|             System.err.println("Exception when calling SystemCommandsApi#getSystemCommand"); |             System.err.println("Exception when calling SystemCommandsApi#getSystemCommand"); | ||||||
|             e.printStackTrace(); |             e.printStackTrace(); | ||||||
| @@ -40856,8 +40878,7 @@ public class SystemCommandsApiExample { | |||||||
|         String command = command_example; // String | Get a value |         String command = command_example; // String | Get a value | ||||||
| 
 | 
 | ||||||
|         try { |         try { | ||||||
|             getSystemCommand_200_response result = apiInstance.getSystemCommand(command); |             apiInstance.getSystemCommand(command); | ||||||
|             System.out.println(result); |  | ||||||
|         } catch (ApiException e) { |         } catch (ApiException e) { | ||||||
|             System.err.println("Exception when calling SystemCommandsApi#getSystemCommand"); |             System.err.println("Exception when calling SystemCommandsApi#getSystemCommand"); | ||||||
|             e.printStackTrace(); |             e.printStackTrace(); | ||||||
| @@ -40886,10 +40907,7 @@ String *command = command_example; // Get a value (default to null) | |||||||
| 
 | 
 | ||||||
| // Retrieve different values from the running service. | // Retrieve different values from the running service. | ||||||
| [apiInstance getSystemCommandWith:command | [apiInstance getSystemCommandWith:command | ||||||
|               completionHandler: ^(getSystemCommand_200_response output, NSError* error) { |               completionHandler: ^(NSError* error) { | ||||||
|     if (output) { |  | ||||||
|         NSLog(@"%@", output); |  | ||||||
|     } |  | ||||||
|     if (error) { |     if (error) { | ||||||
|         NSLog(@"Error: %@", error); |         NSLog(@"Error: %@", error); | ||||||
|     } |     } | ||||||
| @@ -40919,7 +40937,7 @@ var callback = function(error, data, response) { | |||||||
|   if (error) { |   if (error) { | ||||||
|     console.error(error); |     console.error(error); | ||||||
|   } else { |   } else { | ||||||
|     console.log('API called successfully. Returned data: ' + data); |     console.log('API called successfully.'); | ||||||
|   } |   } | ||||||
| }; | }; | ||||||
| api.getSystemCommand(command, callback); | api.getSystemCommand(command, callback); | ||||||
| @@ -40955,8 +40973,7 @@ namespace Example | |||||||
| 
 | 
 | ||||||
|             try { |             try { | ||||||
|                 // Retrieve different values from the running service. |                 // Retrieve different values from the running service. | ||||||
|                 getSystemCommand_200_response result = apiInstance.getSystemCommand(command); |                 apiInstance.getSystemCommand(command); | ||||||
|                 Debug.WriteLine(result); |  | ||||||
|             } catch (Exception e) { |             } catch (Exception e) { | ||||||
|                 Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message ); |                 Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message ); | ||||||
|             } |             } | ||||||
| @@ -40983,8 +41000,7 @@ $api_instance = new OpenAPITools\Client\Api\SystemCommandsApi(); | |||||||
| $command = command_example; // String | Get a value | $command = command_example; // String | Get a value | ||||||
| 
 | 
 | ||||||
| try { | try { | ||||||
|     $result = $api_instance->getSystemCommand($command); |     $api_instance->getSystemCommand($command); | ||||||
|     print_r($result); |  | ||||||
| } catch (Exception $e) { | } catch (Exception $e) { | ||||||
|     echo 'Exception when calling SystemCommandsApi->getSystemCommand: ', $e->getMessage(), PHP_EOL; |     echo 'Exception when calling SystemCommandsApi->getSystemCommand: ', $e->getMessage(), PHP_EOL; | ||||||
| } | } | ||||||
| @@ -41009,8 +41025,7 @@ my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new(); | |||||||
| my $command = command_example; # String | Get a value | my $command = command_example; # String | Get a value | ||||||
| 
 | 
 | ||||||
| eval { | eval { | ||||||
|     my $result = $api_instance->getSystemCommand(command => $command); |     $api_instance->getSystemCommand(command => $command); | ||||||
|     print Dumper($result); |  | ||||||
| }; | }; | ||||||
| if ($@) { | if ($@) { | ||||||
|     warn "Exception when calling SystemCommandsApi->getSystemCommand: $@\n"; |     warn "Exception when calling SystemCommandsApi->getSystemCommand: $@\n"; | ||||||
| @@ -41038,8 +41053,7 @@ command = command_example # String | Get a value (default to null) | |||||||
| 
 | 
 | ||||||
| try: | try: | ||||||
|     # Retrieve different values from the running service. |     # Retrieve different values from the running service. | ||||||
|     api_response = api_instance.get_system_command(command) |     api_instance.get_system_command(command) | ||||||
|     pprint(api_response) |  | ||||||
| except ApiException as e: | except ApiException as e: | ||||||
|     print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)</code></pre> |     print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)</code></pre> | ||||||
|                             </div> |                             </div> | ||||||
| @@ -41105,7 +41119,7 @@ Get a value | |||||||
|                             <h3 id="examples-SystemCommands-getSystemCommand-title-200"></h3> |                             <h3 id="examples-SystemCommands-getSystemCommand-title-200"></h3> | ||||||
|                             <p id="examples-SystemCommands-getSystemCommand-description-200" class="marked"></p> |                             <p id="examples-SystemCommands-getSystemCommand-description-200" class="marked"></p> | ||||||
|                             <script> |                             <script> | ||||||
|                               var responseSystemCommands200_description = `Successful command execution`; |                               var responseSystemCommands200_description = ``; | ||||||
|                               var responseSystemCommands200_description_break = responseSystemCommands200_description.indexOf('\n'); |                               var responseSystemCommands200_description_break = responseSystemCommands200_description.indexOf('\n'); | ||||||
|                               if (responseSystemCommands200_description_break == -1) { |                               if (responseSystemCommands200_description_break == -1) { | ||||||
|                                 $("#examples-SystemCommands-getSystemCommand-title-200").text("Status: 200 - " + responseSystemCommands200_description); |                                 $("#examples-SystemCommands-getSystemCommand-title-200").text("Status: 200 - " + responseSystemCommands200_description); | ||||||
| @@ -41117,52 +41131,12 @@ Get a value | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|                             <ul id="responses-detail-SystemCommands-getSystemCommand-200" class="nav nav-tabs nav-tabs-examples" > |                             <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> |                             </ul> | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|                             <div class="tab-content" id="responses-SystemCommands-getSystemCommand-200-wrapper" style='margin-bottom: 10px;'> |                             <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> |                             </div> | ||||||
|                             <h3 id="examples-SystemCommands-getSystemCommand-title-403"></h3> |                             <h3 id="examples-SystemCommands-getSystemCommand-title-403"></h3> | ||||||
|                             <p id="examples-SystemCommands-getSystemCommand-description-403" class="marked"></p> |                             <p id="examples-SystemCommands-getSystemCommand-description-403" class="marked"></p> | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 TIP Automation User
					TIP Automation User