<li data-group="AuthorizationAPI" data-name="performAccessControl" class="">
<a href="#api-AuthorizationAPI-performAccessControl">performAccessControl</a>
</li>
- <li class="nav-header" data-group="Callbacks"><a href="#api-Callbacks">API Methods - Callbacks</a></li>
- <li data-group="Callbacks" data-name="serviceCallback" class="">
- <a href="#api-Callbacks-serviceCallback">serviceCallback</a>
- </li>
<li class="nav-header" data-group="HealthCheck"><a href="#api-HealthCheck">API Methods - HealthCheck</a></li>
<li data-group="HealthCheck" data-name="getStatus" class="">
<a href="#api-HealthCheck-getStatus">getStatus</a>
<li data-group="NearRTRICRepository" data-name="getRics" class="">
<a href="#api-NearRTRICRepository-getRics">getRics</a>
</li>
+ <li class="nav-header" data-group="ServiceCallbacks"><a href="#api-ServiceCallbacks">API Methods - ServiceCallbacks</a></li>
+ <li data-group="ServiceCallbacks" data-name="serviceCallback" class="">
+ <a href="#api-ServiceCallbacks-serviceCallback">serviceCallback</a>
+ </li>
<li class="nav-header" data-group="ServiceRegistryAndSupervision"><a href="#api-ServiceRegistryAndSupervision">API Methods - ServiceRegistryAndSupervision</a></li>
<li data-group="ServiceRegistryAndSupervision" data-name="deleteService" class="">
<a href="#api-ServiceRegistryAndSupervision-deleteService">deleteService</a>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
- <div class="app-desc">Version: 1.1.0</div>
+ <div class="app-desc">Version: 1.2.0</div>
<hr>
<div id="app-description" class="app-desc">
- <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided
by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.</p><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>
+ <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided
or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.</p><h3>Authorization API</h3><p>API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.</p><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>
</div>
</div>
</div>
<hr>
</section>
- <section id="api-Callbacks">
- <h1>Callbacks</h1>
- <div id="api-Callbacks-serviceCallback">
- <article id="api-Callbacks-serviceCallback-0" data-group="User" data-name="serviceCallback" data-version="0">
+ <section id="api-HealthCheck">
+ <h1>HealthCheck</h1>
+ <div id="api-HealthCheck-getStatus">
+ <article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0">
<div class="pull-left">
- <h1>serviceCallback</h1>
- <p>Callback for Near-RT RIC status</p>
+ <h1>getStatus</h1>
+ <p>Returns status and statistics of this service</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">The URL to this call is registered at Service registration.</p>
+ <p class="marked"></p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/r-app/near-rt-ric-status</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/status</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-Callbacks-serviceCallback-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-java">Java</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Callbacks-serviceCallback-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Callbacks-serviceCallback-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-php">PHP</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-python">Python</a></li>
- <li class=""><a href="#examples-Callbacks-serviceCallback-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-HealthCheck-getStatus-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-java">Java</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-php">PHP</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-python">Python</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Callbacks-serviceCallback-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X POST \
+ <div class="tab-pane active" id="examples-HealthCheck-getStatus-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json" \
- -H "Content-Type: application/json" \
- "http://localhost/r-app/near-rt-ric-status" \
- -d ''
+ "http://localhost/a1-policy/v2/status"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-java">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.CallbacksApi;
+import org.openapitools.client.api.HealthCheckApi;
import java.io.File;
import java.util.*;
-public class CallbacksApiExample {
+public class HealthCheckApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- CallbacksApi apiInstance = new CallbacksApi();
- ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 |
+ HealthCheckApi apiInstance = new HealthCheckApi();
try {
- Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
+ status_info_v2 result = apiInstance.getStatus();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallbacksApi#serviceCallback");
+ System.err.println("Exception when calling HealthCheckApi#getStatus");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.CallbacksApi;
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.HealthCheckApi;
-public class CallbacksApiExample {
+public class HealthCheckApiExample {
public static void main(String[] args) {
- CallbacksApi apiInstance = new CallbacksApi();
- ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 |
+ HealthCheckApi apiInstance = new HealthCheckApi();
try {
- Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
+ status_info_v2 result = apiInstance.getStatus();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CallbacksApi#serviceCallback");
+ System.err.println("Exception when calling HealthCheckApi#getStatus");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-groovy">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-objc">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-CallbacksApi *apiInstance = [[CallbacksApi alloc] init];
-ServiceCallbackInfoV2 *serviceCallbackInfoV2 = ; //
+HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
-// Callback for Near-RT RIC status
-[apiInstance serviceCallbackWith:serviceCallbackInfoV2
- completionHandler: ^(Object output, NSError* error) {
+// Returns status and statistics of this service
+[apiInstance getStatusWithCompletionHandler:
+ ^(status_info_v2 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-javascript">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
-var api = new A1PolicyManagementService.CallbacksApi()
-var serviceCallbackInfoV2 = ; // {ServiceCallbackInfoV2}
-
+var api = new A1PolicyManagementService.HealthCheckApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.serviceCallback(serviceCallbackInfoV2, callback);
+api.getStatus(callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Callbacks-serviceCallback-0-angular">
+ <!--<div class="tab-pane" id="examples-HealthCheck-getStatus-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-csharp">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class serviceCallbackExample
+ public class getStatusExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new CallbacksApi();
- var serviceCallbackInfoV2 = new ServiceCallbackInfoV2(); // ServiceCallbackInfoV2 |
+ var apiInstance = new HealthCheckApi();
try {
- // Callback for Near-RT RIC status
- Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
+ // Returns status and statistics of this service
+ status_info_v2 result = apiInstance.getStatus();
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling CallbacksApi.serviceCallback: " + e.Message );
+ Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-php">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\CallbacksApi();
-$serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 |
+$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
try {
- $result = $api_instance->serviceCallback($serviceCallbackInfoV2);
+ $result = $api_instance->getStatus();
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling CallbacksApi->serviceCallback: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-perl">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::CallbacksApi;
+use WWW::OPenAPIClient::HealthCheckApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::CallbacksApi->new();
-my $serviceCallbackInfoV2 = WWW::OPenAPIClient::Object::ServiceCallbackInfoV2->new(); # ServiceCallbackInfoV2 |
+my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
eval {
- my $result = $api_instance->serviceCallback(serviceCallbackInfoV2 => $serviceCallbackInfoV2);
+ my $result = $api_instance->getStatus();
print Dumper($result);
};
if ($@) {
- warn "Exception when calling CallbacksApi->serviceCallback: $@\n";
+ warn "Exception when calling HealthCheckApi->getStatus: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-python">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.CallbacksApi()
-serviceCallbackInfoV2 = # ServiceCallbackInfoV2 |
+api_instance = openapi_client.HealthCheckApi()
try:
- # Callback for Near-RT RIC status
- api_response = api_instance.service_callback(serviceCallbackInfoV2)
+ # Returns status and statistics of this service
+ api_response = api_instance.get_status()
pprint(api_response)
except ApiException as e:
- print("Exception when calling CallbacksApi->serviceCallback: %s\n" % e)</code></pre>
+ print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Callbacks-serviceCallback-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate CallbacksApi;
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate HealthCheckApi;
pub fn main() {
- let serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2
- let mut context = CallbacksApi::Context::default();
- let result = client.serviceCallback(serviceCallbackInfoV2, &context).wait();
+ let mut context = HealthCheckApi::Context::default();
+ let result = client.getStatus(&context).wait();
println!("{:?}", result);
}
- <div class="methodsubtabletitle">Body parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">serviceCallbackInfoV2 <span style="color:red;">*</span></td>
-<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/service_callback_info_v2"
- }
- }
- },
- "required" : true
-};
-
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- 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_serviceCallback_serviceCallbackInfoV2');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_serviceCallback_serviceCallbackInfoV2"></div>
-</td>
-</tr>
-
- </table>
<h2>Responses</h2>
- <h3 id="examples-Callbacks-serviceCallback-title-200"></h3>
- <p id="examples-Callbacks-serviceCallback-description-200" class="marked"></p>
+ <h3 id="examples-HealthCheck-getStatus-title-200"></h3>
+ <p id="examples-HealthCheck-getStatus-description-200" class="marked"></p>
<script>
- var responseCallbacks200_description = `OK`;
- var responseCallbacks200_description_break = responseCallbacks200_description.indexOf('\n');
- if (responseCallbacks200_description_break == -1) {
- $("#examples-Callbacks-serviceCallback-title-200").text("Status: 200 - " + responseCallbacks200_description);
+ var responseHealthCheck200_description = `Service is living`;
+ var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
+ if (responseHealthCheck200_description_break == -1) {
+ $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description);
} else {
- $("#examples-Callbacks-serviceCallback-title-200").text("Status: 200 - " + responseCallbacks200_description.substring(0, responseCallbacks200_description_break));
- $("#examples-Callbacks-serviceCallback-description-200").html(responseCallbacks200_description.substring(responseCallbacks200_description_break));
+ $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
+ $("#examples-HealthCheck-getStatus-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
}
</script>
- <ul id="responses-detail-Callbacks-serviceCallback-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-HealthCheck-getStatus-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Callbacks-serviceCallback-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-HealthCheck-getStatus-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Callbacks-serviceCallback-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Callbacks-serviceCallback-200-schema">
- <div id="responses-Callbacks-serviceCallback-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-HealthCheck-getStatus-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-HealthCheck-getStatus-200-schema">
+ <div id="responses-HealthCheck-getStatus-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Service is living",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/void"
+ "$ref" : "#/components/schemas/status_info_v2"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Callbacks-serviceCallback-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Callbacks-serviceCallback-schema-200');
+ $('#responses-HealthCheck-getStatus-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-HealthCheck-getStatus-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Callbacks-serviceCallback-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-HealthCheck-getStatus-200-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-HealthCheck">
- <h1>HealthCheck</h1>
- <div id="api-HealthCheck-getStatus">
- <article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0">
+ <div id="api-HealthCheck-getStatusV1">
+ <article id="api-HealthCheck-getStatusV1-0" data-group="User" data-name="getStatusV1" data-version="0">
<div class="pull-left">
- <h1>getStatus</h1>
+ <h1>getStatusV1</h1>
<p>Returns status and statistics of this service</p>
</div>
<div class="pull-right"></div>
<p class="marked"></p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/status</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/status</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-HealthCheck-getStatus-0-curl">Curl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-java">Java</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatus-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatus-0-csharp">C#</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-php">PHP</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-perl">Perl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-python">Python</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-HealthCheck-getStatusV1-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-java">Java</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-php">PHP</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-python">Python</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-HealthCheck-getStatus-0-curl">
+ <div class="tab-pane active" id="examples-HealthCheck-getStatusV1-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
- "http://localhost/a1-policy/v2/status"
+ -H "Accept: */*" \
+ "http://localhost/status"
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-java">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
HealthCheckApi apiInstance = new HealthCheckApi();
try {
- status_info_v2 result = apiInstance.getStatus();
+ 'String' result = apiInstance.getStatusV1();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling HealthCheckApi#getStatus");
+ System.err.println("Exception when calling HealthCheckApi#getStatusV1");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-android">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.HealthCheckApi;
public class HealthCheckApiExample {
HealthCheckApi apiInstance = new HealthCheckApi();
try {
- status_info_v2 result = apiInstance.getStatus();
+ 'String' result = apiInstance.getStatusV1();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling HealthCheckApi#getStatus");
+ System.err.println("Exception when calling HealthCheckApi#getStatusV1");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-groovy">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-objc">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
// Returns status and statistics of this service
-[apiInstance getStatusWithCompletionHandler:
- ^(status_info_v2 output, NSError* error) {
+[apiInstance getStatusV1WithCompletionHandler:
+ ^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-javascript">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getStatus(callback);
+api.getStatusV1(callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-HealthCheck-getStatus-0-angular">
+ <!--<div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-csharp">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getStatusExample
+ public class getStatusV1Example
{
public void main()
{
try {
// Returns status and statistics of this service
- status_info_v2 result = apiInstance.getStatus();
+ 'String' result = apiInstance.getStatusV1();
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
+ Debug.Print("Exception when calling HealthCheckApi.getStatusV1: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-php">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
try {
- $result = $api_instance->getStatus();
+ $result = $api_instance->getStatusV1();
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling HealthCheckApi->getStatusV1: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-perl">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HealthCheckApi;
my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
eval {
- my $result = $api_instance->getStatus();
+ my $result = $api_instance->getStatusV1();
print Dumper($result);
};
if ($@) {
- warn "Exception when calling HealthCheckApi->getStatus: $@\n";
+ warn "Exception when calling HealthCheckApi->getStatusV1: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-python">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
try:
# Returns status and statistics of this service
- api_response = api_instance.get_status()
+ api_response = api_instance.get_status_v1()
pprint(api_response)
except ApiException as e:
- print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)</code></pre>
+ print("Exception when calling HealthCheckApi->getStatusV1: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-rust">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-rust">
<pre class="prettyprint"><code class="language-rust">extern crate HealthCheckApi;
pub fn main() {
let mut context = HealthCheckApi::Context::default();
- let result = client.getStatus(&context).wait();
+ let result = client.getStatusV1(&context).wait();
println!("{:?}", result);
}
<h2>Responses</h2>
- <h3 id="examples-HealthCheck-getStatus-title-200"></h3>
- <p id="examples-HealthCheck-getStatus-description-200" class="marked"></p>
+ <h3 id="examples-HealthCheck-getStatusV1-title-200"></h3>
+ <p id="examples-HealthCheck-getStatusV1-description-200" class="marked"></p>
<script>
var responseHealthCheck200_description = `Service is living`;
var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
if (responseHealthCheck200_description_break == -1) {
- $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description);
+ $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description);
} else {
- $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
- $("#examples-HealthCheck-getStatus-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
+ $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
+ $("#examples-HealthCheck-getStatusV1-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
}
</script>
- <ul id="responses-detail-HealthCheck-getStatus-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-HealthCheck-getStatusV1-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-HealthCheck-getStatus-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-HealthCheck-getStatusV1-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-HealthCheck-getStatus-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-HealthCheck-getStatus-200-schema">
- <div id="responses-HealthCheck-getStatus-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-HealthCheck-getStatusV1-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-HealthCheck-getStatusV1-200-schema">
+ <div id="responses-HealthCheck-getStatusV1-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Service is living",
"content" : {
- "application/json" : {
+ "*/*" : {
"schema" : {
- "$ref" : "#/components/schemas/status_info_v2"
+ "type" : "string"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-HealthCheck-getStatus-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-HealthCheck-getStatus-schema-200');
+ $('#responses-HealthCheck-getStatusV1-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-HealthCheck-getStatusV1-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-HealthCheck-getStatus-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-HealthCheck-getStatusV1-200-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-HealthCheck-getStatusV1">
- <article id="api-HealthCheck-getStatusV1-0" data-group="User" data-name="getStatusV1" data-version="0">
+ </section>
+ <section id="api-ManagementOfConfiguration">
+ <h1>ManagementOfConfiguration</h1>
+ <div id="api-ManagementOfConfiguration-getConfiguration">
+ <article id="api-ManagementOfConfiguration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0">
<div class="pull-left">
- <h1>getStatusV1</h1>
- <p>Returns status and statistics of this service</p>
+ <h1>getConfiguration</h1>
+ <p>Returns the contents of the application configuration file</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p class="marked"></p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/status</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/configuration</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-HealthCheck-getStatusV1-0-curl">Curl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-java">Java</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-csharp">C#</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-php">PHP</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-perl">Perl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-python">Python</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-ManagementOfConfiguration-getConfiguration-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-java">Java</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-php">PHP</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-python">Python</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-HealthCheck-getStatusV1-0-curl">
+ <div class="tab-pane active" id="examples-ManagementOfConfiguration-getConfiguration-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: */*" \
- "http://localhost/status"
+ -H "Accept: application/json" \
+ "http://localhost/a1-policy/v2/configuration"
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-java">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.HealthCheckApi;
+import org.openapitools.client.api.ManagementOfConfigurationApi;
import java.io.File;
import java.util.*;
-public class HealthCheckApiExample {
+public class ManagementOfConfigurationApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- HealthCheckApi apiInstance = new HealthCheckApi();
+ ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
try {
- 'String' result = apiInstance.getStatusV1();
+ Object result = apiInstance.getConfiguration();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling HealthCheckApi#getStatusV1");
+ System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.HealthCheckApi;
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ManagementOfConfigurationApi;
-public class HealthCheckApiExample {
+public class ManagementOfConfigurationApiExample {
public static void main(String[] args) {
- HealthCheckApi apiInstance = new HealthCheckApi();
+ ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
try {
- 'String' result = apiInstance.getStatusV1();
+ Object result = apiInstance.getConfiguration();
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling HealthCheckApi#getStatusV1");
+ System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-groovy">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-objc">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
+ManagementOfConfigurationApi *apiInstance = [[ManagementOfConfigurationApi alloc] init];
-// Returns status and statistics of this service
-[apiInstance getStatusV1WithCompletionHandler:
- ^('String' output, NSError* error) {
+// Returns the contents of the application configuration file
+[apiInstance getConfigurationWithCompletionHandler:
+ ^(Object output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-javascript">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
-var api = new A1PolicyManagementService.HealthCheckApi()
+var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getStatusV1(callback);
+api.getConfiguration(callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-angular">
+ <!--<div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-csharp">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getStatusV1Example
+ public class getConfigurationExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new HealthCheckApi();
+ var apiInstance = new ManagementOfConfigurationApi();
try {
- // Returns status and statistics of this service
- 'String' result = apiInstance.getStatusV1();
+ // Returns the contents of the application configuration file
+ Object result = apiInstance.getConfiguration();
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling HealthCheckApi.getStatusV1: " + e.Message );
+ Debug.Print("Exception when calling ManagementOfConfigurationApi.getConfiguration: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-php">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
+$api_instance = new OpenAPITools\Client\Api\ManagementOfConfigurationApi();
try {
- $result = $api_instance->getStatusV1();
+ $result = $api_instance->getConfiguration();
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling HealthCheckApi->getStatusV1: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling ManagementOfConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-perl">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::HealthCheckApi;
+use WWW::OPenAPIClient::ManagementOfConfigurationApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
+my $api_instance = WWW::OPenAPIClient::ManagementOfConfigurationApi->new();
eval {
- my $result = $api_instance->getStatusV1();
+ my $result = $api_instance->getConfiguration();
print Dumper($result);
};
if ($@) {
- warn "Exception when calling HealthCheckApi->getStatusV1: $@\n";
+ warn "Exception when calling ManagementOfConfigurationApi->getConfiguration: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-python">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.HealthCheckApi()
+api_instance = openapi_client.ManagementOfConfigurationApi()
try:
- # Returns status and statistics of this service
- api_response = api_instance.get_status_v1()
+ # Returns the contents of the application configuration file
+ api_response = api_instance.get_configuration()
pprint(api_response)
except ApiException as e:
- print("Exception when calling HealthCheckApi->getStatusV1: %s\n" % e)</code></pre>
+ print("Exception when calling ManagementOfConfigurationApi->getConfiguration: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate HealthCheckApi;
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate ManagementOfConfigurationApi;
pub fn main() {
- let mut context = HealthCheckApi::Context::default();
- let result = client.getStatusV1(&context).wait();
+ let mut context = ManagementOfConfigurationApi::Context::default();
+ let result = client.getConfiguration(&context).wait();
println!("{:?}", result);
}
<h2>Responses</h2>
- <h3 id="examples-HealthCheck-getStatusV1-title-200"></h3>
- <p id="examples-HealthCheck-getStatusV1-description-200" class="marked"></p>
+ <h3 id="examples-ManagementOfConfiguration-getConfiguration-title-200"></h3>
+ <p id="examples-ManagementOfConfiguration-getConfiguration-description-200" class="marked"></p>
<script>
- var responseHealthCheck200_description = `Service is living`;
- var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
- if (responseHealthCheck200_description_break == -1) {
- $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description);
+ var responseManagementOfConfiguration200_description = `Configuration`;
+ var responseManagementOfConfiguration200_description_break = responseManagementOfConfiguration200_description.indexOf('\n');
+ if (responseManagementOfConfiguration200_description_break == -1) {
+ $("#examples-ManagementOfConfiguration-getConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description);
} else {
- $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
- $("#examples-HealthCheck-getStatusV1-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
+ $("#examples-ManagementOfConfiguration-getConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description.substring(0, responseManagementOfConfiguration200_description_break));
+ $("#examples-ManagementOfConfiguration-getConfiguration-description-200").html(responseManagementOfConfiguration200_description.substring(responseManagementOfConfiguration200_description_break));
}
</script>
- <ul id="responses-detail-HealthCheck-getStatusV1-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-ManagementOfConfiguration-getConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-HealthCheck-getStatusV1-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-ManagementOfConfiguration-getConfiguration-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-HealthCheck-getStatusV1-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-HealthCheck-getStatusV1-200-schema">
- <div id="responses-HealthCheck-getStatusV1-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-ManagementOfConfiguration-getConfiguration-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-ManagementOfConfiguration-getConfiguration-200-schema">
+ <div id="responses-ManagementOfConfiguration-getConfiguration-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Service is living",
+ "description" : "Configuration",
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
- "type" : "string"
+ "type" : "object"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-HealthCheck-getStatusV1-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-HealthCheck-getStatusV1-schema-200');
+ $('#responses-ManagementOfConfiguration-getConfiguration-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-ManagementOfConfiguration-getConfiguration-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-HealthCheck-getStatusV1-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-ManagementOfConfiguration-getConfiguration-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- </article>
- </div>
- <hr>
- </section>
- <section id="api-ManagementOfConfiguration">
- <h1>ManagementOfConfiguration</h1>
- <div id="api-ManagementOfConfiguration-getConfiguration">
- <article id="api-ManagementOfConfiguration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0">
- <div class="pull-left">
- <h1>getConfiguration</h1>
- <p>Returns the contents of the application configuration file</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked"></p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/configuration</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-ManagementOfConfiguration-getConfiguration-0-curl">Curl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-java">Java</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-csharp">C#</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-php">PHP</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-perl">Perl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-python">Python</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-ManagementOfConfiguration-getConfiguration-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
- "http://localhost/a1-policy/v2/configuration"
-</code></pre>
+ <h3 id="examples-ManagementOfConfiguration-getConfiguration-title-404"></h3>
+ <p id="examples-ManagementOfConfiguration-getConfiguration-description-404" class="marked"></p>
+ <script>
+ var responseManagementOfConfiguration404_description = `File is not found or readable`;
+ var responseManagementOfConfiguration404_description_break = responseManagementOfConfiguration404_description.indexOf('\n');
+ if (responseManagementOfConfiguration404_description_break == -1) {
+ $("#examples-ManagementOfConfiguration-getConfiguration-title-404").text("Status: 404 - " + responseManagementOfConfiguration404_description);
+ } else {
+ $("#examples-ManagementOfConfiguration-getConfiguration-title-404").text("Status: 404 - " + responseManagementOfConfiguration404_description.substring(0, responseManagementOfConfiguration404_description_break));
+ $("#examples-ManagementOfConfiguration-getConfiguration-description-404").html(responseManagementOfConfiguration404_description.substring(responseManagementOfConfiguration404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-ManagementOfConfiguration-getConfiguration-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-ManagementOfConfiguration-getConfiguration-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-ManagementOfConfiguration-getConfiguration-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-ManagementOfConfiguration-getConfiguration-404-schema">
+ <div id="responses-ManagementOfConfiguration-getConfiguration-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "File is not found or readable",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/error_information"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$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-ManagementOfConfiguration-getConfiguration-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-ManagementOfConfiguration-getConfiguration-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-ManagementOfConfiguration-getConfiguration-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-ManagementOfConfiguration-putConfiguration">
+ <article id="api-ManagementOfConfiguration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0">
+ <div class="pull-left">
+ <h1>putConfiguration</h1>
+ <p>Replace the current configuration file with the given configuration</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked"></p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/configuration</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-ManagementOfConfiguration-putConfiguration-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-java">Java</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-php">PHP</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-python">Python</a></li>
+ <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-ManagementOfConfiguration-putConfiguration-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
+ -H "Accept: */*" \
+ -H "Content-Type: application/json" \
+ "http://localhost/a1-policy/v2/configuration" \
+ -d ''
+</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-java">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
// Create an instance of the API class
ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
+ Object body = Object; // Object |
try {
- Object result = apiInstance.getConfiguration();
+ Object result = apiInstance.putConfiguration(body);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
+ System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-android">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ManagementOfConfigurationApi;
public class ManagementOfConfigurationApiExample {
public static void main(String[] args) {
ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
+ Object body = Object; // Object |
try {
- Object result = apiInstance.getConfiguration();
+ Object result = apiInstance.putConfiguration(body);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
+ System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-groovy">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-objc">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
ManagementOfConfigurationApi *apiInstance = [[ManagementOfConfigurationApi alloc] init];
+Object *body = Object; //
-// Returns the contents of the application configuration file
-[apiInstance getConfigurationWithCompletionHandler:
- ^(Object output, NSError* error) {
+// Replace the current configuration file with the given configuration
+[apiInstance putConfigurationWith:body
+ completionHandler: ^(Object output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-javascript">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
+var body = Object; // {Object}
+
var callback = function(error, data, response) {
if (error) {
console.error(error);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getConfiguration(callback);
+api.putConfiguration(body, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-angular">
+ <!--<div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-csharp">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getConfigurationExample
+ public class putConfigurationExample
{
public void main()
{
// Create an instance of the API class
var apiInstance = new ManagementOfConfigurationApi();
+ var body = Object; // Object |
try {
- // Returns the contents of the application configuration file
- Object result = apiInstance.getConfiguration();
+ // Replace the current configuration file with the given configuration
+ Object result = apiInstance.putConfiguration(body);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling ManagementOfConfigurationApi.getConfiguration: " + e.Message );
+ Debug.Print("Exception when calling ManagementOfConfigurationApi.putConfiguration: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-php">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ManagementOfConfigurationApi();
+$body = Object; // Object |
try {
- $result = $api_instance->getConfiguration();
+ $result = $api_instance->putConfiguration($body);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling ManagementOfConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling ManagementOfConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-perl">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ManagementOfConfigurationApi;
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ManagementOfConfigurationApi->new();
+my $body = WWW::OPenAPIClient::Object::Object->new(); # Object |
eval {
- my $result = $api_instance->getConfiguration();
+ my $result = $api_instance->putConfiguration(body => $body);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling ManagementOfConfigurationApi->getConfiguration: $@\n";
+ warn "Exception when calling ManagementOfConfigurationApi->putConfiguration: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-python">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
# Create an instance of the API class
api_instance = openapi_client.ManagementOfConfigurationApi()
+body = Object # Object |
try:
- # Returns the contents of the application configuration file
- api_response = api_instance.get_configuration()
+ # Replace the current configuration file with the given configuration
+ api_response = api_instance.put_configuration(body)
pprint(api_response)
except ApiException as e:
- print("Exception when calling ManagementOfConfigurationApi->getConfiguration: %s\n" % e)</code></pre>
+ print("Exception when calling ManagementOfConfigurationApi->putConfiguration: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-rust">
+ <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-rust">
<pre class="prettyprint"><code class="language-rust">extern crate ManagementOfConfigurationApi;
pub fn main() {
+ let body = Object; // Object
let mut context = ManagementOfConfigurationApi::Context::default();
- let result = client.getConfiguration(&context).wait();
+ let result = client.putConfiguration(body, &context).wait();
println!("{:?}", result);
}
+ <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>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ },
+ "required" : true
+};
+
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ 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_putConfiguration_body');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_putConfiguration_body"></div>
+</td>
+</tr>
+
+ </table>
<h2>Responses</h2>
- <h3 id="examples-ManagementOfConfiguration-getConfiguration-title-200"></h3>
- <p id="examples-ManagementOfConfiguration-getConfiguration-description-200" class="marked"></p>
+ <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-200"></h3>
+ <p id="examples-ManagementOfConfiguration-putConfiguration-description-200" class="marked"></p>
<script>
- var responseManagementOfConfiguration200_description = `Configuration`;
+ var responseManagementOfConfiguration200_description = `Configuration updated`;
var responseManagementOfConfiguration200_description_break = responseManagementOfConfiguration200_description.indexOf('\n');
if (responseManagementOfConfiguration200_description_break == -1) {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description);
+ $("#examples-ManagementOfConfiguration-putConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description);
} else {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description.substring(0, responseManagementOfConfiguration200_description_break));
- $("#examples-ManagementOfConfiguration-getConfiguration-description-200").html(responseManagementOfConfiguration200_description.substring(responseManagementOfConfiguration200_description_break));
+ $("#examples-ManagementOfConfiguration-putConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description.substring(0, responseManagementOfConfiguration200_description_break));
+ $("#examples-ManagementOfConfiguration-putConfiguration-description-200").html(responseManagementOfConfiguration200_description.substring(responseManagementOfConfiguration200_description_break));
}
</script>
- <ul id="responses-detail-ManagementOfConfiguration-getConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-getConfiguration-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ManagementOfConfiguration-getConfiguration-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-getConfiguration-200-schema">
- <div id="responses-ManagementOfConfiguration-getConfiguration-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-200-schema">
+ <div id="responses-ManagementOfConfiguration-putConfiguration-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Configuration",
+ "description" : "Configuration updated",
"content" : {
- "application/json" : {
+ "*/*" : {
"schema" : {
- "type" : "object"
+ "$ref" : "#/components/schemas/void"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-getConfiguration-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-getConfiguration-schema-200');
+ $('#responses-ManagementOfConfiguration-putConfiguration-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ManagementOfConfiguration-getConfiguration-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-ManagementOfConfiguration-putConfiguration-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-ManagementOfConfiguration-getConfiguration-title-404"></h3>
- <p id="examples-ManagementOfConfiguration-getConfiguration-description-404" class="marked"></p>
+ <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-400"></h3>
+ <p id="examples-ManagementOfConfiguration-putConfiguration-description-400" class="marked"></p>
<script>
- var responseManagementOfConfiguration404_description = `File is not found or readable`;
- var responseManagementOfConfiguration404_description_break = responseManagementOfConfiguration404_description.indexOf('\n');
- if (responseManagementOfConfiguration404_description_break == -1) {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-404").text("Status: 404 - " + responseManagementOfConfiguration404_description);
+ var responseManagementOfConfiguration400_description = `Invalid configuration provided`;
+ var responseManagementOfConfiguration400_description_break = responseManagementOfConfiguration400_description.indexOf('\n');
+ if (responseManagementOfConfiguration400_description_break == -1) {
+ $("#examples-ManagementOfConfiguration-putConfiguration-title-400").text("Status: 400 - " + responseManagementOfConfiguration400_description);
} else {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-404").text("Status: 404 - " + responseManagementOfConfiguration404_description.substring(0, responseManagementOfConfiguration404_description_break));
- $("#examples-ManagementOfConfiguration-getConfiguration-description-404").html(responseManagementOfConfiguration404_description.substring(responseManagementOfConfiguration404_description_break));
+ $("#examples-ManagementOfConfiguration-putConfiguration-title-400").text("Status: 400 - " + responseManagementOfConfiguration400_description.substring(0, responseManagementOfConfiguration400_description_break));
+ $("#examples-ManagementOfConfiguration-putConfiguration-description-400").html(responseManagementOfConfiguration400_description.substring(responseManagementOfConfiguration400_description_break));
}
</script>
- <ul id="responses-detail-ManagementOfConfiguration-getConfiguration-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-getConfiguration-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ManagementOfConfiguration-getConfiguration-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-getConfiguration-404-schema">
- <div id="responses-ManagementOfConfiguration-getConfiguration-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-400-schema">
+ <div id="responses-ManagementOfConfiguration-putConfiguration-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "File is not found or readable",
+ "description" : "Invalid configuration provided",
"content" : {
- "application/json" : {
+ "*/*" : {
"schema" : {
"$ref" : "#/components/schemas/error_information"
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-getConfiguration-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-getConfiguration-schema-404');
+ $('#responses-ManagementOfConfiguration-putConfiguration-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ManagementOfConfiguration-getConfiguration-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-ManagementOfConfiguration-putConfiguration-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-500"></h3>
+ <p id="examples-ManagementOfConfiguration-putConfiguration-description-500" class="marked"></p>
+ <script>
+ var responseManagementOfConfiguration500_description = `Something went wrong when replacing the configuration. Try again.`;
+ var responseManagementOfConfiguration500_description_break = responseManagementOfConfiguration500_description.indexOf('\n');
+ if (responseManagementOfConfiguration500_description_break == -1) {
+ $("#examples-ManagementOfConfiguration-putConfiguration-title-500").text("Status: 500 - " + responseManagementOfConfiguration500_description);
+ } else {
+ $("#examples-ManagementOfConfiguration-putConfiguration-title-500").text("Status: 500 - " + responseManagementOfConfiguration500_description.substring(0, responseManagementOfConfiguration500_description_break));
+ $("#examples-ManagementOfConfiguration-putConfiguration-description-500").html(responseManagementOfConfiguration500_description.substring(responseManagementOfConfiguration500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-500-schema">
+ <div id="responses-ManagementOfConfiguration-putConfiguration-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Something went wrong when replacing the configuration. Try again.",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/error_information"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$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-ManagementOfConfiguration-putConfiguration-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-ManagementOfConfiguration-putConfiguration-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-ManagementOfConfiguration-putConfiguration">
- <article id="api-ManagementOfConfiguration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0">
+ </section>
+ <section id="api-NearRTRICRepository">
+ <h1>NearRTRICRepository</h1>
+ <div id="api-NearRTRICRepository-getRic">
+ <article id="api-NearRTRICRepository-getRic-0" data-group="User" data-name="getRic" data-version="0">
<div class="pull-left">
- <h1>putConfiguration</h1>
- <p>Replace the current configuration file with the given configuration</p>
+ <h1>getRic</h1>
+ <p>Returns info for one Near-RT RIC</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/rics/ric</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-ManagementOfConfiguration-putConfiguration-0-curl">Curl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-java">Java</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-csharp">C#</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-php">PHP</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-perl">Perl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-python">Python</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-NearRTRICRepository-getRic-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-java">Java</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-NearRTRICRepository-getRic-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-NearRTRICRepository-getRic-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-php">PHP</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-python">Python</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRic-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-ManagementOfConfiguration-putConfiguration-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: */*" \
- -H "Content-Type: application/json" \
- "http://localhost/a1-policy/v2/configuration" \
- -d ''
+ <div class="tab-pane active" id="examples-NearRTRICRepository-getRic-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json" \
+ "http://localhost/a1-policy/v2/rics/ric?managed_element_id=managedElementId_example&ric_id=ricId_example"
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-java">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.ManagementOfConfigurationApi;
+import org.openapitools.client.api.NearRTRICRepositoryApi;
import java.io.File;
import java.util.*;
-public class ManagementOfConfigurationApiExample {
+public class NearRTRICRepositoryApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
- Object body = Object; // Object |
+ NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+ String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+ String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
try {
- Object result = apiInstance.putConfiguration(body);
+ ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
+ System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ManagementOfConfigurationApi;
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.NearRTRICRepositoryApi;
-public class ManagementOfConfigurationApiExample {
+public class NearRTRICRepositoryApiExample {
public static void main(String[] args) {
- ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
- Object body = Object; // Object |
+ NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+ String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+ String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
try {
- Object result = apiInstance.putConfiguration(body);
+ ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
+ System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-groovy">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-objc">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-ManagementOfConfigurationApi *apiInstance = [[ManagementOfConfigurationApi alloc] init];
-Object *body = Object; //
+NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
+String *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (optional) (default to null)
-// Replace the current configuration file with the given configuration
-[apiInstance putConfigurationWith:body
- completionHandler: ^(Object output, NSError* error) {
+// Returns info for one Near-RT RIC
+[apiInstance getRicWith:managedElementId
+ ricId:ricId
+ completionHandler: ^(ric_info_v2 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-javascript">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
-var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
-var body = Object; // {Object}
+var api = new A1PolicyManagementService.NearRTRICRepositoryApi()
+var opts = {
+ 'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+ 'ricId': ricId_example // {String} The identity of a Near-RT RIC to get information for.
+};
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.putConfiguration(body, callback);
+api.getRic(opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-angular">
+ <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-csharp">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class putConfigurationExample
+ public class getRicExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new ManagementOfConfigurationApi();
- var body = Object; // Object |
+ var apiInstance = new NearRTRICRepositoryApi();
+ var managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+ var ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
try {
- // Replace the current configuration file with the given configuration
- Object result = apiInstance.putConfiguration(body);
+ // Returns info for one Near-RT RIC
+ ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling ManagementOfConfigurationApi.putConfiguration: " + e.Message );
+ Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-php">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\ManagementOfConfigurationApi();
-$body = Object; // Object |
+$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
+$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
try {
- $result = $api_instance->putConfiguration($body);
+ $result = $api_instance->getRic($managedElementId, $ricId);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling ManagementOfConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-perl">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::ManagementOfConfigurationApi;
+use WWW::OPenAPIClient::NearRTRICRepositoryApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::ManagementOfConfigurationApi->new();
-my $body = WWW::OPenAPIClient::Object::Object->new(); # Object |
+my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
+my $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
eval {
- my $result = $api_instance->putConfiguration(body => $body);
+ my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling ManagementOfConfigurationApi->putConfiguration: $@\n";
+ warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-python">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.ManagementOfConfigurationApi()
-body = Object # Object |
+api_instance = openapi_client.NearRTRICRepositoryApi()
+managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
try:
- # Replace the current configuration file with the given configuration
- api_response = api_instance.put_configuration(body)
+ # Returns info for one Near-RT RIC
+ api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId)
pprint(api_response)
except ApiException as e:
- print("Exception when calling ManagementOfConfigurationApi->putConfiguration: %s\n" % e)</code></pre>
+ print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate ManagementOfConfigurationApi;
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate NearRTRICRepositoryApi;
pub fn main() {
- let body = Object; // Object
+ let managedElementId = managedElementId_example; // String
+ let ricId = ricId_example; // String
- let mut context = ManagementOfConfigurationApi::Context::default();
- let result = client.putConfiguration(body, &context).wait();
+ let mut context = NearRTRICRepositoryApi::Context::default();
+ let result = client.getRic(managedElementId, ricId, &context).wait();
println!("{:?}", result);
}
- <div class="methodsubtabletitle">Body parameters</div>
+
+
+ <div class="methodsubtabletitle">Query 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>
+ <tr><td style="width:150px;">managed_element_id</td>
<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object"
- }
- }
- },
- "required" : true
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- 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_putConfiguration_body');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_putConfiguration_body"></div>
+ <div id="d2e199_getRic_managedElementId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+ </div>
+ </div>
+ </div>
+ </div>
</td>
</tr>
- </table>
-
-
-
- <h2>Responses</h2>
- <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-200"></h3>
- <p id="examples-ManagementOfConfiguration-putConfiguration-description-200" class="marked"></p>
- <script>
- var responseManagementOfConfiguration200_description = `Configuration updated`;
- var responseManagementOfConfiguration200_description_break = responseManagementOfConfiguration200_description.indexOf('\n');
- if (responseManagementOfConfiguration200_description_break == -1) {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description);
- } else {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description.substring(0, responseManagementOfConfiguration200_description_break));
- $("#examples-ManagementOfConfiguration-putConfiguration-description-200").html(responseManagementOfConfiguration200_description.substring(responseManagementOfConfiguration200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-200-schema">Schema</a>
- </li>
-
-
+ <tr><td style="width:150px;">ric_id</td>
+<td>
- </ul>
+ <div id="d2e199_getRic_ricId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+ <div class="inner description marked">
+The identity of a Near-RT RIC to get information for.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
- <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-200-schema">
- <div id="responses-ManagementOfConfiguration-putConfiguration-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Configuration updated",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$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);
- });
- }
+ </table>
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-putConfiguration-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ManagementOfConfiguration-putConfiguration-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-400"></h3>
- <p id="examples-ManagementOfConfiguration-putConfiguration-description-400" class="marked"></p>
+ <h2>Responses</h2>
+ <h3 id="examples-NearRTRICRepository-getRic-title-200"></h3>
+ <p id="examples-NearRTRICRepository-getRic-description-200" class="marked"></p>
<script>
- var responseManagementOfConfiguration400_description = `Invalid configuration provided`;
- var responseManagementOfConfiguration400_description_break = responseManagementOfConfiguration400_description.indexOf('\n');
- if (responseManagementOfConfiguration400_description_break == -1) {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-400").text("Status: 400 - " + responseManagementOfConfiguration400_description);
+ var responseNearRTRICRepository200_description = `Near-RT RIC is found`;
+ var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
+ if (responseNearRTRICRepository200_description_break == -1) {
+ $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
} else {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-400").text("Status: 400 - " + responseManagementOfConfiguration400_description.substring(0, responseManagementOfConfiguration400_description_break));
- $("#examples-ManagementOfConfiguration-putConfiguration-description-400").html(responseManagementOfConfiguration400_description.substring(responseManagementOfConfiguration400_description_break));
+ $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
+ $("#examples-NearRTRICRepository-getRic-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
}
</script>
- <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-NearRTRICRepository-getRic-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-400-schema">
- <div id="responses-ManagementOfConfiguration-putConfiguration-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-NearRTRICRepository-getRic-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-200-schema">
+ <div id="responses-NearRTRICRepository-getRic-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Invalid configuration provided",
+ "description" : "Near-RT RIC is found",
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/error_information"
+ "$ref" : "#/components/schemas/ric_info_v2"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-putConfiguration-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-400');
+ $('#responses-NearRTRICRepository-getRic-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-NearRTRICRepository-getRic-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ManagementOfConfiguration-putConfiguration-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-NearRTRICRepository-getRic-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-500"></h3>
- <p id="examples-ManagementOfConfiguration-putConfiguration-description-500" class="marked"></p>
+ <h3 id="examples-NearRTRICRepository-getRic-title-404"></h3>
+ <p id="examples-NearRTRICRepository-getRic-description-404" class="marked"></p>
<script>
- var responseManagementOfConfiguration500_description = `Something went wrong when replacing the configuration. Try again.`;
- var responseManagementOfConfiguration500_description_break = responseManagementOfConfiguration500_description.indexOf('\n');
- if (responseManagementOfConfiguration500_description_break == -1) {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-500").text("Status: 500 - " + responseManagementOfConfiguration500_description);
+ var responseNearRTRICRepository404_description = `Near-RT RIC is not found`;
+ var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
+ if (responseNearRTRICRepository404_description_break == -1) {
+ $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
} else {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-500").text("Status: 500 - " + responseManagementOfConfiguration500_description.substring(0, responseManagementOfConfiguration500_description_break));
- $("#examples-ManagementOfConfiguration-putConfiguration-description-500").html(responseManagementOfConfiguration500_description.substring(responseManagementOfConfiguration500_description_break));
+ $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
+ $("#examples-NearRTRICRepository-getRic-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
}
</script>
- <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-NearRTRICRepository-getRic-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-500-schema">
- <div id="responses-ManagementOfConfiguration-putConfiguration-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-NearRTRICRepository-getRic-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-404-schema">
+ <div id="responses-NearRTRICRepository-getRic-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Something went wrong when replacing the configuration. Try again.",
+ "description" : "Near-RT RIC is not found",
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
"$ref" : "#/components/schemas/error_information"
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-putConfiguration-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-500');
+ $('#responses-NearRTRICRepository-getRic-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-NearRTRICRepository-getRic-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ManagementOfConfiguration-putConfiguration-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-NearRTRICRepository-getRic-404-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-NearRTRICRepository">
- <h1>NearRTRICRepository</h1>
- <div id="api-NearRTRICRepository-getRic">
- <article id="api-NearRTRICRepository-getRic-0" data-group="User" data-name="getRic" data-version="0">
+ <div id="api-NearRTRICRepository-getRics">
+ <article id="api-NearRTRICRepository-getRics-0" data-group="User" data-name="getRics" data-version="0">
<div class="pull-left">
- <h1>getRic</h1>
- <p>Returns info for one Near-RT RIC</p>
+ <h1>getRics</h1>
+ <p>Query Near-RT RIC information</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).</p>
+ <p class="marked">The call returns all Near-RT RICs that supports a given policy type identity</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/rics/ric</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/rics</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-NearRTRICRepository-getRic-0-curl">Curl</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-java">Java</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-NearRTRICRepository-getRic-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-NearRTRICRepository-getRic-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-csharp">C#</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-php">PHP</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-perl">Perl</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-python">Python</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRic-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-NearRTRICRepository-getRics-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-java">Java</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-php">PHP</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-python">Python</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-NearRTRICRepository-getRic-0-curl">
+ <div class="tab-pane active" id="examples-NearRTRICRepository-getRics-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json" \
- "http://localhost/a1-policy/v2/rics/ric?managed_element_id=managedElementId_example&ric_id=ricId_example"
+ "http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-java">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
// Create an instance of the API class
NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
- String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
- String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+ String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
try {
- ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
+ ric_info_list_v2 result = apiInstance.getRics(policytypeId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
+ System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-android">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.NearRTRICRepositoryApi;
public class NearRTRICRepositoryApiExample {
public static void main(String[] args) {
NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
- String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
- String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+ String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
try {
- ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
+ ric_info_list_v2 result = apiInstance.getRics(policytypeId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
+ System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-groovy">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-objc">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
-String *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
-String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (optional) (default to null)
+String *policytypeId = policytypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
-// Returns info for one Near-RT RIC
-[apiInstance getRicWith:managedElementId
- ricId:ricId
- completionHandler: ^(ric_info_v2 output, NSError* error) {
+// Query Near-RT RIC information
+[apiInstance getRicsWith:policytypeId
+ completionHandler: ^(ric_info_list_v2 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-javascript">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
var api = new A1PolicyManagementService.NearRTRICRepositoryApi()
var opts = {
- 'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
- 'ricId': ricId_example // {String} The identity of a Near-RT RIC to get information for.
+ 'policytypeId': policytypeId_example // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
};
var callback = function(error, data, response) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getRic(opts, callback);
+api.getRics(opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-angular">
+ <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-csharp">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getRicExample
+ public class getRicsExample
{
public void main()
{
// Create an instance of the API class
var apiInstance = new NearRTRICRepositoryApi();
- var managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
- var ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
+ var policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
try {
- // Returns info for one Near-RT RIC
- ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
+ // Query Near-RT RIC information
+ ric_info_list_v2 result = apiInstance.getRics(policytypeId);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
+ Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-php">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
-$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
-$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+$policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
try {
- $result = $api_instance->getRic($managedElementId, $ricId);
+ $result = $api_instance->getRics($policytypeId);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-perl">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NearRTRICRepositoryApi;
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
-my $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
-my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
+my $policytypeId = policytypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
eval {
- my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId);
+ my $result = $api_instance->getRics(policytypeId => $policytypeId);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
+ warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-python">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
# Create an instance of the API class
api_instance = openapi_client.NearRTRICRepositoryApi()
-managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
-ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
+policytypeId = policytypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
try:
- # Returns info for one Near-RT RIC
- api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId)
+ # Query Near-RT RIC information
+ api_response = api_instance.get_rics(policytypeId=policytypeId)
pprint(api_response)
except ApiException as e:
- print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)</code></pre>
+ print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-rust">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-rust">
<pre class="prettyprint"><code class="language-rust">extern crate NearRTRICRepositoryApi;
pub fn main() {
- let managedElementId = managedElementId_example; // String
- let ricId = ricId_example; // String
+ let policytypeId = policytypeId_example; // String
let mut context = NearRTRICRepositoryApi::Context::default();
- let result = client.getRic(managedElementId, ricId, &context).wait();
+ let result = client.getRics(policytypeId, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">managed_element_id</td>
-<td>
-
-
- <div id="d2e199_getRic_managedElementId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">ric_id</td>
+ <tr><td style="width:150px;">policytype_id</td>
<td>
- <div id="d2e199_getRic_ricId">
+ <div id="d2e199_getRics_policytypeId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</span>
<div class="inner description marked">
-The identity of a Near-RT RIC to get information for.
+The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
</div>
</div>
</div>
</table>
<h2>Responses</h2>
- <h3 id="examples-NearRTRICRepository-getRic-title-200"></h3>
- <p id="examples-NearRTRICRepository-getRic-description-200" class="marked"></p>
+ <h3 id="examples-NearRTRICRepository-getRics-title-200"></h3>
+ <p id="examples-NearRTRICRepository-getRics-description-200" class="marked"></p>
<script>
- var responseNearRTRICRepository200_description = `Near-RT RIC is found`;
+ var responseNearRTRICRepository200_description = `OK`;
var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
if (responseNearRTRICRepository200_description_break == -1) {
- $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
+ $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
} else {
- $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
- $("#examples-NearRTRICRepository-getRic-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
+ $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
+ $("#examples-NearRTRICRepository-getRics-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
}
</script>
- <ul id="responses-detail-NearRTRICRepository-getRic-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-NearRTRICRepository-getRics-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-NearRTRICRepository-getRic-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-200-schema">
- <div id="responses-NearRTRICRepository-getRic-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-NearRTRICRepository-getRics-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-200-schema">
+ <div id="responses-NearRTRICRepository-getRics-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Near-RT RIC is found",
+ "description" : "OK",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ric_info_v2"
+ "$ref" : "#/components/schemas/ric_info_list_v2"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRic-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRic-schema-200');
+ $('#responses-NearRTRICRepository-getRics-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-NearRTRICRepository-getRics-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-NearRTRICRepository-getRic-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-NearRTRICRepository-getRics-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-NearRTRICRepository-getRic-title-404"></h3>
- <p id="examples-NearRTRICRepository-getRic-description-404" class="marked"></p>
+ <h3 id="examples-NearRTRICRepository-getRics-title-404"></h3>
+ <p id="examples-NearRTRICRepository-getRics-description-404" class="marked"></p>
<script>
- var responseNearRTRICRepository404_description = `Near-RT RIC is not found`;
+ var responseNearRTRICRepository404_description = `Policy type is not found`;
var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
if (responseNearRTRICRepository404_description_break == -1) {
- $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
+ $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
} else {
- $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
- $("#examples-NearRTRICRepository-getRic-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
+ $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
+ $("#examples-NearRTRICRepository-getRics-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
}
</script>
- <ul id="responses-detail-NearRTRICRepository-getRic-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-NearRTRICRepository-getRics-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-NearRTRICRepository-getRic-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-404-schema">
- <div id="responses-NearRTRICRepository-getRic-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-NearRTRICRepository-getRics-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-404-schema">
+ <div id="responses-NearRTRICRepository-getRics-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Near-RT RIC is not found",
+ "description" : "Policy type is not found",
"content" : {
"application/json" : {
"schema" : {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRic-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRic-schema-404');
+ $('#responses-NearRTRICRepository-getRics-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-NearRTRICRepository-getRics-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-NearRTRICRepository-getRic-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-NearRTRICRepository-getRics-404-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-NearRTRICRepository-getRics">
- <article id="api-NearRTRICRepository-getRics-0" data-group="User" data-name="getRics" data-version="0">
+ </section>
+ <section id="api-ServiceCallbacks">
+ <h1>ServiceCallbacks</h1>
+ <div id="api-ServiceCallbacks-serviceCallback">
+ <article id="api-ServiceCallbacks-serviceCallback-0" data-group="User" data-name="serviceCallback" data-version="0">
<div class="pull-left">
- <h1>getRics</h1>
- <p>Query Near-RT RIC information</p>
+ <h1>serviceCallback</h1>
+ <p>Callback for Near-RT RIC status</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">The call returns all Near-RT RICs that supports a given policy type identity</p>
+ <p class="marked">The URL to this call is registered at Service registration.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/rics</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/r-app/near-rt-ric-status</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-NearRTRICRepository-getRics-0-curl">Curl</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-java">Java</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-csharp">C#</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-php">PHP</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-perl">Perl</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-python">Python</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-ServiceCallbacks-serviceCallback-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-java">Java</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-php">PHP</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-python">Python</a></li>
+ <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-NearRTRICRepository-getRics-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ <div class="tab-pane active" id="examples-ServiceCallbacks-serviceCallback-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
-H "Accept: application/json" \
- "http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
+ -H "Content-Type: application/json" \
+ "http://localhost/r-app/near-rt-ric-status" \
+ -d ''
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-java">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.NearRTRICRepositoryApi;
+import org.openapitools.client.api.ServiceCallbacksApi;
import java.io.File;
import java.util.*;
-public class NearRTRICRepositoryApiExample {
+public class ServiceCallbacksApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
- String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+ ServiceCallbacksApi apiInstance = new ServiceCallbacksApi();
+ ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 |
try {
- ric_info_list_v2 result = apiInstance.getRics(policytypeId);
+ Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
+ System.err.println("Exception when calling ServiceCallbacksApi#serviceCallback");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.NearRTRICRepositoryApi;
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ServiceCallbacksApi;
-public class NearRTRICRepositoryApiExample {
+public class ServiceCallbacksApiExample {
public static void main(String[] args) {
- NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
- String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+ ServiceCallbacksApi apiInstance = new ServiceCallbacksApi();
+ ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 |
try {
- ric_info_list_v2 result = apiInstance.getRics(policytypeId);
+ Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
+ System.err.println("Exception when calling ServiceCallbacksApi#serviceCallback");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-groovy">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-objc">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
-String *policytypeId = policytypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+ServiceCallbacksApi *apiInstance = [[ServiceCallbacksApi alloc] init];
+ServiceCallbackInfoV2 *serviceCallbackInfoV2 = ; //
-// Query Near-RT RIC information
-[apiInstance getRicsWith:policytypeId
- completionHandler: ^(ric_info_list_v2 output, NSError* error) {
+// Callback for Near-RT RIC status
+[apiInstance serviceCallbackWith:serviceCallbackInfoV2
+ completionHandler: ^(Object output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-javascript">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
-var api = new A1PolicyManagementService.NearRTRICRepositoryApi()
-var opts = {
- 'policytypeId': policytypeId_example // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
-};
+var api = new A1PolicyManagementService.ServiceCallbacksApi()
+var serviceCallbackInfoV2 = ; // {ServiceCallbackInfoV2}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getRics(opts, callback);
+api.serviceCallback(serviceCallbackInfoV2, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-angular">
+ <!--<div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-csharp">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getRicsExample
+ public class serviceCallbackExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new NearRTRICRepositoryApi();
- var policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+ var apiInstance = new ServiceCallbacksApi();
+ var serviceCallbackInfoV2 = new ServiceCallbackInfoV2(); // ServiceCallbackInfoV2 |
try {
- // Query Near-RT RIC information
- ric_info_list_v2 result = apiInstance.getRics(policytypeId);
+ // Callback for Near-RT RIC status
+ Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
+ Debug.Print("Exception when calling ServiceCallbacksApi.serviceCallback: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-php">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
-$policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+$api_instance = new OpenAPITools\Client\Api\ServiceCallbacksApi();
+$serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 |
try {
- $result = $api_instance->getRics($policytypeId);
+ $result = $api_instance->serviceCallback($serviceCallbackInfoV2);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling ServiceCallbacksApi->serviceCallback: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-perl">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::NearRTRICRepositoryApi;
+use WWW::OPenAPIClient::ServiceCallbacksApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
-my $policytypeId = policytypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+my $api_instance = WWW::OPenAPIClient::ServiceCallbacksApi->new();
+my $serviceCallbackInfoV2 = WWW::OPenAPIClient::Object::ServiceCallbackInfoV2->new(); # ServiceCallbackInfoV2 |
eval {
- my $result = $api_instance->getRics(policytypeId => $policytypeId);
+ my $result = $api_instance->serviceCallback(serviceCallbackInfoV2 => $serviceCallbackInfoV2);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
+ warn "Exception when calling ServiceCallbacksApi->serviceCallback: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-python">
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.NearRTRICRepositoryApi()
-policytypeId = policytypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+api_instance = openapi_client.ServiceCallbacksApi()
+serviceCallbackInfoV2 = # ServiceCallbackInfoV2 |
try:
- # Query Near-RT RIC information
- api_response = api_instance.get_rics(policytypeId=policytypeId)
+ # Callback for Near-RT RIC status
+ api_response = api_instance.service_callback(serviceCallbackInfoV2)
pprint(api_response)
except ApiException as e:
- print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)</code></pre>
+ print("Exception when calling ServiceCallbacksApi->serviceCallback: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate NearRTRICRepositoryApi;
+ <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate ServiceCallbacksApi;
pub fn main() {
- let policytypeId = policytypeId_example; // String
+ let serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2
- let mut context = NearRTRICRepositoryApi::Context::default();
- let result = client.getRics(policytypeId, &context).wait();
+ let mut context = ServiceCallbacksApi::Context::default();
+ let result = client.serviceCallback(serviceCallbackInfoV2, &context).wait();
println!("{:?}", result);
}
-
-
- <div class="methodsubtabletitle">Query parameters</div>
+ <div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">policytype_id</td>
+ <tr><td style="width:150px;">serviceCallbackInfoV2 <span style="color:red;">*</span></td>
<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/service_callback_info_v2"
+ }
+ }
+ },
+ "required" : true
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ 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);
+ });
+ }
- <div id="d2e199_getRics_policytypeId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
- </div>
- </div>
- </div>
- </div>
+ var view = new JSONSchemaView(schema,2,{isBodyParam: true});
+ var result = $('#d2e199_serviceCallback_serviceCallbackInfoV2');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_serviceCallback_serviceCallbackInfoV2"></div>
</td>
</tr>
</table>
- <h2>Responses</h2>
- <h3 id="examples-NearRTRICRepository-getRics-title-200"></h3>
- <p id="examples-NearRTRICRepository-getRics-description-200" class="marked"></p>
- <script>
- var responseNearRTRICRepository200_description = `OK`;
- var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
- if (responseNearRTRICRepository200_description_break == -1) {
- $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
- } else {
- $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
- $("#examples-NearRTRICRepository-getRics-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-NearRTRICRepository-getRics-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-200-schema">Schema</a>
- </li>
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-NearRTRICRepository-getRics-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-200-schema">
- <div id="responses-NearRTRICRepository-getRics-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ric_info_list_v2"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$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-NearRTRICRepository-getRics-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRics-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-NearRTRICRepository-getRics-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-NearRTRICRepository-getRics-title-404"></h3>
- <p id="examples-NearRTRICRepository-getRics-description-404" class="marked"></p>
+ <h2>Responses</h2>
+ <h3 id="examples-ServiceCallbacks-serviceCallback-title-200"></h3>
+ <p id="examples-ServiceCallbacks-serviceCallback-description-200" class="marked"></p>
<script>
- var responseNearRTRICRepository404_description = `Policy type is not found`;
- var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
- if (responseNearRTRICRepository404_description_break == -1) {
- $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
+ var responseServiceCallbacks200_description = `OK`;
+ var responseServiceCallbacks200_description_break = responseServiceCallbacks200_description.indexOf('\n');
+ if (responseServiceCallbacks200_description_break == -1) {
+ $("#examples-ServiceCallbacks-serviceCallback-title-200").text("Status: 200 - " + responseServiceCallbacks200_description);
} else {
- $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
- $("#examples-NearRTRICRepository-getRics-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
+ $("#examples-ServiceCallbacks-serviceCallback-title-200").text("Status: 200 - " + responseServiceCallbacks200_description.substring(0, responseServiceCallbacks200_description_break));
+ $("#examples-ServiceCallbacks-serviceCallback-description-200").html(responseServiceCallbacks200_description.substring(responseServiceCallbacks200_description_break));
}
</script>
- <ul id="responses-detail-NearRTRICRepository-getRics-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-ServiceCallbacks-serviceCallback-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-ServiceCallbacks-serviceCallback-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-NearRTRICRepository-getRics-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-404-schema">
- <div id="responses-NearRTRICRepository-getRics-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-ServiceCallbacks-serviceCallback-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-ServiceCallbacks-serviceCallback-200-schema">
+ <div id="responses-ServiceCallbacks-serviceCallback-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Policy type is not found",
+ "description" : "OK",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/error_information"
+ "$ref" : "#/components/schemas/void"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRics-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRics-schema-404');
+ $('#responses-ServiceCallbacks-serviceCallback-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-ServiceCallbacks-serviceCallback-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-NearRTRICRepository-getRics-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-ServiceCallbacks-serviceCallback-200-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
Code Review / ccsdk / oran.git / commitdiff
