};
defs["Domains_items_inner"] = {
"properties" : {
- "name" : {
+ "domainName" : {
"type" : "string"
},
"entityTypes" : {
}
}
};
- defs["EntitiesResponseMessage"] = {
+ defs["Entities"] = {
"title" : "Entities",
+ "required" : [ "items" ],
"type" : "object",
"properties" : {
"items" : {
defs["EntityTypes_items_inner"] = {
"type" : "object",
"properties" : {
- "name" : {
+ "entityTypeName" : {
"type" : "string"
},
"entities" : {
"type" : "integer"
}
}
+};
+ defs["ProblemDetails"] = {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string",
+ "description" : "a URI reference according to IETF RFC 3986 that identifies the problem type"
+ },
+ "title" : {
+ "type" : "string",
+ "description" : "human-readable summary of the problem type"
+ },
+ "status" : {
+ "type" : "number",
+ "description" : "the HTTP status code"
+ },
+ "detail" : {
+ "type" : "string",
+ "description" : "human-readable explanation "
+ },
+ "instance" : {
+ "type" : "string",
+ "description" : "URI reference that identifies the specific occurrence of the problem"
+ }
+ },
+ "description" : "A problem detail to carry details in an HTTP response according to RFC 7807"
};
defs["RelationshipTypes"] = {
"title" : "RelationshipTypes",
defs["RelationshipTypes_items_inner"] = {
"type" : "object",
"properties" : {
- "name" : {
+ "relationshipTypeName" : {
"type" : "string"
},
"relationships" : {
}
}
};
- defs["RelationshipsResponseMessage"] = {
+ defs["Relationships"] = {
"title" : "Relationships",
+ "required" : [ "items" ],
"type" : "object",
"properties" : {
"items" : {
"type" : "array",
"items" : {
"type" : "object",
- "description" : "Refer to yang model for schema definition of topology relationships"
+ "description" : "'Encapsulated object reference to the data model for schema definition of Topology Relationships"
}
},
"self" : {
}
}
};
- defs["SchemaList"] = {
+ defs["Schemas"] = {
"title" : "Schemas",
"type" : "object",
"properties" : {
}
}
};
+ defs["UserDefinedSchema"] = {
+ "title" : "UserDefinedSchema",
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "revision" : {
+ "type" : "string"
+ },
+ "content" : {
+ "$ref" : "#/components/schemas/Href"
+ }
+ }
+};
+ defs["UserDefinedSchemas"] = {
+ "title" : "UserDefinedSchemas",
+ "type" : "object",
+ "properties" : {
+ "items" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/UserDefinedSchema"
+ }
+ }
+ }
+};
var errs = {};
<li data-group="Classifiers" data-name="updateClassifier" class="">
<a href="#api-Classifiers-updateClassifier">updateClassifier</a>
</li>
+ <li data-group="Classifiers" data-name="updateClassifierDeprecated" class="">
+ <a href="#api-Classifiers-updateClassifierDeprecated">updateClassifierDeprecated</a>
+ </li>
<li class="nav-header" data-group="Decorators"><a href="#api-Decorators">API Methods - Decorators</a></li>
<li data-group="Decorators" data-name="updateDecorator" class="">
<a href="#api-Decorators-updateDecorator">updateDecorator</a>
</li>
+ <li data-group="Decorators" data-name="updateDecoratorDeprecated" class="">
+ <a href="#api-Decorators-updateDecoratorDeprecated">updateDecoratorDeprecated</a>
+ </li>
<li class="nav-header" data-group="EntitiesAndRelationships"><a href="#api-EntitiesAndRelationships">API Methods - EntitiesAndRelationships</a></li>
<li data-group="EntitiesAndRelationships" data-name="getAllDomains" class="">
<a href="#api-EntitiesAndRelationships-getAllDomains">getAllDomains</a>
<li data-group="Schemas" data-name="getSchemas" class="">
<a href="#api-Schemas-getSchemas">getSchemas</a>
</li>
+ <li class="nav-header" data-group="UserDefinedSchemas"><a href="#api-UserDefinedSchemas">API Methods - UserDefinedSchemas</a></li>
+ <li data-group="UserDefinedSchemas" data-name="createUserDefinedSchema" class="">
+ <a href="#api-UserDefinedSchemas-createUserDefinedSchema">createUserDefinedSchema</a>
+ </li>
+ <li data-group="UserDefinedSchemas" data-name="deleteUserDefinedSchema" class="">
+ <a href="#api-UserDefinedSchemas-deleteUserDefinedSchema">deleteUserDefinedSchema</a>
+ </li>
+ <li data-group="UserDefinedSchemas" data-name="getUserDefinedSchemaByName" class="">
+ <a href="#api-UserDefinedSchemas-getUserDefinedSchemaByName">getUserDefinedSchemaByName</a>
+ </li>
+ <li data-group="UserDefinedSchemas" data-name="getUserDefinedSchemas" class="">
+ <a href="#api-UserDefinedSchemas-getUserDefinedSchemas">getUserDefinedSchemas</a>
+ </li>
</ul>
</nav>
</div>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
- <div class="app-desc">Version: 0.11.0</div>
+ <div class="app-desc">Version: 1.2.0</div>
<hr>
<div id="app-description" class="app-desc">
<p>Topology Exposure and Inventory data is the information that represents entities
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Update entities and/or relationships with classifier(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.</p>
+ <p class="marked">Update entities and/or relationships with classifier(s).</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/classifiers</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/manage-classifiers</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<pre class="prettyprint"><code class="language-bsh">curl -X POST \
-H "Accept: application/problem+json" \
-H "Content-Type: application/json" \
- "https://localhost/topology-inventory/v1alpha11/classifiers" \
+ "https://localhost/topology-inventory/v1/manage-classifiers" \
-d '{
"classifiers" : [ "classifiers", "classifiers" ],
"relationshipIds" : [ "relationshipIds", "relationshipIds" ],
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
<input id='responses-Classifiers-updateClassifier-403-schema-data' type='hidden' value=''></input>
</div>
</div>
+ <h3 id="examples-Classifiers-updateClassifier-title-404"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-404" class="marked"></p>
+ <script>
+ var responseClassifiers404_description = `Not Found`;
+ var responseClassifiers404_description_break = responseClassifiers404_description.indexOf('\n');
+ if (responseClassifiers404_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-404").text("Status: 404 - " + responseClassifiers404_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-404").text("Status: 404 - " + responseClassifiers404_description.substring(0, responseClassifiers404_description_break));
+ $("#examples-Classifiers-updateClassifier-description-404").html(responseClassifiers404_description.substring(responseClassifiers404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifier-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-404-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
<h3 id="examples-Classifiers-updateClassifier-title-409"></h3>
<p id="examples-Classifiers-updateClassifier-description-409" class="marked"></p>
<script>
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "409",
- "title" : "Conflicting request",
- "details" : "The request cannot be processed as the resource is in use."
}
}
}
<input id='responses-Classifiers-updateClassifier-409-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Classifiers-updateClassifier-title-500"></h3>
- <p id="examples-Classifiers-updateClassifier-description-500" class="marked"></p>
+ <h3 id="examples-Classifiers-updateClassifier-title-411"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-411" class="marked"></p>
<script>
- var responseClassifiers500_description = `Internal Server Error`;
- var responseClassifiers500_description_break = responseClassifiers500_description.indexOf('\n');
- if (responseClassifiers500_description_break == -1) {
- $("#examples-Classifiers-updateClassifier-title-500").text("Status: 500 - " + responseClassifiers500_description);
+ var responseClassifiers411_description = `Length Required`;
+ var responseClassifiers411_description_break = responseClassifiers411_description.indexOf('\n');
+ if (responseClassifiers411_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-411").text("Status: 411 - " + responseClassifiers411_description);
} else {
- $("#examples-Classifiers-updateClassifier-title-500").text("Status: 500 - " + responseClassifiers500_description.substring(0, responseClassifiers500_description_break));
- $("#examples-Classifiers-updateClassifier-description-500").html(responseClassifiers500_description.substring(responseClassifiers500_description_break));
+ $("#examples-Classifiers-updateClassifier-title-411").text("Status: 411 - " + responseClassifiers411_description.substring(0, responseClassifiers411_description_break));
+ $("#examples-Classifiers-updateClassifier-description-411").html(responseClassifiers411_description.substring(responseClassifiers411_description_break));
}
</script>
- <ul id="responses-detail-Classifiers-updateClassifier-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Classifiers-updateClassifier-411" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-411-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Classifiers-updateClassifier-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Classifiers-updateClassifier-500-schema">
- <div id="responses-Classifiers-updateClassifier-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-411-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-411-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-411" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Length Required",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Classifiers-updateClassifier-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Classifiers-updateClassifier-schema-500');
+ $('#responses-Classifiers-updateClassifier-411-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-411');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Classifiers-updateClassifier-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Classifiers-updateClassifier-411-schema-data' type='hidden' value=''></input>
</div>
</div>
- </article>
- </div>
- <hr>
- </section>
- <section id="api-Decorators">
- <h1>Decorators</h1>
- <div id="api-Decorators-updateDecorator">
- <article id="api-Decorators-updateDecorator-0" data-group="User" data-name="updateDecorator" data-version="0">
- <div class="pull-left">
- <h1>updateDecorator</h1>
- <p>Update entities and/or relationships with decorator(s).</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Update entities and/or relationships with decorator(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/decorators</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-Decorators-updateDecorator-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-java">Java</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Decorators-updateDecorator-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Decorators-updateDecorator-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-php">PHP</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-python">Python</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-Decorators-updateDecorator-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/problem+json" \
- -H "Content-Type: application/json" \
- "https://localhost/topology-inventory/v1alpha11/decorators" \
- -d '{
- "decorators" : {
- "key" : ""
- },
- "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
- "operation" : "merge",
- "entityIds" : [ "entityIds", "entityIds" ]
-}'
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-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.DecoratorsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class DecoratorsApiExample {
- public static void main(String[] args) {
+ <h3 id="examples-Classifiers-updateClassifier-title-413"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-413" class="marked"></p>
+ <script>
+ var responseClassifiers413_description = `Payload Too Large`;
+ var responseClassifiers413_description_break = responseClassifiers413_description.indexOf('\n');
+ if (responseClassifiers413_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-413").text("Status: 413 - " + responseClassifiers413_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-413").text("Status: 413 - " + responseClassifiers413_description.substring(0, responseClassifiers413_description_break));
+ $("#examples-Classifiers-updateClassifier-description-413").html(responseClassifiers413_description.substring(responseClassifiers413_description_break));
+ }
+ </script>
- // Create an instance of the API class
- DecoratorsApi apiInstance = new DecoratorsApi();
- String accept = application/json; // String |
- String contentType = application/json; // String |
- Decorator decorator = ; // Decorator |
- try {
- apiInstance.updateDecorator(accept, contentType, decorator);
- } catch (ApiException e) {
- System.err.println("Exception when calling DecoratorsApi#updateDecorator");
- e.printStackTrace();
- }
- }
-}
-</code></pre>
- </div>
+ <ul id="responses-detail-Classifiers-updateClassifier-413" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-413-schema">Schema</a>
+ </li>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-dart">
- <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
-final api_instance = DefaultApi();
-final String accept = new String(); // String |
-final String contentType = new String(); // String |
-final Decorator decorator = new Decorator(); // Decorator |
-try {
- final result = await api_instance.updateDecorator(accept, contentType, decorator);
- print(result);
-} catch (e) {
- print('Exception when calling DefaultApi->updateDecorator: $e\n');
-}
+ </ul>
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-android">
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-413-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-413-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-413" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Payload Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-413-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-413');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-413-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifier-title-415"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-415" class="marked"></p>
+ <script>
+ var responseClassifiers415_description = `Unsupported Media Type`;
+ var responseClassifiers415_description_break = responseClassifiers415_description.indexOf('\n');
+ if (responseClassifiers415_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-415").text("Status: 415 - " + responseClassifiers415_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-415").text("Status: 415 - " + responseClassifiers415_description.substring(0, responseClassifiers415_description_break));
+ $("#examples-Classifiers-updateClassifier-description-415").html(responseClassifiers415_description.substring(responseClassifiers415_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifier-415" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-415-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-415-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-415-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-415" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unsupported Media Type",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-415-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-415');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-415-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifier-title-429"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-429" class="marked"></p>
+ <script>
+ var responseClassifiers429_description = `Too Many Requests`;
+ var responseClassifiers429_description_break = responseClassifiers429_description.indexOf('\n');
+ if (responseClassifiers429_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-429").text("Status: 429 - " + responseClassifiers429_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-429").text("Status: 429 - " + responseClassifiers429_description.substring(0, responseClassifiers429_description_break));
+ $("#examples-Classifiers-updateClassifier-description-429").html(responseClassifiers429_description.substring(responseClassifiers429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifier-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-429-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifier-title-500"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-500" class="marked"></p>
+ <script>
+ var responseClassifiers500_description = `Internal Server Error`;
+ var responseClassifiers500_description_break = responseClassifiers500_description.indexOf('\n');
+ if (responseClassifiers500_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-500").text("Status: 500 - " + responseClassifiers500_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-500").text("Status: 500 - " + responseClassifiers500_description.substring(0, responseClassifiers500_description_break));
+ $("#examples-Classifiers-updateClassifier-description-500").html(responseClassifiers500_description.substring(responseClassifiers500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifier-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-500-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifier-title-502"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-502" class="marked"></p>
+ <script>
+ var responseClassifiers502_description = `Bad Gateway`;
+ var responseClassifiers502_description_break = responseClassifiers502_description.indexOf('\n');
+ if (responseClassifiers502_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-502").text("Status: 502 - " + responseClassifiers502_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-502").text("Status: 502 - " + responseClassifiers502_description.substring(0, responseClassifiers502_description_break));
+ $("#examples-Classifiers-updateClassifier-description-502").html(responseClassifiers502_description.substring(responseClassifiers502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifier-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-502-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifier-title-503"></h3>
+ <p id="examples-Classifiers-updateClassifier-description-503" class="marked"></p>
+ <script>
+ var responseClassifiers503_description = `Service Unavailable`;
+ var responseClassifiers503_description_break = responseClassifiers503_description.indexOf('\n');
+ if (responseClassifiers503_description_break == -1) {
+ $("#examples-Classifiers-updateClassifier-title-503").text("Status: 503 - " + responseClassifiers503_description);
+ } else {
+ $("#examples-Classifiers-updateClassifier-title-503").text("Status: 503 - " + responseClassifiers503_description.substring(0, responseClassifiers503_description_break));
+ $("#examples-Classifiers-updateClassifier-description-503").html(responseClassifiers503_description.substring(responseClassifiers503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifier-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifier-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifier-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifier-503-schema">
+ <div id="responses-Classifiers-updateClassifier-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifier-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifier-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifier-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-Classifiers-updateClassifierDeprecated">
+ <article id="api-Classifiers-updateClassifierDeprecated-0" data-group="User" data-name="updateClassifierDeprecated" data-version="0">
+ <div class="pull-left">
+ <h1>updateClassifierDeprecated</h1>
+ <p>Update entities and/or relationships with classifier(s).</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Update entities and/or relationships with classifier(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/classifiers</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-Classifiers-updateClassifierDeprecated-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-java">Java</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-python">Python</a></li>
+ <li class=""><a href="#examples-Classifiers-updateClassifierDeprecated-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-Classifiers-updateClassifierDeprecated-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://localhost/topology-inventory/v1/classifiers" \
+ -d '{
+ "classifiers" : [ "classifiers", "classifiers" ],
+ "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
+ "operation" : "merge",
+ "entityIds" : [ "entityIds", "entityIds" ]
+}'
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-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.ClassifiersApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ClassifiersApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ ClassifiersApi apiInstance = new ClassifiersApi();
+ String accept = application/json; // String |
+ String contentType = application/json; // String |
+ Classifier classifier = ; // Classifier |
+
+ try {
+ apiInstance.updateClassifierDeprecated(accept, contentType, classifier);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ClassifiersApi#updateClassifierDeprecated");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String contentType = new String(); // String |
+final Classifier classifier = new Classifier(); // Classifier |
+
+try {
+ final result = await api_instance.updateClassifierDeprecated(accept, contentType, classifier);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->updateClassifierDeprecated: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ClassifiersApi;
+
+public class ClassifiersApiExample {
+ public static void main(String[] args) {
+ ClassifiersApi apiInstance = new ClassifiersApi();
+ String accept = application/json; // String |
+ String contentType = application/json; // String |
+ Classifier classifier = ; // Classifier |
+
+ try {
+ apiInstance.updateClassifierDeprecated(accept, contentType, classifier);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ClassifiersApi#updateClassifierDeprecated");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+ClassifiersApi *apiInstance = [[ClassifiersApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *contentType = application/json; // (default to application/json)
+Classifier *classifier = ; //
+
+// Update entities and/or relationships with classifier(s).
+[apiInstance updateClassifierDeprecatedWith:accept
+ contentType:contentType
+ classifier:classifier
+ completionHandler: ^(NSError* error) {
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.ClassifiersApi()
+var accept = application/json; // {String}
+var contentType = application/json; // {String}
+var classifier = ; // {Classifier}
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully.');
+ }
+};
+api.updateClassifierDeprecated(accept, contentType, classifier, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class updateClassifierDeprecatedExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new ClassifiersApi();
+ var accept = application/json; // String | (default to application/json)
+ var contentType = application/json; // String | (default to application/json)
+ var classifier = new Classifier(); // Classifier |
+
+ try {
+ // Update entities and/or relationships with classifier(s).
+ apiInstance.updateClassifierDeprecated(accept, contentType, classifier);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling ClassifiersApi.updateClassifierDeprecated: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-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\ClassifiersApi();
+$accept = application/json; // String |
+$contentType = application/json; // String |
+$classifier = ; // Classifier |
+
+try {
+ $api_instance->updateClassifierDeprecated($accept, $contentType, $classifier);
+} catch (Exception $e) {
+ echo 'Exception when calling ClassifiersApi->updateClassifierDeprecated: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ClassifiersApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ClassifiersApi->new();
+my $accept = application/json; # String |
+my $contentType = application/json; # String |
+my $classifier = WWW::OPenAPIClient::Object::Classifier->new(); # Classifier |
+
+eval {
+ $api_instance->updateClassifierDeprecated(accept => $accept, contentType => $contentType, classifier => $classifier);
+};
+if ($@) {
+ warn "Exception when calling ClassifiersApi->updateClassifierDeprecated: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ClassifiersApi()
+accept = application/json # String | (default to application/json)
+contentType = application/json # String | (default to application/json)
+classifier = # Classifier |
+
+try:
+ # Update entities and/or relationships with classifier(s).
+ api_instance.update_classifier_deprecated(accept, contentType, classifier)
+except ApiException as e:
+ print("Exception when calling ClassifiersApi->updateClassifierDeprecated: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Classifiers-updateClassifierDeprecated-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate ClassifiersApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let contentType = application/json; // String
+ let classifier = ; // Classifier
+
+ let mut context = ClassifiersApi::Context::default();
+ let result = client.updateClassifierDeprecated(accept, contentType, classifier, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_updateClassifierDeprecated_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">Content-Type*</td>
+<td>
+
+
+ <div id="d2e199_updateClassifierDeprecated_contentType">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">classifier <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Classifier"
+ },
+ "examples" : {
+ "updateClassifier" : {
+ "$ref" : "#/components/examples/ClassifierMergeExample"
+ },
+ "removeClassifier" : {
+ "$ref" : "#/components/examples/ClassifierDeleteExample"
+ }
+ }
+ }
+ },
+ "required" : true
+};
+
+ 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,2,{isBodyParam: true});
+ var result = $('#d2e199_updateClassifierDeprecated_classifier');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_updateClassifierDeprecated_classifier"></div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-Classifiers-updateClassifierDeprecated-title-204"></h3>
+ <p id="examples-Classifiers-updateClassifierDeprecated-description-204" class="marked"></p>
+ <script>
+ var responseClassifiers204_description = `No Content`;
+ var responseClassifiers204_description_break = responseClassifiers204_description.indexOf('\n');
+ if (responseClassifiers204_description_break == -1) {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-204").text("Status: 204 - " + responseClassifiers204_description);
+ } else {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-204").text("Status: 204 - " + responseClassifiers204_description.substring(0, responseClassifiers204_description_break));
+ $("#examples-Classifiers-updateClassifierDeprecated-description-204").html(responseClassifiers204_description.substring(responseClassifiers204_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifierDeprecated-204" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifierDeprecated-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifierDeprecated-204-schema">
+ <div id="responses-Classifiers-updateClassifierDeprecated-schema-204" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "No Content",
+ "content" : { }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifierDeprecated-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifierDeprecated-schema-204');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifierDeprecated-204-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifierDeprecated-title-400"></h3>
+ <p id="examples-Classifiers-updateClassifierDeprecated-description-400" class="marked"></p>
+ <script>
+ var responseClassifiers400_description = `Bad Request`;
+ var responseClassifiers400_description_break = responseClassifiers400_description.indexOf('\n');
+ if (responseClassifiers400_description_break == -1) {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-400").text("Status: 400 - " + responseClassifiers400_description);
+ } else {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-400").text("Status: 400 - " + responseClassifiers400_description.substring(0, responseClassifiers400_description_break));
+ $("#examples-Classifiers-updateClassifierDeprecated-description-400").html(responseClassifiers400_description.substring(responseClassifiers400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifierDeprecated-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifierDeprecated-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifierDeprecated-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifierDeprecated-400-schema">
+ <div id="responses-Classifiers-updateClassifierDeprecated-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifierDeprecated-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifierDeprecated-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifierDeprecated-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifierDeprecated-title-401"></h3>
+ <p id="examples-Classifiers-updateClassifierDeprecated-description-401" class="marked"></p>
+ <script>
+ var responseClassifiers401_description = `Unauthorized`;
+ var responseClassifiers401_description_break = responseClassifiers401_description.indexOf('\n');
+ if (responseClassifiers401_description_break == -1) {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-401").text("Status: 401 - " + responseClassifiers401_description);
+ } else {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-401").text("Status: 401 - " + responseClassifiers401_description.substring(0, responseClassifiers401_description_break));
+ $("#examples-Classifiers-updateClassifierDeprecated-description-401").html(responseClassifiers401_description.substring(responseClassifiers401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifierDeprecated-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifierDeprecated-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifierDeprecated-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifierDeprecated-401-schema">
+ <div id="responses-Classifiers-updateClassifierDeprecated-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifierDeprecated-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifierDeprecated-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifierDeprecated-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifierDeprecated-title-403"></h3>
+ <p id="examples-Classifiers-updateClassifierDeprecated-description-403" class="marked"></p>
+ <script>
+ var responseClassifiers403_description = `Forbidden`;
+ var responseClassifiers403_description_break = responseClassifiers403_description.indexOf('\n');
+ if (responseClassifiers403_description_break == -1) {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-403").text("Status: 403 - " + responseClassifiers403_description);
+ } else {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-403").text("Status: 403 - " + responseClassifiers403_description.substring(0, responseClassifiers403_description_break));
+ $("#examples-Classifiers-updateClassifierDeprecated-description-403").html(responseClassifiers403_description.substring(responseClassifiers403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifierDeprecated-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifierDeprecated-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifierDeprecated-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifierDeprecated-403-schema">
+ <div id="responses-Classifiers-updateClassifierDeprecated-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifierDeprecated-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifierDeprecated-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifierDeprecated-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifierDeprecated-title-409"></h3>
+ <p id="examples-Classifiers-updateClassifierDeprecated-description-409" class="marked"></p>
+ <script>
+ var responseClassifiers409_description = `Conflict`;
+ var responseClassifiers409_description_break = responseClassifiers409_description.indexOf('\n');
+ if (responseClassifiers409_description_break == -1) {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-409").text("Status: 409 - " + responseClassifiers409_description);
+ } else {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-409").text("Status: 409 - " + responseClassifiers409_description.substring(0, responseClassifiers409_description_break));
+ $("#examples-Classifiers-updateClassifierDeprecated-description-409").html(responseClassifiers409_description.substring(responseClassifiers409_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifierDeprecated-409" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifierDeprecated-409-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifierDeprecated-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifierDeprecated-409-schema">
+ <div id="responses-Classifiers-updateClassifierDeprecated-schema-409" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Conflict",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "409",
+ "title" : "Conflicting request",
+ "details" : "The request cannot be processed as the resource is in use."
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifierDeprecated-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifierDeprecated-schema-409');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifierDeprecated-409-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Classifiers-updateClassifierDeprecated-title-500"></h3>
+ <p id="examples-Classifiers-updateClassifierDeprecated-description-500" class="marked"></p>
+ <script>
+ var responseClassifiers500_description = `Internal Server Error`;
+ var responseClassifiers500_description_break = responseClassifiers500_description.indexOf('\n');
+ if (responseClassifiers500_description_break == -1) {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-500").text("Status: 500 - " + responseClassifiers500_description);
+ } else {
+ $("#examples-Classifiers-updateClassifierDeprecated-title-500").text("Status: 500 - " + responseClassifiers500_description.substring(0, responseClassifiers500_description_break));
+ $("#examples-Classifiers-updateClassifierDeprecated-description-500").html(responseClassifiers500_description.substring(responseClassifiers500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Classifiers-updateClassifierDeprecated-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Classifiers-updateClassifierDeprecated-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Classifiers-updateClassifierDeprecated-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Classifiers-updateClassifierDeprecated-500-schema">
+ <div id="responses-Classifiers-updateClassifierDeprecated-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "500",
+ "title" : "Internal Server Error",
+ "details" : "Internal Server Error occurred"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Classifiers-updateClassifierDeprecated-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Classifiers-updateClassifierDeprecated-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Classifiers-updateClassifierDeprecated-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ </section>
+ <section id="api-Decorators">
+ <h1>Decorators</h1>
+ <div id="api-Decorators-updateDecorator">
+ <article id="api-Decorators-updateDecorator-0" data-group="User" data-name="updateDecorator" data-version="0">
+ <div class="pull-left">
+ <h1>updateDecorator</h1>
+ <p>Update entities and/or relationships with decorator(s).</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Update entities and/or relationships with decorator(s).</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/manage-decorators</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-Decorators-updateDecorator-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-java">Java</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-python">Python</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-Decorators-updateDecorator-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://localhost/topology-inventory/v1/manage-decorators" \
+ -d '{
+ "decorators" : {
+ "key" : ""
+ },
+ "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
+ "operation" : "merge",
+ "entityIds" : [ "entityIds", "entityIds" ]
+}'
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-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.DecoratorsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DecoratorsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ DecoratorsApi apiInstance = new DecoratorsApi();
+ String accept = application/json; // String |
+ String contentType = application/json; // String |
+ Decorator decorator = ; // Decorator |
+
+ try {
+ apiInstance.updateDecorator(accept, contentType, decorator);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DecoratorsApi#updateDecorator");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String contentType = new String(); // String |
+final Decorator decorator = new Decorator(); // Decorator |
+
+try {
+ final result = await api_instance.updateDecorator(accept, contentType, decorator);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->updateDecorator: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.DecoratorsApi;
+
+public class DecoratorsApiExample {
+ public static void main(String[] args) {
+ DecoratorsApi apiInstance = new DecoratorsApi();
+ String accept = application/json; // String |
+ String contentType = application/json; // String |
+ Decorator decorator = ; // Decorator |
+
+ try {
+ apiInstance.updateDecorator(accept, contentType, decorator);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DecoratorsApi#updateDecorator");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *contentType = application/json; // (default to application/json)
+Decorator *decorator = ; //
+
+// Update entities and/or relationships with decorator(s).
+[apiInstance updateDecoratorWith:accept
+ contentType:contentType
+ decorator:decorator
+ completionHandler: ^(NSError* error) {
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.DecoratorsApi()
+var accept = application/json; // {String}
+var contentType = application/json; // {String}
+var decorator = ; // {Decorator}
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully.');
+ }
+};
+api.updateDecorator(accept, contentType, decorator, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-Decorators-updateDecorator-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class updateDecoratorExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new DecoratorsApi();
+ var accept = application/json; // String | (default to application/json)
+ var contentType = application/json; // String | (default to application/json)
+ var decorator = new Decorator(); // Decorator |
+
+ try {
+ // Update entities and/or relationships with decorator(s).
+ apiInstance.updateDecorator(accept, contentType, decorator);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling DecoratorsApi.updateDecorator: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-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\DecoratorsApi();
+$accept = application/json; // String |
+$contentType = application/json; // String |
+$decorator = ; // Decorator |
+
+try {
+ $api_instance->updateDecorator($accept, $contentType, $decorator);
+} catch (Exception $e) {
+ echo 'Exception when calling DecoratorsApi->updateDecorator: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DecoratorsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
+my $accept = application/json; # String |
+my $contentType = application/json; # String |
+my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator |
+
+eval {
+ $api_instance->updateDecorator(accept => $accept, contentType => $contentType, decorator => $decorator);
+};
+if ($@) {
+ warn "Exception when calling DecoratorsApi->updateDecorator: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DecoratorsApi()
+accept = application/json # String | (default to application/json)
+contentType = application/json # String | (default to application/json)
+decorator = # Decorator |
+
+try:
+ # Update entities and/or relationships with decorator(s).
+ api_instance.update_decorator(accept, contentType, decorator)
+except ApiException as e:
+ print("Exception when calling DecoratorsApi->updateDecorator: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate DecoratorsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let contentType = application/json; // String
+ let decorator = ; // Decorator
+
+ let mut context = DecoratorsApi::Context::default();
+ let result = client.updateDecorator(accept, contentType, decorator, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_updateDecorator_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">Content-Type*</td>
+<td>
+
+
+ <div id="d2e199_updateDecorator_contentType">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">decorator <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Decorator"
+ },
+ "examples" : {
+ "mergeDecorator" : {
+ "$ref" : "#/components/examples/DecoratorMergeExample"
+ },
+ "removeDecorator" : {
+ "$ref" : "#/components/examples/DecoratorDeleteExample"
+ }
+ }
+ }
+ },
+ "required" : true
+};
+
+ 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,2,{isBodyParam: true});
+ var result = $('#d2e199_updateDecorator_decorator');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_updateDecorator_decorator"></div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-Decorators-updateDecorator-title-204"></h3>
+ <p id="examples-Decorators-updateDecorator-description-204" class="marked"></p>
+ <script>
+ var responseDecorators204_description = `No Content`;
+ var responseDecorators204_description_break = responseDecorators204_description.indexOf('\n');
+ if (responseDecorators204_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description.substring(0, responseDecorators204_description_break));
+ $("#examples-Decorators-updateDecorator-description-204").html(responseDecorators204_description.substring(responseDecorators204_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-204" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-204-schema">
+ <div id="responses-Decorators-updateDecorator-schema-204" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "No Content",
+ "content" : { }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-204');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-204-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-400"></h3>
+ <p id="examples-Decorators-updateDecorator-description-400" class="marked"></p>
+ <script>
+ var responseDecorators400_description = `Bad Request`;
+ var responseDecorators400_description_break = responseDecorators400_description.indexOf('\n');
+ if (responseDecorators400_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description.substring(0, responseDecorators400_description_break));
+ $("#examples-Decorators-updateDecorator-description-400").html(responseDecorators400_description.substring(responseDecorators400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-400-schema">
+ <div id="responses-Decorators-updateDecorator-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-401"></h3>
+ <p id="examples-Decorators-updateDecorator-description-401" class="marked"></p>
+ <script>
+ var responseDecorators401_description = `Unauthorized`;
+ var responseDecorators401_description_break = responseDecorators401_description.indexOf('\n');
+ if (responseDecorators401_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description.substring(0, responseDecorators401_description_break));
+ $("#examples-Decorators-updateDecorator-description-401").html(responseDecorators401_description.substring(responseDecorators401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-401-schema">
+ <div id="responses-Decorators-updateDecorator-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-403"></h3>
+ <p id="examples-Decorators-updateDecorator-description-403" class="marked"></p>
+ <script>
+ var responseDecorators403_description = `Forbidden`;
+ var responseDecorators403_description_break = responseDecorators403_description.indexOf('\n');
+ if (responseDecorators403_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description.substring(0, responseDecorators403_description_break));
+ $("#examples-Decorators-updateDecorator-description-403").html(responseDecorators403_description.substring(responseDecorators403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-403-schema">
+ <div id="responses-Decorators-updateDecorator-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-404"></h3>
+ <p id="examples-Decorators-updateDecorator-description-404" class="marked"></p>
+ <script>
+ var responseDecorators404_description = `Not Found`;
+ var responseDecorators404_description_break = responseDecorators404_description.indexOf('\n');
+ if (responseDecorators404_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-404").text("Status: 404 - " + responseDecorators404_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-404").text("Status: 404 - " + responseDecorators404_description.substring(0, responseDecorators404_description_break));
+ $("#examples-Decorators-updateDecorator-description-404").html(responseDecorators404_description.substring(responseDecorators404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-404-schema">
+ <div id="responses-Decorators-updateDecorator-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-409"></h3>
+ <p id="examples-Decorators-updateDecorator-description-409" class="marked"></p>
+ <script>
+ var responseDecorators409_description = `Conflict`;
+ var responseDecorators409_description_break = responseDecorators409_description.indexOf('\n');
+ if (responseDecorators409_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description.substring(0, responseDecorators409_description_break));
+ $("#examples-Decorators-updateDecorator-description-409").html(responseDecorators409_description.substring(responseDecorators409_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-409" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-409-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-409-schema">
+ <div id="responses-Decorators-updateDecorator-schema-409" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Conflict",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-409');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-409-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-411"></h3>
+ <p id="examples-Decorators-updateDecorator-description-411" class="marked"></p>
+ <script>
+ var responseDecorators411_description = `Length Required`;
+ var responseDecorators411_description_break = responseDecorators411_description.indexOf('\n');
+ if (responseDecorators411_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-411").text("Status: 411 - " + responseDecorators411_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-411").text("Status: 411 - " + responseDecorators411_description.substring(0, responseDecorators411_description_break));
+ $("#examples-Decorators-updateDecorator-description-411").html(responseDecorators411_description.substring(responseDecorators411_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-411" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-411-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-411-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-411-schema">
+ <div id="responses-Decorators-updateDecorator-schema-411" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Length Required",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-411-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-411');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-411-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-413"></h3>
+ <p id="examples-Decorators-updateDecorator-description-413" class="marked"></p>
+ <script>
+ var responseDecorators413_description = `Payload Too Large`;
+ var responseDecorators413_description_break = responseDecorators413_description.indexOf('\n');
+ if (responseDecorators413_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-413").text("Status: 413 - " + responseDecorators413_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-413").text("Status: 413 - " + responseDecorators413_description.substring(0, responseDecorators413_description_break));
+ $("#examples-Decorators-updateDecorator-description-413").html(responseDecorators413_description.substring(responseDecorators413_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-413" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-413-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-413-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-413-schema">
+ <div id="responses-Decorators-updateDecorator-schema-413" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Payload Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-413-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-413');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-413-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-415"></h3>
+ <p id="examples-Decorators-updateDecorator-description-415" class="marked"></p>
+ <script>
+ var responseDecorators415_description = `Unsupported Media Type`;
+ var responseDecorators415_description_break = responseDecorators415_description.indexOf('\n');
+ if (responseDecorators415_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-415").text("Status: 415 - " + responseDecorators415_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-415").text("Status: 415 - " + responseDecorators415_description.substring(0, responseDecorators415_description_break));
+ $("#examples-Decorators-updateDecorator-description-415").html(responseDecorators415_description.substring(responseDecorators415_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-415" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-415-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-415-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-415-schema">
+ <div id="responses-Decorators-updateDecorator-schema-415" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unsupported Media Type",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-415-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-415');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-415-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-429"></h3>
+ <p id="examples-Decorators-updateDecorator-description-429" class="marked"></p>
+ <script>
+ var responseDecorators429_description = `Too Many Requests`;
+ var responseDecorators429_description_break = responseDecorators429_description.indexOf('\n');
+ if (responseDecorators429_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-429").text("Status: 429 - " + responseDecorators429_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-429").text("Status: 429 - " + responseDecorators429_description.substring(0, responseDecorators429_description_break));
+ $("#examples-Decorators-updateDecorator-description-429").html(responseDecorators429_description.substring(responseDecorators429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-429-schema">
+ <div id="responses-Decorators-updateDecorator-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-500"></h3>
+ <p id="examples-Decorators-updateDecorator-description-500" class="marked"></p>
+ <script>
+ var responseDecorators500_description = `Internal Server Error`;
+ var responseDecorators500_description_break = responseDecorators500_description.indexOf('\n');
+ if (responseDecorators500_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description.substring(0, responseDecorators500_description_break));
+ $("#examples-Decorators-updateDecorator-description-500").html(responseDecorators500_description.substring(responseDecorators500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-500-schema">
+ <div id="responses-Decorators-updateDecorator-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-502"></h3>
+ <p id="examples-Decorators-updateDecorator-description-502" class="marked"></p>
+ <script>
+ var responseDecorators502_description = `Bad Gateway`;
+ var responseDecorators502_description_break = responseDecorators502_description.indexOf('\n');
+ if (responseDecorators502_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-502").text("Status: 502 - " + responseDecorators502_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-502").text("Status: 502 - " + responseDecorators502_description.substring(0, responseDecorators502_description_break));
+ $("#examples-Decorators-updateDecorator-description-502").html(responseDecorators502_description.substring(responseDecorators502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-502-schema">
+ <div id="responses-Decorators-updateDecorator-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecorator-title-503"></h3>
+ <p id="examples-Decorators-updateDecorator-description-503" class="marked"></p>
+ <script>
+ var responseDecorators503_description = `Service Unavailable`;
+ var responseDecorators503_description_break = responseDecorators503_description.indexOf('\n');
+ if (responseDecorators503_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-503").text("Status: 503 - " + responseDecorators503_description);
+ } else {
+ $("#examples-Decorators-updateDecorator-title-503").text("Status: 503 - " + responseDecorators503_description.substring(0, responseDecorators503_description_break));
+ $("#examples-Decorators-updateDecorator-description-503").html(responseDecorators503_description.substring(responseDecorators503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecorator-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecorator-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-503-schema">
+ <div id="responses-Decorators-updateDecorator-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecorator-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecorator-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-Decorators-updateDecoratorDeprecated">
+ <article id="api-Decorators-updateDecoratorDeprecated-0" data-group="User" data-name="updateDecoratorDeprecated" data-version="0">
+ <div class="pull-left">
+ <h1>updateDecoratorDeprecated</h1>
+ <p>Update entities and/or relationships with decorator(s).</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Update entities and/or relationships with decorator(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/decorators</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-Decorators-updateDecoratorDeprecated-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-java">Java</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-python">Python</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecoratorDeprecated-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-Decorators-updateDecoratorDeprecated-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://localhost/topology-inventory/v1/decorators" \
+ -d '{
+ "decorators" : {
+ "key" : ""
+ },
+ "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
+ "operation" : "merge",
+ "entityIds" : [ "entityIds", "entityIds" ]
+}'
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-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.DecoratorsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DecoratorsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ DecoratorsApi apiInstance = new DecoratorsApi();
+ String accept = application/json; // String |
+ String contentType = application/json; // String |
+ Decorator decorator = ; // Decorator |
+
+ try {
+ apiInstance.updateDecoratorDeprecated(accept, contentType, decorator);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DecoratorsApi#updateDecoratorDeprecated");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String contentType = new String(); // String |
+final Decorator decorator = new Decorator(); // Decorator |
+
+try {
+ final result = await api_instance.updateDecoratorDeprecated(accept, contentType, decorator);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->updateDecoratorDeprecated: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.DecoratorsApi;
-public class DecoratorsApiExample {
+public class DecoratorsApiExample {
+ public static void main(String[] args) {
+ DecoratorsApi apiInstance = new DecoratorsApi();
+ String accept = application/json; // String |
+ String contentType = application/json; // String |
+ Decorator decorator = ; // Decorator |
+
+ try {
+ apiInstance.updateDecoratorDeprecated(accept, contentType, decorator);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DecoratorsApi#updateDecoratorDeprecated");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *contentType = application/json; // (default to application/json)
+Decorator *decorator = ; //
+
+// Update entities and/or relationships with decorator(s).
+[apiInstance updateDecoratorDeprecatedWith:accept
+ contentType:contentType
+ decorator:decorator
+ completionHandler: ^(NSError* error) {
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.DecoratorsApi()
+var accept = application/json; // {String}
+var contentType = application/json; // {String}
+var decorator = ; // {Decorator}
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully.');
+ }
+};
+api.updateDecoratorDeprecated(accept, contentType, decorator, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class updateDecoratorDeprecatedExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new DecoratorsApi();
+ var accept = application/json; // String | (default to application/json)
+ var contentType = application/json; // String | (default to application/json)
+ var decorator = new Decorator(); // Decorator |
+
+ try {
+ // Update entities and/or relationships with decorator(s).
+ apiInstance.updateDecoratorDeprecated(accept, contentType, decorator);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling DecoratorsApi.updateDecoratorDeprecated: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-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\DecoratorsApi();
+$accept = application/json; // String |
+$contentType = application/json; // String |
+$decorator = ; // Decorator |
+
+try {
+ $api_instance->updateDecoratorDeprecated($accept, $contentType, $decorator);
+} catch (Exception $e) {
+ echo 'Exception when calling DecoratorsApi->updateDecoratorDeprecated: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DecoratorsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
+my $accept = application/json; # String |
+my $contentType = application/json; # String |
+my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator |
+
+eval {
+ $api_instance->updateDecoratorDeprecated(accept => $accept, contentType => $contentType, decorator => $decorator);
+};
+if ($@) {
+ warn "Exception when calling DecoratorsApi->updateDecoratorDeprecated: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DecoratorsApi()
+accept = application/json # String | (default to application/json)
+contentType = application/json # String | (default to application/json)
+decorator = # Decorator |
+
+try:
+ # Update entities and/or relationships with decorator(s).
+ api_instance.update_decorator_deprecated(accept, contentType, decorator)
+except ApiException as e:
+ print("Exception when calling DecoratorsApi->updateDecoratorDeprecated: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-Decorators-updateDecoratorDeprecated-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate DecoratorsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let contentType = application/json; // String
+ let decorator = ; // Decorator
+
+ let mut context = DecoratorsApi::Context::default();
+ let result = client.updateDecoratorDeprecated(accept, contentType, decorator, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_updateDecoratorDeprecated_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">Content-Type*</td>
+<td>
+
+
+ <div id="d2e199_updateDecoratorDeprecated_contentType">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">decorator <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Decorator"
+ },
+ "examples" : {
+ "mergeDecorator" : {
+ "$ref" : "#/components/examples/DecoratorMergeExample"
+ },
+ "removeDecorator" : {
+ "$ref" : "#/components/examples/DecoratorDeleteExample"
+ }
+ }
+ }
+ },
+ "required" : true
+};
+
+ 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,2,{isBodyParam: true});
+ var result = $('#d2e199_updateDecoratorDeprecated_decorator');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_updateDecoratorDeprecated_decorator"></div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-Decorators-updateDecoratorDeprecated-title-204"></h3>
+ <p id="examples-Decorators-updateDecoratorDeprecated-description-204" class="marked"></p>
+ <script>
+ var responseDecorators204_description = `No Content`;
+ var responseDecorators204_description_break = responseDecorators204_description.indexOf('\n');
+ if (responseDecorators204_description_break == -1) {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-204").text("Status: 204 - " + responseDecorators204_description);
+ } else {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-204").text("Status: 204 - " + responseDecorators204_description.substring(0, responseDecorators204_description_break));
+ $("#examples-Decorators-updateDecoratorDeprecated-description-204").html(responseDecorators204_description.substring(responseDecorators204_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecoratorDeprecated-204" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecoratorDeprecated-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecoratorDeprecated-204-schema">
+ <div id="responses-Decorators-updateDecoratorDeprecated-schema-204" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "No Content",
+ "content" : { }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecoratorDeprecated-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecoratorDeprecated-schema-204');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecoratorDeprecated-204-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecoratorDeprecated-title-400"></h3>
+ <p id="examples-Decorators-updateDecoratorDeprecated-description-400" class="marked"></p>
+ <script>
+ var responseDecorators400_description = `Bad Request`;
+ var responseDecorators400_description_break = responseDecorators400_description.indexOf('\n');
+ if (responseDecorators400_description_break == -1) {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-400").text("Status: 400 - " + responseDecorators400_description);
+ } else {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-400").text("Status: 400 - " + responseDecorators400_description.substring(0, responseDecorators400_description_break));
+ $("#examples-Decorators-updateDecoratorDeprecated-description-400").html(responseDecorators400_description.substring(responseDecorators400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecoratorDeprecated-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecoratorDeprecated-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecoratorDeprecated-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecoratorDeprecated-400-schema">
+ <div id="responses-Decorators-updateDecoratorDeprecated-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecoratorDeprecated-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecoratorDeprecated-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecoratorDeprecated-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecoratorDeprecated-title-401"></h3>
+ <p id="examples-Decorators-updateDecoratorDeprecated-description-401" class="marked"></p>
+ <script>
+ var responseDecorators401_description = `Unauthorized`;
+ var responseDecorators401_description_break = responseDecorators401_description.indexOf('\n');
+ if (responseDecorators401_description_break == -1) {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-401").text("Status: 401 - " + responseDecorators401_description);
+ } else {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-401").text("Status: 401 - " + responseDecorators401_description.substring(0, responseDecorators401_description_break));
+ $("#examples-Decorators-updateDecoratorDeprecated-description-401").html(responseDecorators401_description.substring(responseDecorators401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecoratorDeprecated-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecoratorDeprecated-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecoratorDeprecated-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecoratorDeprecated-401-schema">
+ <div id="responses-Decorators-updateDecoratorDeprecated-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecoratorDeprecated-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecoratorDeprecated-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecoratorDeprecated-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecoratorDeprecated-title-403"></h3>
+ <p id="examples-Decorators-updateDecoratorDeprecated-description-403" class="marked"></p>
+ <script>
+ var responseDecorators403_description = `Forbidden`;
+ var responseDecorators403_description_break = responseDecorators403_description.indexOf('\n');
+ if (responseDecorators403_description_break == -1) {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-403").text("Status: 403 - " + responseDecorators403_description);
+ } else {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-403").text("Status: 403 - " + responseDecorators403_description.substring(0, responseDecorators403_description_break));
+ $("#examples-Decorators-updateDecoratorDeprecated-description-403").html(responseDecorators403_description.substring(responseDecorators403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecoratorDeprecated-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecoratorDeprecated-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecoratorDeprecated-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecoratorDeprecated-403-schema">
+ <div id="responses-Decorators-updateDecoratorDeprecated-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecoratorDeprecated-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecoratorDeprecated-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecoratorDeprecated-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecoratorDeprecated-title-409"></h3>
+ <p id="examples-Decorators-updateDecoratorDeprecated-description-409" class="marked"></p>
+ <script>
+ var responseDecorators409_description = `Conflict`;
+ var responseDecorators409_description_break = responseDecorators409_description.indexOf('\n');
+ if (responseDecorators409_description_break == -1) {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-409").text("Status: 409 - " + responseDecorators409_description);
+ } else {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-409").text("Status: 409 - " + responseDecorators409_description.substring(0, responseDecorators409_description_break));
+ $("#examples-Decorators-updateDecoratorDeprecated-description-409").html(responseDecorators409_description.substring(responseDecorators409_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecoratorDeprecated-409" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecoratorDeprecated-409-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecoratorDeprecated-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecoratorDeprecated-409-schema">
+ <div id="responses-Decorators-updateDecoratorDeprecated-schema-409" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Conflict",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "409",
+ "title" : "Conflicting request",
+ "details" : "The request cannot be processed as the resource is in use."
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecoratorDeprecated-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecoratorDeprecated-schema-409');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecoratorDeprecated-409-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Decorators-updateDecoratorDeprecated-title-500"></h3>
+ <p id="examples-Decorators-updateDecoratorDeprecated-description-500" class="marked"></p>
+ <script>
+ var responseDecorators500_description = `Internal Server Error`;
+ var responseDecorators500_description_break = responseDecorators500_description.indexOf('\n');
+ if (responseDecorators500_description_break == -1) {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-500").text("Status: 500 - " + responseDecorators500_description);
+ } else {
+ $("#examples-Decorators-updateDecoratorDeprecated-title-500").text("Status: 500 - " + responseDecorators500_description.substring(0, responseDecorators500_description_break));
+ $("#examples-Decorators-updateDecoratorDeprecated-description-500").html(responseDecorators500_description.substring(responseDecorators500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Decorators-updateDecoratorDeprecated-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Decorators-updateDecoratorDeprecated-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Decorators-updateDecoratorDeprecated-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecoratorDeprecated-500-schema">
+ <div id="responses-Decorators-updateDecoratorDeprecated-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "500",
+ "title" : "Internal Server Error",
+ "details" : "Internal Server Error occurred"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Decorators-updateDecoratorDeprecated-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecoratorDeprecated-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Decorators-updateDecoratorDeprecated-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ </section>
+ <section id="api-EntitiesAndRelationships">
+ <h1>EntitiesAndRelationships</h1>
+ <div id="api-EntitiesAndRelationships-getAllDomains">
+ <article id="api-EntitiesAndRelationships-getAllDomains-0" data-group="User" data-name="getAllDomains" data-version="0">
+ <div class="pull-left">
+ <h1>getAllDomains</h1>
+ <p>Get all the available topology domains.</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get all the available topology domains.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains</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-EntitiesAndRelationships-getAllDomains-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllDomains-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains?offset=56&limit=56"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
+
+try {
+ final result = await api_instance.getAllDomains(accept, offset, limit);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getAllDomains: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
+
+// Get all the available topology domains.
+[apiInstance getAllDomainsWith:accept
+ offset:offset
+ limit:limit
+ completionHandler: ^(Domains output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/json; // {String}
+var opts = {
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getAllDomains(accept, opts, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getAllDomainsExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/json; // String | (default to application/json)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+
+ try {
+ // Get all the available topology domains.
+ Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllDomains: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-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\EntitiesAndRelationshipsApi();
+$accept = application/json; // String |
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
+
+try {
+ $result = $api_instance->getAllDomains($accept, $offset, $limit);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getAllDomains: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/json; # String |
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
+
+eval {
+ my $result = $api_instance->getAllDomains(accept => $accept, offset => $offset, limit => $limit);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getAllDomains: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/json # String | (default to application/json)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
+
+try:
+ # Get all the available topology domains.
+ api_response = api_instance.get_all_domains(accept, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getAllDomains: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getAllDomains(accept, offset, limit, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getAllDomains_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getAllDomains_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getAllDomains_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-200-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Domains"
+ },
+ "examples" : {
+ "domains" : {
+ "$ref" : "#/components/examples/DomainsResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-400-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-401-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-403-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-404-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-406-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-414-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-429-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-500-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-502-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-503-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllDomains-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId">
+ <article id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId-0" data-group="User" data-name="getAllRelationshipsForEntityId" data-version="0">
+ <div class="pull-left">
+ <h1>getAllRelationshipsForEntityId</h1>
+ <p>Get all relationships for a specific Topology Entity instance of a Topology Entity type</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get all relationships for a specific Topology Entity instance of a Topology Entity type</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships</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-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String entityTypeName = entityTypeName_example; // String |
+ String entityId = entityId_example; // String |
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Relationships result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String entityTypeName = new String(); // String |
+final String entityId = new String(); // String |
+final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
+
+try {
+ final result = await api_instance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getAllRelationshipsForEntityId: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String entityTypeName = entityTypeName_example; // String |
+ String entityId = entityId_example; // String |
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Relationships result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *domainName = RAN; // domain name (default to null)
+String *entityTypeName = entityTypeName_example; // (default to null)
+String *entityId = entityId_example; // (default to null)
+String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
+
+// Get all relationships for a specific Topology Entity instance of a Topology Entity type
+[apiInstance getAllRelationshipsForEntityIdWith:accept
+ domainName:domainName
+ entityTypeName:entityTypeName
+ entityId:entityId
+ targetFilter:targetFilter
+ scopeFilter:scopeFilter
+ offset:offset
+ limit:limit
+ completionHandler: ^(Relationships output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/json; // {String}
+var domainName = RAN; // {String} domain name
+var entityTypeName = entityTypeName_example; // {String}
+var entityId = entityId_example; // {String}
+var opts = {
+ 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
+ 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, opts, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getAllRelationshipsForEntityIdExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/json; // String | (default to application/json)
+ var domainName = RAN; // String | domain name (default to null)
+ var entityTypeName = entityTypeName_example; // String | (default to null)
+ var entityId = entityId_example; // String | (default to null)
+ var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+ var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+
+ try {
+ // Get all relationships for a specific Topology Entity instance of a Topology Entity type
+ Relationships result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllRelationshipsForEntityId: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-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\EntitiesAndRelationshipsApi();
+$accept = application/json; // String |
+$domainName = RAN; // String | domain name
+$entityTypeName = entityTypeName_example; // String |
+$entityId = entityId_example; // String |
+$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
+
+try {
+ $result = $api_instance->getAllRelationshipsForEntityId($accept, $domainName, $entityTypeName, $entityId, $targetFilter, $scopeFilter, $offset, $limit);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/json; # String |
+my $domainName = RAN; # String | domain name
+my $entityTypeName = entityTypeName_example; # String |
+my $entityId = entityId_example; # String |
+my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
+my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
+
+eval {
+ my $result = $api_instance->getAllRelationshipsForEntityId(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/json # String | (default to application/json)
+domainName = RAN # String | domain name (default to null)
+entityTypeName = entityTypeName_example # String | (default to null)
+entityId = entityId_example # String | (default to null)
+targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
+
+try:
+ # Get all relationships for a specific Topology Entity instance of a Topology Entity type
+ api_response = api_instance.get_all_relationships_for_entity_id(accept, domainName, entityTypeName, entityId, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let domainName = RAN; // String
+ let entityTypeName = entityTypeName_example; // String
+ let entityId = entityId_example; // String
+ let targetFilter = /sourceIds;/classifiers; // String
+ let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_entityTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityId*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_entityId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+Use *targetFilter* to specify what needs to be returned in the REST response.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+ScopeFilter is used to specify the conditions to be applied.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Relationships"
+ },
+ "examples" : {
+ "relationships" : {
+ "$ref" : "#/components/examples/RelationshipsResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-406-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-414-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-429-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-502-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-503-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getEntitiesByDomain">
+ <article id="api-EntitiesAndRelationships-getEntitiesByDomain-0" data-group="User" data-name="getEntitiesByDomain" data-version="0">
+ <div class="pull-left">
+ <h1>getEntitiesByDomain</h1>
+ <p>Get entities by domain</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get topology entities by domain, using a specified *targetFilter* as a query parameter.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entities</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-EntitiesAndRelationships-getEntitiesByDomain-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/entities?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Entities result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
+
+try {
+ final result = await api_instance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getEntitiesByDomain: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Entities result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *domainName = RAN; // domain name (default to null)
+String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
+
+// Get entities by domain
+[apiInstance getEntitiesByDomainWith:accept
+ domainName:domainName
+ targetFilter:targetFilter
+ scopeFilter:scopeFilter
+ offset:offset
+ limit:limit
+ completionHandler: ^(Entities output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/json; // {String}
+var domainName = RAN; // {String} domain name
+var opts = {
+ 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
+ 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getEntitiesByDomain(accept, domainName, opts, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getEntitiesByDomainExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/json; // String | (default to application/json)
+ var domainName = RAN; // String | domain name (default to null)
+ var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+ var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+
+ try {
+ // Get entities by domain
+ Entities result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getEntitiesByDomain: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-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\EntitiesAndRelationshipsApi();
+$accept = application/json; // String |
+$domainName = RAN; // String | domain name
+$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
+
+try {
+ $result = $api_instance->getEntitiesByDomain($accept, $domainName, $targetFilter, $scopeFilter, $offset, $limit);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/json; # String |
+my $domainName = RAN; # String | domain name
+my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
+my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
+
+eval {
+ my $result = $api_instance->getEntitiesByDomain(accept => $accept, domainName => $domainName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/json # String | (default to application/json)
+domainName = RAN # String | domain name (default to null)
+targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
+
+try:
+ # Get entities by domain
+ api_response = api_instance.get_entities_by_domain(accept, domainName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let domainName = RAN; // String
+ let targetFilter = /sourceIds;/classifiers; // String
+ let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+Use *targetFilter* to specify what needs to be returned in the REST response.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+ScopeFilter is used to specify the conditions to be applied.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Entities"
+ },
+ "examples" : {
+ "entities" : {
+ "$ref" : "#/components/examples/EntitiesResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-404-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-406-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-414-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-429-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-502-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-503-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getRelationshipById">
+ <article id="api-EntitiesAndRelationships-getRelationshipById-0" data-group="User" data-name="getRelationshipById" data-version="0">
+ <div class="pull-left">
+ <h1>getRelationshipById</h1>
+ <p>Get a specific Topology Relationship instance of a Topology Relationship type.</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get a specific Topology Relationship instance of a Topology Relationship type.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}</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-EntitiesAndRelationships-getRelationshipById-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipById-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/yang.data+json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/yang.data+json; // String |
+ String domainName = RAN; // String | domain name
+ String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+ String relationshipId = relationshipId_example; // String |
+
+ try {
+ Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String relationshipTypeName = new String(); // String |
+final String relationshipId = new String(); // String |
+
+try {
+ final result = await api_instance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getRelationshipById: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/yang.data+json; // String |
+ String domainName = RAN; // String | domain name
+ String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+ String relationshipId = relationshipId_example; // String |
+
+ try {
+ Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/yang.data+json; // (default to application/yang.data+json)
+String *domainName = RAN; // domain name (default to null)
+String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // (default to null)
+String *relationshipId = relationshipId_example; // (default to null)
+
+// Get a specific Topology Relationship instance of a Topology Relationship type.
+[apiInstance getRelationshipByIdWith:accept
+ domainName:domainName
+ relationshipTypeName:relationshipTypeName
+ relationshipId:relationshipId
+ completionHandler: ^(Object output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/yang.data+json; // {String}
+var domainName = RAN; // {String} domain name
+var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String}
+var relationshipId = relationshipId_example; // {String}
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getRelationshipByIdExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/yang.data+json; // String | (default to application/yang.data+json)
+ var domainName = RAN; // String | domain name (default to null)
+ var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | (default to null)
+ var relationshipId = relationshipId_example; // String | (default to null)
+
+ try {
+ // Get a specific Topology Relationship instance of a Topology Relationship type.
+ Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipById: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-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\EntitiesAndRelationshipsApi();
+$accept = application/yang.data+json; // String |
+$domainName = RAN; // String | domain name
+$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+$relationshipId = relationshipId_example; // String |
+
+try {
+ $result = $api_instance->getRelationshipById($accept, $domainName, $relationshipTypeName, $relationshipId);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/yang.data+json; # String |
+my $domainName = RAN; # String | domain name
+my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String |
+my $relationshipId = relationshipId_example; # String |
+
+eval {
+ my $result = $api_instance->getRelationshipById(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, relationshipId => $relationshipId);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/yang.data+json # String | (default to application/yang.data+json)
+domainName = RAN # String | domain name (default to null)
+relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String | (default to null)
+relationshipId = relationshipId_example # String | (default to null)
+
+try:
+ # Get a specific Topology Relationship instance of a Topology Relationship type.
+ api_response = api_instance.get_relationship_by_id(accept, domainName, relationshipTypeName, relationshipId)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/yang.data+json; // String
+ let domainName = RAN; // String
+ let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
+ let relationshipId = relationshipId_example; // String
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipById_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">relationshipTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipById_relationshipTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">relationshipId*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipById_relationshipId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipById_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-200-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/yang.data+json" : {
+ "schema" : {
+ "type" : "object",
+ "description" : "Encapsulated object reference to the data model for schema definition of Topology Relationship"
+ },
+ "examples" : {
+ "relationship" : {
+ "$ref" : "#/components/examples/RelationshipResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-400-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-401-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-403-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-404-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-406-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-414-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-429-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-500-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-502-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-503-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipById-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getRelationshipsByType">
+ <article id="api-EntitiesAndRelationships-getRelationshipsByType-0" data-group="User" data-name="getRelationshipsByType" data-version="0">
+ <div class="pull-left">
+ <h1>getRelationshipsByType</h1>
+ <p>Get all the available Topology Relationships of a specific relationship type name.</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get all the available Topology Relationships of a specific relationship type name name.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships</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-EntitiesAndRelationships-getRelationshipsByType-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Relationships result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String relationshipTypeName = new String(); // String |
+final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
+
+try {
+ final result = await api_instance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getRelationshipsByType: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Relationships result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *domainName = RAN; // domain name (default to null)
+String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // (default to null)
+String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
+
+// Get all the available Topology Relationships of a specific relationship type name.
+[apiInstance getRelationshipsByTypeWith:accept
+ domainName:domainName
+ relationshipTypeName:relationshipTypeName
+ targetFilter:targetFilter
+ scopeFilter:scopeFilter
+ offset:offset
+ limit:limit
+ completionHandler: ^(Relationships output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/json; // {String}
+var domainName = RAN; // {String} domain name
+var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String}
+var opts = {
+ 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
+ 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getRelationshipsByType(accept, domainName, relationshipTypeName, opts, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getRelationshipsByTypeExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/json; // String | (default to application/json)
+ var domainName = RAN; // String | domain name (default to null)
+ var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | (default to null)
+ var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+ var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+
+ try {
+ // Get all the available Topology Relationships of a specific relationship type name.
+ Relationships result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipsByType: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-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\EntitiesAndRelationshipsApi();
+$accept = application/json; // String |
+$domainName = RAN; // String | domain name
+$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
+
+try {
+ $result = $api_instance->getRelationshipsByType($accept, $domainName, $relationshipTypeName, $targetFilter, $scopeFilter, $offset, $limit);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/json; # String |
+my $domainName = RAN; # String | domain name
+my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String |
+my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
+my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
+
+eval {
+ my $result = $api_instance->getRelationshipsByType(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/json # String | (default to application/json)
+domainName = RAN # String | domain name (default to null)
+relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String | (default to null)
+targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
+
+try:
+ # Get all the available Topology Relationships of a specific relationship type name.
+ api_response = api_instance.get_relationships_by_type(accept, domainName, relationshipTypeName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let domainName = RAN; // String
+ let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
+ let targetFilter = /sourceIds;/classifiers; // String
+ let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">relationshipTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_relationshipTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+Use *targetFilter* to specify what needs to be returned in the REST response.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+ScopeFilter is used to specify the conditions to be applied.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Relationships"
+ },
+ "examples" : {
+ "relationships" : {
+ "$ref" : "#/components/examples/RelationshipsResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-404-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-406-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-414-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-429-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-502-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-503-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getTopologyByEntityTypeName">
+ <article id="api-EntitiesAndRelationships-getTopologyByEntityTypeName-0" data-group="User" data-name="getTopologyByEntityTypeName" data-version="0">
+ <div class="pull-left">
+ <h1>getTopologyByEntityTypeName</h1>
+ <p>Get all topology entities of a specific entity type.</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get all topology entities of a specific entity type.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities</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-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types/{entityTypeName}/entities?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String entityTypeName = entityTypeName_example; // String |
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Entities result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String entityTypeName = new String(); // String |
+final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
+
+try {
+ final result = await api_instance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getTopologyByEntityTypeName: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ String entityTypeName = entityTypeName_example; // String |
+ String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+ String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ Entities result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *domainName = RAN; // domain name (default to null)
+String *entityTypeName = entityTypeName_example; // (default to null)
+String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
+
+// Get all topology entities of a specific entity type.
+[apiInstance getTopologyByEntityTypeNameWith:accept
+ domainName:domainName
+ entityTypeName:entityTypeName
+ targetFilter:targetFilter
+ scopeFilter:scopeFilter
+ offset:offset
+ limit:limit
+ completionHandler: ^(Entities output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/json; // {String}
+var domainName = RAN; // {String} domain name
+var entityTypeName = entityTypeName_example; // {String}
+var opts = {
+ 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
+ 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getTopologyByEntityTypeName(accept, domainName, entityTypeName, opts, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getTopologyByEntityTypeNameExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/json; // String | (default to application/json)
+ var domainName = RAN; // String | domain name (default to null)
+ var entityTypeName = entityTypeName_example; // String | (default to null)
+ var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+ var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+
+ try {
+ // Get all topology entities of a specific entity type.
+ Entities result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyByEntityTypeName: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-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\EntitiesAndRelationshipsApi();
+$accept = application/json; // String |
+$domainName = RAN; // String | domain name
+$entityTypeName = entityTypeName_example; // String |
+$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
+$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
+
+try {
+ $result = $api_instance->getTopologyByEntityTypeName($accept, $domainName, $entityTypeName, $targetFilter, $scopeFilter, $offset, $limit);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/json; # String |
+my $domainName = RAN; # String | domain name
+my $entityTypeName = entityTypeName_example; # String |
+my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
+my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
+
+eval {
+ my $result = $api_instance->getTopologyByEntityTypeName(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/json # String | (default to application/json)
+domainName = RAN # String | domain name (default to null)
+entityTypeName = entityTypeName_example # String | (default to null)
+targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
+scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
+
+try:
+ # Get all topology entities of a specific entity type.
+ api_response = api_instance.get_topology_by_entity_type_name(accept, domainName, entityTypeName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let domainName = RAN; // String
+ let entityTypeName = entityTypeName_example; // String
+ let targetFilter = /sourceIds;/classifiers; // String
+ let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_entityTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+Use *targetFilter* to specify what needs to be returned in the REST response.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+ScopeFilter is used to specify the conditions to be applied.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Entities"
+ },
+ "examples" : {
+ "entities" : {
+ "$ref" : "#/components/examples/EntitiesResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-404-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-406-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-414-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-429-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-502-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-503-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getTopologyById">
+ <article id="api-EntitiesAndRelationships-getTopologyById-0" data-group="User" data-name="getTopologyById" data-version="0">
+ <div class="pull-left">
+ <h1>getTopologyById</h1>
+ <p>Get a specific Topology Entity instance of a Topology Entity type</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get a specific Topology Entity instance of a Topology Entity type</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}</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-EntitiesAndRelationships-getTopologyById-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyById-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/yang.data+json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/yang.data+json; // String |
+ String domainName = RAN; // String | domain name
+ String entityTypeName = entityTypeName_example; // String |
+ String entityId = entityId_example; // String |
+
+ try {
+ Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String entityTypeName = new String(); // String |
+final String entityId = new String(); // String |
+
+try {
+ final result = await api_instance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getTopologyById: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/yang.data+json; // String |
+ String domainName = RAN; // String | domain name
+ String entityTypeName = entityTypeName_example; // String |
+ String entityId = entityId_example; // String |
+
+ try {
+ Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
+ e.printStackTrace();
+ }
+ }
+}</code></pre>
+ </div>
+ <!--
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-groovy">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div> -->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-objc">
+ <pre class="prettyprint"><code class="language-cpp">
+
+// Create an instance of the API class
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/yang.data+json; // (default to application/yang.data+json)
+String *domainName = RAN; // domain name (default to null)
+String *entityTypeName = entityTypeName_example; // (default to null)
+String *entityId = entityId_example; // (default to null)
+
+// Get a specific Topology Entity instance of a Topology Entity type
+[apiInstance getTopologyByIdWith:accept
+ domainName:domainName
+ entityTypeName:entityTypeName
+ entityId:entityId
+ completionHandler: ^(Object output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
+
+// Create an instance of the API class
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/yang.data+json; // {String}
+var domainName = RAN; // {String} domain name
+var entityTypeName = entityTypeName_example; // {String}
+var entityId = entityId_example; // {String}
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getTopologyById(accept, domainName, entityTypeName, entityId, callback);
+</code></pre>
+ </div>
+
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-angular">
+ <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
+ </div>-->
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-csharp">
+ <pre class="prettyprint"><code class="language-cs">using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getTopologyByIdExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/yang.data+json; // String | (default to application/yang.data+json)
+ var domainName = RAN; // String | domain name (default to null)
+ var entityTypeName = entityTypeName_example; // String | (default to null)
+ var entityId = entityId_example; // String | (default to null)
+
+ try {
+ // Get a specific Topology Entity instance of a Topology Entity type
+ Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyById: " + e.Message );
+ }
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-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\EntitiesAndRelationshipsApi();
+$accept = application/yang.data+json; // String |
+$domainName = RAN; // String | domain name
+$entityTypeName = entityTypeName_example; // String |
+$entityId = entityId_example; // String |
+
+try {
+ $result = $api_instance->getTopologyById($accept, $domainName, $entityTypeName, $entityId);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyById: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/yang.data+json; # String |
+my $domainName = RAN; # String | domain name
+my $entityTypeName = entityTypeName_example; # String |
+my $entityId = entityId_example; # String |
+
+eval {
+ my $result = $api_instance->getTopologyById(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyById: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/yang.data+json # String | (default to application/yang.data+json)
+domainName = RAN # String | domain name (default to null)
+entityTypeName = entityTypeName_example # String | (default to null)
+entityId = entityId_example # String | (default to null)
+
+try:
+ # Get a specific Topology Entity instance of a Topology Entity type
+ api_response = api_instance.get_topology_by_id(accept, domainName, entityTypeName, entityId)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyById: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+
+pub fn main() {
+ let accept = application/yang.data+json; // String
+ let domainName = RAN; // String
+ let entityTypeName = entityTypeName_example; // String
+ let entityId = entityId_example; // String
+
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getTopologyById(accept, domainName, entityTypeName, entityId, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyById_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyById_entityTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityId*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyById_entityId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyById_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/yang.data+json" : {
+ "schema" : {
+ "type" : "object",
+ "description" : "Encapsulated object reference to the data model for schema definition of Topology Entity"
+ },
+ "examples" : {
+ "entity" : {
+ "$ref" : "#/components/examples/EntityResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-404-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-404-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-406-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-406-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-414" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-414-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-414-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-429" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-429-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-429-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-429" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-429');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-429-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-500" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-500" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Internal Server Error",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-500');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-500-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-502" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-502" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-502-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-502-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-502" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Gateway",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-502');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-502-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-503" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-503" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-503-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-503-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-503" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Service Unavailable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyById-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-503');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-503-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
+ <hr>
+ <div id="api-EntitiesAndRelationships-getTopologyEntityTypes">
+ <article id="api-EntitiesAndRelationships-getTopologyEntityTypes-0" data-group="User" data-name="getTopologyEntityTypes" data-version="0">
+ <div class="pull-left">
+ <h1>getTopologyEntityTypes</h1>
+ <p>Get all the available topology entity types in domain name.</p>
+ </div>
+ <div class="pull-right"></div>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Get all the available topology entity types in domain name.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types</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-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">Rust</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types?offset=56&limit=56"
+</code></pre>
+ </div>
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-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.EntitiesAndRelationshipsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
- DecoratorsApi apiInstance = new DecoratorsApi();
+
+ // Create an instance of the API class
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- Decorator decorator = ; // Decorator |
+ String domainName = RAN; // String | domain name
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- apiInstance.updateDecorator(accept, contentType, decorator);
+ EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling DecoratorsApi#updateDecorator");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
+ e.printStackTrace();
+ }
+ }
+}
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">
+ <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
+
+try {
+ final result = await api_instance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->getTopologyEntityTypes: $e\n');
+}
+
+</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+
+public class EntitiesAndRelationshipsApiExample {
+ public static void main(String[] args) {
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/json; // String |
+ String domainName = RAN; // String | domain name
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
+
+ try {
+ EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *contentType = application/json; // (default to application/json)
-Decorator *decorator = ; //
+String *domainName = RAN; // domain name (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Update entities and/or relationships with decorator(s).
-[apiInstance updateDecoratorWith:accept
- contentType:contentType
- decorator:decorator
- completionHandler: ^(NSError* error) {
+// Get all the available topology entity types in domain name.
+[apiInstance getTopologyEntityTypesWith:accept
+ domainName:domainName
+ offset:offset
+ limit:limit
+ completionHandler: ^(EntityTypes output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-javascript">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.DecoratorsApi()
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String}
-var contentType = application/json; // {String}
-var decorator = ; // {Decorator}
+var domainName = RAN; // {String} domain name
+var opts = {
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully.');
+ console.log('API called successfully. Returned data: ' + data);
}
};
-api.updateDecorator(accept, contentType, decorator, callback);
+api.getTopologyEntityTypes(accept, domainName, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Decorators-updateDecorator-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class updateDecoratorExample
+ public class getTopologyEntityTypesExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new DecoratorsApi();
+ var apiInstance = new EntitiesAndRelationshipsApi();
var accept = application/json; // String | (default to application/json)
- var contentType = application/json; // String | (default to application/json)
- var decorator = new Decorator(); // Decorator |
+ var domainName = RAN; // String | domain name (default to null)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Update entities and/or relationships with decorator(s).
- apiInstance.updateDecorator(accept, contentType, decorator);
+ // Get all the available topology entity types in domain name.
+ EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling DecoratorsApi.updateDecorator: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyEntityTypes: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-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\DecoratorsApi();
+$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String |
-$contentType = application/json; // String |
-$decorator = ; // Decorator |
+$domainName = RAN; // String | domain name
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
try {
- $api_instance->updateDecorator($accept, $contentType, $decorator);
+ $result = $api_instance->getTopologyEntityTypes($accept, $domainName, $offset, $limit);
+ print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling DecoratorsApi->updateDecorator: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::DecoratorsApi;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String |
-my $contentType = application/json; # String |
-my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator |
+my $domainName = RAN; # String | domain name
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
eval {
- $api_instance->updateDecorator(accept => $accept, contentType => $contentType, decorator => $decorator);
+ my $result = $api_instance->getTopologyEntityTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
+ print Dumper($result);
};
if ($@) {
- warn "Exception when calling DecoratorsApi->updateDecorator: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-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.DecoratorsApi()
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
accept = application/json # String | (default to application/json)
-contentType = application/json # String | (default to application/json)
-decorator = # Decorator |
+domainName = RAN # String | domain name (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Update entities and/or relationships with decorator(s).
- api_instance.update_decorator(accept, contentType, decorator)
+ # Get all the available topology entity types in domain name.
+ api_response = api_instance.get_topology_entity_types(accept, domainName, offset=offset, limit=limit)
+ pprint(api_response)
except ApiException as e:
- print("Exception when calling DecoratorsApi->updateDecorator: %s\n" % e)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate DecoratorsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
pub fn main() {
let accept = application/json; // String
- let contentType = application/json; // String
- let decorator = ; // Decorator
+ let domainName = RAN; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
- let mut context = DecoratorsApi::Context::default();
- let result = client.updateDecorator(accept, contentType, decorator, &context).wait();
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getTopologyEntityTypes(accept, domainName, offset, limit, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Header parameters</div>
+ <div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
-
-
- <div id="d2e199_updateDecorator_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">Content-Type*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
<td>
- <div id="d2e199_updateDecorator_contentType">
+ <div id="d2e199_getTopologyEntityTypes_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
+ <div class="inner description marked">
+domain name
+ </div>
</div>
<div class="inner required">
Required
</table>
- <div class="methodsubtabletitle">Body parameters</div>
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
- </tr>
- <tr><td style="width:150px;">decorator <span style="color:red;">*</span></td>
-<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/Decorator"
- },
- "examples" : {
- "mergeDecorator" : {
- "$ref" : "#/components/examples/DecoratorMergeExample"
- },
- "removeDecorator" : {
- "$ref" : "#/components/examples/DecoratorDeleteExample"
- }
- }
- }
- },
- "required" : true
-};
-
- 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,2,{isBodyParam: true});
- var result = $('#d2e199_updateDecorator_decorator');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_updateDecorator_decorator"></div>
-</td>
-</tr>
-
- </table>
-
-
-
- <h2>Responses</h2>
- <h3 id="examples-Decorators-updateDecorator-title-204"></h3>
- <p id="examples-Decorators-updateDecorator-description-204" class="marked"></p>
- <script>
- var responseDecorators204_description = `No Content`;
- var responseDecorators204_description_break = responseDecorators204_description.indexOf('\n');
- if (responseDecorators204_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description);
- } else {
- $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description.substring(0, responseDecorators204_description_break));
- $("#examples-Decorators-updateDecorator-description-204").html(responseDecorators204_description.substring(responseDecorators204_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Decorators-updateDecorator-204" class="nav nav-tabs nav-tabs-examples" >
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Decorators-updateDecorator-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-204-schema">
- <div id="responses-Decorators-updateDecorator-schema-204" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-204');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Decorators-updateDecorator-204-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Decorators-updateDecorator-title-400"></h3>
- <p id="examples-Decorators-updateDecorator-description-400" class="marked"></p>
- <script>
- var responseDecorators400_description = `Bad Request`;
- var responseDecorators400_description_break = responseDecorators400_description.indexOf('\n');
- if (responseDecorators400_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description);
- } else {
- $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description.substring(0, responseDecorators400_description_break));
- $("#examples-Decorators-updateDecorator-description-400").html(responseDecorators400_description.substring(responseDecorators400_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Decorators-updateDecorator-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-400-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Decorators-updateDecorator-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-400-schema">
- <div id="responses-Decorators-updateDecorator-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Decorators-updateDecorator-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Decorators-updateDecorator-title-401"></h3>
- <p id="examples-Decorators-updateDecorator-description-401" class="marked"></p>
- <script>
- var responseDecorators401_description = `Unauthorized`;
- var responseDecorators401_description_break = responseDecorators401_description.indexOf('\n');
- if (responseDecorators401_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description);
- } else {
- $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description.substring(0, responseDecorators401_description_break));
- $("#examples-Decorators-updateDecorator-description-401").html(responseDecorators401_description.substring(responseDecorators401_description_break));
- }
- </script>
+ <div id="d2e199_getTopologyEntityTypes_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
- <ul id="responses-detail-Decorators-updateDecorator-401" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-401-schema">Schema</a>
- </li>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+ </table>
- </ul>
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">offset</td>
+<td>
- <div class="tab-content" id="responses-Decorators-updateDecorator-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-401-schema">
- <div id="responses-Decorators-updateDecorator-schema-401" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Unauthorized",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
+ <div id="d2e199_getTopologyEntityTypes_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-401');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Decorators-updateDecorator-401-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Decorators-updateDecorator-title-403"></h3>
- <p id="examples-Decorators-updateDecorator-description-403" class="marked"></p>
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getTopologyEntityTypes_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200" class="marked"></p>
<script>
- var responseDecorators403_description = `Forbidden`;
- var responseDecorators403_description_break = responseDecorators403_description.indexOf('\n');
- if (responseDecorators403_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description);
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description.substring(0, responseDecorators403_description_break));
- $("#examples-Decorators-updateDecorator-description-403").html(responseDecorators403_description.substring(responseDecorators403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-403-schema">
- <div id="responses-Decorators-updateDecorator-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "OK",
"content" : {
- "application/problem+json" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/EntityTypes"
},
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "examples" : {
+ "entityTypes" : {
+ "$ref" : "#/components/examples/EntityTypesResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Decorators-updateDecorator-title-409"></h3>
- <p id="examples-Decorators-updateDecorator-description-409" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400" class="marked"></p>
<script>
- var responseDecorators409_description = `Conflict`;
- var responseDecorators409_description_break = responseDecorators409_description.indexOf('\n');
- if (responseDecorators409_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description);
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description.substring(0, responseDecorators409_description_break));
- $("#examples-Decorators-updateDecorator-description-409").html(responseDecorators409_description.substring(responseDecorators409_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-409" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-409-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-409-schema">
- <div id="responses-Decorators-updateDecorator-schema-409" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Conflict",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "409",
- "title" : "Conflicting request",
- "details" : "The request cannot be processed as the resource is in use."
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-409');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-409-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Decorators-updateDecorator-title-500"></h3>
- <p id="examples-Decorators-updateDecorator-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401" class="marked"></p>
<script>
- var responseDecorators500_description = `Internal Server Error`;
- var responseDecorators500_description_break = responseDecorators500_description.indexOf('\n');
- if (responseDecorators500_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description);
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description.substring(0, responseDecorators500_description_break));
- $("#examples-Decorators-updateDecorator-description-500").html(responseDecorators500_description.substring(responseDecorators500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-500-schema">
- <div id="responses-Decorators-updateDecorator-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-500');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Decorators-updateDecorator-500-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- </article>
- </div>
- <hr>
- </section>
- <section id="api-EntitiesAndRelationships">
- <h1>EntitiesAndRelationships</h1>
- <div id="api-EntitiesAndRelationships-getAllDomains">
- <article id="api-EntitiesAndRelationships-getAllDomains-0" data-group="User" data-name="getAllDomains" data-version="0">
- <div class="pull-left">
- <h1>getAllDomains</h1>
- <p>Get all the available topology domains.</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Get all the available topology domains.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains</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-EntitiesAndRelationships-getAllDomains-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllDomains-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains?offset=56&limit=56"
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-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.EntitiesAndRelationshipsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class EntitiesAndRelationshipsApiExample {
- public static void main(String[] args) {
-
- // Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/json; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
-
- try {
- Domains result = apiInstance.getAllDomains(accept, offset, limit);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
- e.printStackTrace();
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-dart">
- <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
-
-final api_instance = DefaultApi();
-
-final String accept = new String(); // String |
-final Integer offset = new Integer(); // Integer | Pagination offset.
-final Integer limit = new Integer(); // Integer | Result limiter.
-
-try {
- final result = await api_instance.getAllDomains(accept, offset, limit);
- print(result);
-} catch (e) {
- print('Exception when calling DefaultApi->getAllDomains: $e\n');
-}
-
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
-
-public class EntitiesAndRelationshipsApiExample {
- public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/json; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
-
- try {
- Domains result = apiInstance.getAllDomains(accept, offset, limit);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
- e.printStackTrace();
- }
- }
-}</code></pre>
- </div>
- <!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-groovy">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-objc">
- <pre class="prettyprint"><code class="language-cpp">
-
-// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
-String *accept = application/json; // (default to application/json)
-Integer *offset = 56; // Pagination offset. (optional) (default to 0)
-Integer *limit = 56; // Result limiter. (optional) (default to 500)
-
-// Get all the available topology domains.
-[apiInstance getAllDomainsWith:accept
- offset:offset
- limit:limit
- completionHandler: ^(Domains output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
- if (error) {
- NSLog(@"Error: %@", error);
- }
-}];
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
-
-// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
-var accept = application/json; // {String}
-var opts = {
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
-};
-
-var callback = function(error, data, response) {
- if (error) {
- console.error(error);
- } else {
- console.log('API called successfully. Returned data: ' + data);
- }
-};
-api.getAllDomains(accept, opts, callback);
-</code></pre>
- </div>
-
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-angular">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-csharp">
- <pre class="prettyprint"><code class="language-cs">using System;
-using System.Diagnostics;
-using Org.OpenAPITools.Api;
-using Org.OpenAPITools.Client;
-using Org.OpenAPITools.Model;
-
-namespace Example
-{
- public class getAllDomainsExample
- {
- public void main()
- {
-
- // Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
- var accept = application/json; // String | (default to application/json)
- var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
- var limit = 56; // Integer | Result limiter. (optional) (default to 500)
-
- try {
- // Get all the available topology domains.
- Domains result = apiInstance.getAllDomains(accept, offset, limit);
- Debug.WriteLine(result);
- } catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllDomains: " + e.Message );
- }
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-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\EntitiesAndRelationshipsApi();
-$accept = application/json; // String |
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
-
-try {
- $result = $api_instance->getAllDomains($accept, $offset, $limit);
- print_r($result);
-} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getAllDomains: ', $e->getMessage(), PHP_EOL;
-}
-?></code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-perl">
- <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
-use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
-
-# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
-my $accept = application/json; # String |
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
-
-eval {
- my $result = $api_instance->getAllDomains(accept => $accept, offset => $offset, limit => $limit);
- print Dumper($result);
-};
-if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getAllDomains: $@\n";
-}</code></pre>
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data' type='hidden' value=''></input>
+ </div>
</div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-python">
- <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-# Create an instance of the API class
-api_instance = openapi_client.EntitiesAndRelationshipsApi()
-accept = application/json # String | (default to application/json)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">Schema</a>
+ </li>
-try:
- # Get all the available topology domains.
- api_response = api_instance.get_all_domains(accept, offset=offset, limit=limit)
- pprint(api_response)
-except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getAllDomains: %s\n" % e)</code></pre>
- </div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
-pub fn main() {
- let accept = application/json; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getAllDomains(accept, offset, limit, &context).wait();
+ </ul>
- println!("{:?}", result);
-}
-</code></pre>
- </div>
- </div>
- <h2>Scopes</h2>
- <table>
-
- </table>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Parameters</h2>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-404-schema">Schema</a>
+ </li>
- <div id="d2e199_getAllDomains_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ </ul>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-404-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">offset</td>
-<td>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-406" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
+ }
+ </script>
- <div id="d2e199_getAllDomains_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-406-schema">Schema</a>
+ </li>
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">limit</td>
-<td>
- <div id="d2e199_getAllDomains_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ </ul>
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-406-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-200" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-414" class="marked"></p>
<script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-414" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-414-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-200-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-414-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-414" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "URI Too Large",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/Domains"
- },
- "examples" : {
- "domains" : {
- "$ref" : "#/components/examples/DomainsResponseExample"
- }
+ "$ref" : "#/components/schemas/ErrorMessage"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-200');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-414');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-414-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-429" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-400-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-429-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Too Many Requests",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-400');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-401-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-401');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-502" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-403-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-502-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-503" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-500-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-503-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-500');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId">
- <article id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId-0" data-group="User" data-name="getAllRelationshipsForEntityId" data-version="0">
+ <div id="api-EntitiesAndRelationships-getTopologyRelationshipTypes">
+ <article id="api-EntitiesAndRelationships-getTopologyRelationshipTypes-0" data-group="User" data-name="getTopologyRelationshipTypes" data-version="0">
<div class="pull-left">
- <h1>getAllRelationshipsForEntityId</h1>
- <p>Get all relationships for entity type name with specified id. Specified id represents the entity instance.</p>
+ <h1>getTopologyRelationshipTypes</h1>
+ <p>Get all the available topology relationship types.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all relationships for entity type name with specified id. Specified id represents the entity instance.</p>
+ <p class="marked">Get all the available Topology Relationship types.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types</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-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+ "https://localhost/topology-inventory/v1/domains/{domainName}/relationship-types?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
String domainName = RAN; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String entityId = entityId_example; // String |
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
final String domainName = new String(); // String | domain name
-final String entityTypeName = new String(); // String |
-final String entityId = new String(); // String |
-final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.
try {
- final result = await api_instance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ final result = await api_instance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getAllRelationshipsForEntityId: $e\n');
+ print('Exception when calling DefaultApi->getTopologyRelationshipTypes: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
public class EntitiesAndRelationshipsApiExample {
EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
String domainName = RAN; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String entityId = entityId_example; // String |
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; // (default to application/json)
String *domainName = RAN; // domain name (default to null)
-String *entityTypeName = entityTypeName_example; // (default to null)
-String *entityId = entityId_example; // (default to null)
-String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Get all relationships for entity type name with specified id. Specified id represents the entity instance.
-[apiInstance getAllRelationshipsForEntityIdWith:accept
+// Get all the available topology relationship types.
+[apiInstance getTopologyRelationshipTypesWith:accept
domainName:domainName
- entityTypeName:entityTypeName
- entityId:entityId
- targetFilter:targetFilter
- scopeFilter:scopeFilter
offset:offset
limit:limit
- completionHandler: ^(RelationshipsResponseMessage output, NSError* error) {
+ completionHandler: ^(RelationshipTypes output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String}
var domainName = RAN; // {String} domain name
-var entityTypeName = entityTypeName_example; // {String}
-var entityId = entityId_example; // {String}
var opts = {
- 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
- 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
'offset': 56, // {Integer} Pagination offset.
'limit': 56 // {Integer} Result limiter.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, opts, callback);
+api.getTopologyRelationshipTypes(accept, domainName, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getAllRelationshipsForEntityIdExample
+ public class getTopologyRelationshipTypesExample
{
public void main()
{
var apiInstance = new EntitiesAndRelationshipsApi();
var accept = application/json; // String | (default to application/json)
var domainName = RAN; // String | domain name (default to null)
- var entityTypeName = entityTypeName_example; // String | (default to null)
- var entityId = entityId_example; // String | (default to null)
- var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
- var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Get all relationships for entity type name with specified id. Specified id represents the entity instance.
- RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
+ // Get all the available topology relationship types.
+ RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllRelationshipsForEntityId: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyRelationshipTypes: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String |
$domainName = RAN; // String | domain name
-$entityTypeName = entityTypeName_example; // String |
-$entityId = entityId_example; // String |
-$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.
try {
- $result = $api_instance->getAllRelationshipsForEntityId($accept, $domainName, $entityTypeName, $entityId, $targetFilter, $scopeFilter, $offset, $limit);
+ $result = $api_instance->getTopologyRelationshipTypes($accept, $domainName, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String |
my $domainName = RAN; # String | domain name
-my $entityTypeName = entityTypeName_example; # String |
-my $entityId = entityId_example; # String |
-my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
-my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.
eval {
- my $result = $api_instance->getAllRelationshipsForEntityId(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ my $result = $api_instance->getTopologyRelationshipTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
api_instance = openapi_client.EntitiesAndRelationshipsApi()
accept = application/json # String | (default to application/json)
domainName = RAN # String | domain name (default to null)
-entityTypeName = entityTypeName_example # String | (default to null)
-entityId = entityId_example # String | (default to null)
-targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Get all relationships for entity type name with specified id. Specified id represents the entity instance.
- api_response = api_instance.get_all_relationships_for_entity_id(accept, domainName, entityTypeName, entityId, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ # Get all the available topology relationship types.
+ api_response = api_instance.get_topology_relationship_types(accept, domainName, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: %s\n" % e)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">
<pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
pub fn main() {
let accept = application/json; // String
let domainName = RAN; // String
- let entityTypeName = entityTypeName_example; // String
- let entityId = entityId_example; // String
- let targetFilter = /sourceIds;/classifiers; // String
- let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
let offset = 56; // Integer
let limit = 56; // Integer
let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit, &context).wait();
+ let result = client.getTopologyRelationshipTypes(accept, domainName, offset, limit, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_domainName">
+ <div id="d2e199_getTopologyRelationshipTypes_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- <tr><td style="width:150px;">entityTypeName*</td>
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_entityTypeName">
+ <div id="d2e199_getTopologyRelationshipTypes_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- <tr><td style="width:150px;">entityId*</td>
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_entityId">
+ <div id="d2e199_getTopologyRelationshipTypes_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getTopologyRelationshipTypes_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
</span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RelationshipTypes"
+ },
+ "examples" : {
+ "relationshipTypes" : {
+ "$ref" : "#/components/examples/RelationshipTypesResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ }
+ </script>
+
- </table>
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">Schema</a>
+ </li>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
- <div id="d2e199_getAllRelationshipsForEntityId_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </ul>
- </table>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ }
+ </script>
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">Schema</a>
+ </li>
- <div id="d2e199_getAllRelationshipsForEntityId_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- <div class="inner description marked">
-Use *targetFilter* to specify what needs to be returned in the REST response.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">scopeFilter</td>
-<td>
+ </ul>
- <div id="d2e199_getAllRelationshipsForEntityId_scopeFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- <div class="inner description marked">
-ScopeFilter is used to specify the conditions to be applied.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <tr><td style="width:150px;">offset</td>
-<td>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-404" class="marked"></p>
+ <script>
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ }
+ </script>
- <div id="d2e199_getAllRelationshipsForEntityId_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-404-schema">Schema</a>
+ </li>
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">limit</td>
-<td>
- <div id="d2e199_getAllRelationshipsForEntityId_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ </ul>
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-404-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-406"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-406" class="marked"></p>
<script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ var responseEntitiesAndRelationships406_description = `Not Acceptable`;
+ var responseEntitiesAndRelationships406_description_break = responseEntitiesAndRelationships406_description.indexOf('\n');
+ if (responseEntitiesAndRelationships406_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-406").text("Status: 406 - " + responseEntitiesAndRelationships406_description.substring(0, responseEntitiesAndRelationships406_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-406").html(responseEntitiesAndRelationships406_description.substring(responseEntitiesAndRelationships406_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-406" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-406-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-406-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-406" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Not Acceptable",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/RelationshipsResponseMessage"
- },
- "examples" : {
- "relationships" : {
- "$ref" : "#/components/examples/RelationshipsResponseExample"
- }
+ "$ref" : "#/components/schemas/ErrorMessage"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-406');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-406-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-414"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-414" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseEntitiesAndRelationships414_description = `URI Too Large`;
+ var responseEntitiesAndRelationships414_description_break = responseEntitiesAndRelationships414_description.indexOf('\n');
+ if (responseEntitiesAndRelationships414_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-414").text("Status: 414 - " + responseEntitiesAndRelationships414_description.substring(0, responseEntitiesAndRelationships414_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-414").html(responseEntitiesAndRelationships414_description.substring(responseEntitiesAndRelationships414_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-414" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-414-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-414-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-414" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "URI Too Large",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-414');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-414-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-429"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-429" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseEntitiesAndRelationships429_description = `Too Many Requests`;
+ var responseEntitiesAndRelationships429_description_break = responseEntitiesAndRelationships429_description.indexOf('\n');
+ if (responseEntitiesAndRelationships429_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-429").text("Status: 429 - " + responseEntitiesAndRelationships429_description.substring(0, responseEntitiesAndRelationships429_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-429").html(responseEntitiesAndRelationships429_description.substring(responseEntitiesAndRelationships429_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-429-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Too Many Requests",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-502"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-502" class="marked"></p>
<script>
- var responseEntitiesAndRelationships404_description = `Not Found`;
- var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
- if (responseEntitiesAndRelationships404_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ var responseEntitiesAndRelationships502_description = `Bad Gateway`;
+ var responseEntitiesAndRelationships502_description_break = responseEntitiesAndRelationships502_description.indexOf('\n');
+ if (responseEntitiesAndRelationships502_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-502").text("Status: 502 - " + responseEntitiesAndRelationships502_description.substring(0, responseEntitiesAndRelationships502_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-502").html(responseEntitiesAndRelationships502_description.substring(responseEntitiesAndRelationships502_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-502-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-503"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-503" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseEntitiesAndRelationships503_description = `Service Unavailable`;
+ var responseEntitiesAndRelationships503_description_break = responseEntitiesAndRelationships503_description.indexOf('\n');
+ if (responseEntitiesAndRelationships503_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-503").text("Status: 503 - " + responseEntitiesAndRelationships503_description.substring(0, responseEntitiesAndRelationships503_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-503").html(responseEntitiesAndRelationships503_description.substring(responseEntitiesAndRelationships503_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-503-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getEntitiesByDomain">
- <article id="api-EntitiesAndRelationships-getEntitiesByDomain-0" data-group="User" data-name="getEntitiesByDomain" data-version="0">
+ </section>
+ <section id="api-Groups">
+ <h1>Groups</h1>
+ <div id="api-Groups-createGroup">
+ <article id="api-Groups-createGroup-0" data-group="User" data-name="createGroup" data-version="0">
<div class="pull-left">
- <h1>getEntitiesByDomain</h1>
- <p>Get entities by domain</p>
+ <h1>createGroup</h1>
+ <p>Create a new group.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get topology entities by domain, using a specified *targetFilter* as a query parameter.</p>
+ <p class="marked">Create a group of entities and/or relationships in a static or dynamic way.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entities</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/groups</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-EntitiesAndRelationships-getEntitiesByDomain-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-createGroup-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-createGroup-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-createGroup-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-createGroup-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-createGroup-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-createGroup-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ <div class="tab-pane active" id="examples-Groups-createGroup-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entities?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+ -H "Content-Type: application/json" \
+ "https://localhost/topology-inventory/v1/groups" \
+ -d '{
+ "name" : "name",
+ "providedMembers" : [ "{}", "{}" ],
+ "type" : "type"
+}'
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">
+ <div class="tab-pane" id="examples-Groups-createGroup-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String contentType = application/json; // String |
+ CreateGroupPayload createGroupPayload = ; // CreateGroupPayload |
try {
- EntitiesResponseMessage result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
+ System.err.println("Exception when calling GroupsApi#createGroup");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">
+ <div class="tab-pane" id="examples-Groups-createGroup-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
-final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
-final Integer offset = new Integer(); // Integer | Pagination offset.
-final Integer limit = new Integer(); // Integer | Result limiter.
+final String contentType = new String(); // String |
+final CreateGroupPayload createGroupPayload = new CreateGroupPayload(); // CreateGroupPayload |
try {
- final result = await api_instance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ final result = await api_instance.createGroup(accept, contentType, createGroupPayload);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getEntitiesByDomain: $e\n');
+ print('Exception when calling DefaultApi->createGroup: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-createGroup-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String contentType = application/json; // String |
+ CreateGroupPayload createGroupPayload = ; // CreateGroupPayload |
try {
- EntitiesResponseMessage result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
+ System.err.println("Exception when calling GroupsApi#createGroup");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">
+ <div class="tab-pane" id="examples-Groups-createGroup-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">
+ <div class="tab-pane" id="examples-Groups-createGroup-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *domainName = RAN; // domain name (default to null)
-String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
-Integer *offset = 56; // Pagination offset. (optional) (default to 0)
-Integer *limit = 56; // Result limiter. (optional) (default to 500)
+String *contentType = application/json; // (default to application/json)
+CreateGroupPayload *createGroupPayload = ; //
-// Get entities by domain
-[apiInstance getEntitiesByDomainWith:accept
- domainName:domainName
- targetFilter:targetFilter
- scopeFilter:scopeFilter
- offset:offset
- limit:limit
- completionHandler: ^(EntitiesResponseMessage output, NSError* error) {
+// Create a new group.
+[apiInstance createGroupWith:accept
+ contentType:contentType
+ createGroupPayload:createGroupPayload
+ completionHandler: ^(GroupByIdResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">
+ <div class="tab-pane" id="examples-Groups-createGroup-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String}
-var domainName = RAN; // {String} domain name
-var opts = {
- 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
- 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
-};
+var contentType = application/json; // {String}
+var createGroupPayload = ; // {CreateGroupPayload}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getEntitiesByDomain(accept, domainName, opts, callback);
+api.createGroup(accept, contentType, createGroupPayload, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-createGroup-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">
+ <div class="tab-pane" id="examples-Groups-createGroup-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getEntitiesByDomainExample
+ public class createGroupExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new GroupsApi();
var accept = application/json; // String | (default to application/json)
- var domainName = RAN; // String | domain name (default to null)
- var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
- var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
- var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
- var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+ var contentType = application/json; // String | (default to application/json)
+ var createGroupPayload = new CreateGroupPayload(); // CreateGroupPayload |
try {
- // Get entities by domain
- EntitiesResponseMessage result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
+ // Create a new group.
+ GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getEntitiesByDomain: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.createGroup: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">
+ <div class="tab-pane" id="examples-Groups-createGroup-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\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String |
-$domainName = RAN; // String | domain name
-$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
+$contentType = application/json; // String |
+$createGroupPayload = ; // CreateGroupPayload |
try {
- $result = $api_instance->getEntitiesByDomain($accept, $domainName, $targetFilter, $scopeFilter, $offset, $limit);
+ $result = $api_instance->createGroup($accept, $contentType, $createGroupPayload);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">
+ <div class="tab-pane" id="examples-Groups-createGroup-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String |
-my $domainName = RAN; # String | domain name
-my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
-my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
+my $contentType = application/json; # String |
+my $createGroupPayload = WWW::OPenAPIClient::Object::CreateGroupPayload->new(); # CreateGroupPayload |
eval {
- my $result = $api_instance->getEntitiesByDomain(accept => $accept, domainName => $domainName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ my $result = $api_instance->createGroup(accept => $accept, contentType => $contentType, createGroupPayload => $createGroupPayload);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: $@\n";
+ warn "Exception when calling GroupsApi->createGroup: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">
+ <div class="tab-pane" id="examples-Groups-createGroup-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.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.GroupsApi()
accept = application/json # String | (default to application/json)
-domainName = RAN # String | domain name (default to null)
-targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
+contentType = application/json # String | (default to application/json)
+createGroupPayload = # CreateGroupPayload |
try:
- # Get entities by domain
- api_response = api_instance.get_entities_by_domain(accept, domainName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ # Create a new group.
+ api_response = api_instance.create_group(accept, contentType, createGroupPayload)
pprint(api_response)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->createGroup: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-createGroup-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
let accept = application/json; // String
- let domainName = RAN; // String
- let targetFilter = /sourceIds;/classifiers; // String
- let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
-
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit, &context).wait();
-
- println!("{:?}", result);
-}
-</code></pre>
- </div>
- </div>
-
- <h2>Scopes</h2>
- <table>
-
- </table>
-
- <h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getEntitiesByDomain_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
-
-
- <div id="d2e199_getEntitiesByDomain_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
-
-
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
-
-
- <div id="d2e199_getEntitiesByDomain_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
+ let contentType = application/json; // String
+ let createGroupPayload = ; // CreateGroupPayload
- <div class="inner description marked">
-Use *targetFilter* to specify what needs to be returned in the REST response.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
+ let mut context = GroupsApi::Context::default();
+ let result = client.createGroup(accept, contentType, createGroupPayload, &context).wait();
- <tr><td style="width:150px;">scopeFilter</td>
-<td>
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
- <div id="d2e199_getEntitiesByDomain_scopeFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
+ <h2>Parameters</h2>
- <div class="inner description marked">
-ScopeFilter is used to specify the conditions to be applied.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">offset</td>
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getEntitiesByDomain_offset">
+ <div id="d2e199_createGroup_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- Integer
+ String
</span>
- <div class="inner description marked">
-Pagination offset.
- </div>
</div>
+ <div class="inner required">
+ Required
+ </div>
</div>
</div>
</td>
</tr>
- <tr><td style="width:150px;">limit</td>
+ <tr><td style="width:150px;">Content-Type*</td>
<td>
- <div id="d2e199_getEntitiesByDomain_limit">
+ <div id="d2e199_createGroup_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- Integer
+ String
</span>
- <div class="inner description marked">
-Result limiter.
- </div>
</div>
+ <div class="inner required">
+ Required
+ </div>
</div>
</div>
</td>
</table>
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">createGroupPayload <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EntitiesResponseMessage"
+ "$ref" : "#/components/schemas/CreateGroupPayload"
},
"examples" : {
- "entities" : {
- "$ref" : "#/components/examples/EntitiesResponseExample"
+ "staticGroup" : {
+ "$ref" : "#/components/examples/CreateStaticGroupPayloadExample"
+ },
+ "dynamicGroup" : {
+ "$ref" : "#/components/examples/CreateDynamicGroupGetEntitiesByDomainPayloadExample"
}
}
}
- }
+ },
+ "required" : true
};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-400" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
- } else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">Schema</a>
- </li>
-
+ 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,2,{isBodyParam: true});
+ var result = $('#d2e199_createGroup_createGroupPayload');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_createGroup_createGroupPayload"></div>
+</td>
+</tr>
- </ul>
+ </table>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-401" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ <h2>Responses</h2>
+ <h3 id="examples-Groups-createGroup-title-201"></h3>
+ <p id="examples-Groups-createGroup-description-201" class="marked"></p>
+ <script>
+ var responseGroups201_description = `Created`;
+ var responseGroups201_description_break = responseGroups201_description.indexOf('\n');
+ if (responseGroups201_description_break == -1) {
+ $("#examples-Groups-createGroup-title-201").text("Status: 201 - " + responseGroups201_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Groups-createGroup-title-201").text("Status: 201 - " + responseGroups201_description.substring(0, responseGroups201_description_break));
+ $("#examples-Groups-createGroup-description-201").html(responseGroups201_description.substring(responseGroups201_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-createGroup-201" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-createGroup-201-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-createGroup-201-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-createGroup-201-schema">
+ <div id="responses-Groups-createGroup-schema-201" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Created",
"content" : {
- "application/problem+json" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/GroupByIdResponse"
},
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "examples" : {
+ "static" : {
+ "$ref" : "#/components/examples/StaticGroupResponseExample"
+ },
+ "dynamic" : {
+ "$ref" : "#/components/examples/DynamicGroupResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401');
+ $('#responses-Groups-createGroup-201-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-createGroup-schema-201');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-createGroup-201-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-403" class="marked"></p>
+ <h3 id="examples-Groups-createGroup-title-400"></h3>
+ <p id="examples-Groups-createGroup-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-createGroup-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-createGroup-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-createGroup-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-createGroup-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-createGroup-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-createGroup-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-createGroup-400-schema">
+ <div id="responses-Groups-createGroup-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403');
+ $('#responses-Groups-createGroup-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-createGroup-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-createGroup-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-500" class="marked"></p>
+ <h3 id="examples-Groups-createGroup-title-500"></h3>
+ <p id="examples-Groups-createGroup-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-createGroup-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-createGroup-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-createGroup-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-createGroup-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-createGroup-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-createGroup-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-createGroup-500-schema">
+ <div id="responses-Groups-createGroup-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500');
+ $('#responses-Groups-createGroup-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-createGroup-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-createGroup-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getRelationshipById">
- <article id="api-EntitiesAndRelationships-getRelationshipById-0" data-group="User" data-name="getRelationshipById" data-version="0">
+ <div id="api-Groups-deleteGroup">
+ <article id="api-Groups-deleteGroup-0" data-group="User" data-name="deleteGroup" data-version="0">
<div class="pull-left">
- <h1>getRelationshipById</h1>
- <p>Get relationship with specified id. Specified id represents the relationship instance.</p>
+ <h1>deleteGroup</h1>
+ <p>Delete a group with specified id.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get relationship with specified id. Specified id represents the relationship instance.</p>
+ <p class="marked">Delete a group with specified id.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/groups/{groupId}</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-EntitiesAndRelationships-getRelationshipById-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-deleteGroup-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-deleteGroup-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-deleteGroup-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-deleteGroup-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-deleteGroup-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-deleteGroup-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipById-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/yang.data+json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}"
+ <div class="tab-pane active" id="examples-Groups-deleteGroup-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://localhost/topology-inventory/v1/groups/{groupId}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-java">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/yang.data+json; // String |
- String domainName = RAN; // String | domain name
- String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
- String relationshipId = relationshipId_example; // String |
+ GroupsApi apiInstance = new GroupsApi();
+ String groupId = groupId_example; // String |
try {
- Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
- System.out.println(result);
+ apiInstance.deleteGroup(groupId);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
+ System.err.println("Exception when calling GroupsApi#deleteGroup");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-dart">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
-final String relationshipTypeName = new String(); // String |
-final String relationshipId = new String(); // String |
+final String groupId = new String(); // String |
try {
- final result = await api_instance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ final result = await api_instance.deleteGroup(groupId);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getRelationshipById: $e\n');
+ print('Exception when calling DefaultApi->deleteGroup: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/yang.data+json; // String |
- String domainName = RAN; // String | domain name
- String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
- String relationshipId = relationshipId_example; // String |
+ GroupsApi apiInstance = new GroupsApi();
+ String groupId = groupId_example; // String |
try {
- Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
- System.out.println(result);
+ apiInstance.deleteGroup(groupId);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
+ System.err.println("Exception when calling GroupsApi#deleteGroup");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-groovy">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-objc">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
-String *accept = application/yang.data+json; // (default to application/yang.data+json)
-String *domainName = RAN; // domain name (default to null)
-String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // (default to null)
-String *relationshipId = relationshipId_example; // (default to null)
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
+String *groupId = groupId_example; // (default to null)
-// Get relationship with specified id. Specified id represents the relationship instance.
-[apiInstance getRelationshipByIdWith:accept
- domainName:domainName
- relationshipTypeName:relationshipTypeName
- relationshipId:relationshipId
- completionHandler: ^(Object output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+// Delete a group with specified id.
+[apiInstance deleteGroupWith:groupId
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-javascript">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
-var accept = application/yang.data+json; // {String}
-var domainName = RAN; // {String} domain name
-var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String}
-var relationshipId = relationshipId_example; // {String}
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
+var groupId = groupId_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, callback);
+api.deleteGroup(groupId, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-deleteGroup-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-csharp">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getRelationshipByIdExample
+ public class deleteGroupExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
- var accept = application/yang.data+json; // String | (default to application/yang.data+json)
- var domainName = RAN; // String | domain name (default to null)
- var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | (default to null)
- var relationshipId = relationshipId_example; // String | (default to null)
+ var apiInstance = new GroupsApi();
+ var groupId = groupId_example; // String | (default to null)
try {
- // Get relationship with specified id. Specified id represents the relationship instance.
- Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
- Debug.WriteLine(result);
+ // Delete a group with specified id.
+ apiInstance.deleteGroup(groupId);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipById: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.deleteGroup: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-php">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-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\EntitiesAndRelationshipsApi();
-$accept = application/yang.data+json; // String |
-$domainName = RAN; // String | domain name
-$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
-$relationshipId = relationshipId_example; // String |
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
+$groupId = groupId_example; // String |
try {
- $result = $api_instance->getRelationshipById($accept, $domainName, $relationshipTypeName, $relationshipId);
- print_r($result);
+ $api_instance->deleteGroup($groupId);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-perl">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
-my $accept = application/yang.data+json; # String |
-my $domainName = RAN; # String | domain name
-my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String |
-my $relationshipId = relationshipId_example; # String |
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
+my $groupId = groupId_example; # String |
eval {
- my $result = $api_instance->getRelationshipById(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, relationshipId => $relationshipId);
- print Dumper($result);
+ $api_instance->deleteGroup(groupId => $groupId);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: $@\n";
+ warn "Exception when calling GroupsApi->deleteGroup: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-python">
+ <div class="tab-pane" id="examples-Groups-deleteGroup-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.EntitiesAndRelationshipsApi()
-accept = application/yang.data+json # String | (default to application/yang.data+json)
-domainName = RAN # String | domain name (default to null)
-relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String | (default to null)
-relationshipId = relationshipId_example # String | (default to null)
+api_instance = openapi_client.GroupsApi()
+groupId = groupId_example # String | (default to null)
try:
- # Get relationship with specified id. Specified id represents the relationship instance.
- api_response = api_instance.get_relationship_by_id(accept, domainName, relationshipTypeName, relationshipId)
- pprint(api_response)
+ # Delete a group with specified id.
+ api_instance.delete_group(groupId)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->deleteGroup: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-deleteGroup-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
- let accept = application/yang.data+json; // String
- let domainName = RAN; // String
- let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
- let relationshipId = relationshipId_example; // String
-
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, &context).wait();
-
- println!("{:?}", result);
-}
-</code></pre>
- </div>
- </div>
-
- <h2>Scopes</h2>
- <table>
-
- </table>
-
- <h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getRelationshipById_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">relationshipTypeName*</td>
-<td>
-
-
- <div id="d2e199_getRelationshipById_relationshipTypeName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">relationshipId*</td>
-<td>
-
-
- <div id="d2e199_getRelationshipById_relationshipId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
-
-
- <div id="d2e199_getRelationshipById_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
-
-
-
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
+ let groupId = groupId_example; // String
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-200-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/yang.data+json" : {
- "schema" : {
- "type" : "object",
- "description" : "Refer to yang model for schema definition"
- },
- "examples" : {
- "relationship" : {
- "$ref" : "#/components/examples/RelationshipResponseExample"
- }
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
+ let mut context = GroupsApi::Context::default();
+ let result = client.deleteGroup(groupId, &context).wait();
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-200-schema-data' type='hidden' value=''></input>
- </div>
+ println!("{:?}", result);
+}
+</code></pre>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-400" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
- }
- </script>
+ </div>
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-400-schema">Schema</a>
- </li>
+ <h2>Parameters</h2>
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">groupId*</td>
+<td>
+ <div id="d2e199_deleteGroup_groupId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
- </ul>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+ </table>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-400-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-401" class="marked"></p>
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-Groups-deleteGroup-title-204"></h3>
+ <p id="examples-Groups-deleteGroup-description-204" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseGroups204_description = `No Content`;
+ var responseGroups204_description_break = responseGroups204_description.indexOf('\n');
+ if (responseGroups204_description_break == -1) {
+ $("#examples-Groups-deleteGroup-title-204").text("Status: 204 - " + responseGroups204_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Groups-deleteGroup-title-204").text("Status: 204 - " + responseGroups204_description.substring(0, responseGroups204_description_break));
+ $("#examples-Groups-deleteGroup-description-204").html(responseGroups204_description.substring(responseGroups204_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-401" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-401-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-Groups-deleteGroup-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-401-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-deleteGroup-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-deleteGroup-204-schema">
+ <div id="responses-Groups-deleteGroup-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
- }
- }
- }
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-401');
+ $('#responses-Groups-deleteGroup-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-deleteGroup-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-deleteGroup-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-403" class="marked"></p>
+ <h3 id="examples-Groups-deleteGroup-title-400"></h3>
+ <p id="examples-Groups-deleteGroup-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-deleteGroup-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-deleteGroup-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-deleteGroup-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-deleteGroup-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-deleteGroup-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-403-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-deleteGroup-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-deleteGroup-400-schema">
+ <div id="responses-Groups-deleteGroup-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-403');
+ $('#responses-Groups-deleteGroup-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-deleteGroup-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-deleteGroup-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-404"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-404" class="marked"></p>
+ <h3 id="examples-Groups-deleteGroup-title-404"></h3>
+ <p id="examples-Groups-deleteGroup-description-404" class="marked"></p>
<script>
- var responseEntitiesAndRelationships404_description = `Not Found`;
- var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
- if (responseEntitiesAndRelationships404_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ var responseGroups404_description = `Not Found`;
+ var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
+ if (responseGroups404_description_break == -1) {
+ $("#examples-Groups-deleteGroup-title-404").text("Status: 404 - " + responseGroups404_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ $("#examples-Groups-deleteGroup-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
+ $("#examples-Groups-deleteGroup-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-deleteGroup-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-deleteGroup-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-404-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-deleteGroup-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-deleteGroup-404-schema">
+ <div id="responses-Groups-deleteGroup-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-404');
+ $('#responses-Groups-deleteGroup-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-deleteGroup-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-deleteGroup-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-500" class="marked"></p>
+ <h3 id="examples-Groups-deleteGroup-title-500"></h3>
+ <p id="examples-Groups-deleteGroup-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-deleteGroup-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-deleteGroup-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-deleteGroup-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-deleteGroup-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-deleteGroup-500-schema">Schema</a>
</li>
</ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-500-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-500" class="exampleStyle">
+
+
+ <div class="tab-content" id="responses-Groups-deleteGroup-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-deleteGroup-500-schema">
+ <div id="responses-Groups-deleteGroup-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-500');
+ $('#responses-Groups-deleteGroup-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-deleteGroup-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-deleteGroup-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getRelationshipsByType">
- <article id="api-EntitiesAndRelationships-getRelationshipsByType-0" data-group="User" data-name="getRelationshipsByType" data-version="0">
+ <div id="api-Groups-getAllGroups">
+ <article id="api-Groups-getAllGroups-0" data-group="User" data-name="getAllGroups" data-version="0">
<div class="pull-left">
- <h1>getRelationshipsByType</h1>
- <p>Get topology relationships of a specific relationship type name.</p>
+ <h1>getAllGroups</h1>
+ <p>Get all groups.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get topology relationships of a specific relationship type name.</p>
+ <p class="marked">Get all groups.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups</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-EntitiesAndRelationships-getRelationshipsByType-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-getAllGroups-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-getAllGroups-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-getAllGroups-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-getAllGroups-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-getAllGroups-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-getAllGroups-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-curl">
+ <div class="tab-pane active" id="examples-Groups-getAllGroups-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+ "https://localhost/topology-inventory/v1/groups?offset=56&limit=56&name=name_example"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-java">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
+ String name = name_example; // String | Group name. If not specified, returns all the groups.
try {
- RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
+ System.err.println("Exception when calling GroupsApi#getAllGroups");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
-final String relationshipTypeName = new String(); // String |
-final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.
+final String name = new String(); // String | Group name. If not specified, returns all the groups.
try {
- final result = await api_instance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ final result = await api_instance.getAllGroups(accept, offset, limit, name);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getRelationshipsByType: $e\n');
+ print('Exception when calling DefaultApi->getAllGroups: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
+ String name = name_example; // String | Group name. If not specified, returns all the groups.
try {
- RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
+ System.err.println("Exception when calling GroupsApi#getAllGroups");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *domainName = RAN; // domain name (default to null)
-String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // (default to null)
-String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)
+String *name = name_example; // Group name. If not specified, returns all the groups. (optional) (default to null)
-// Get topology relationships of a specific relationship type name.
-[apiInstance getRelationshipsByTypeWith:accept
- domainName:domainName
- relationshipTypeName:relationshipTypeName
- targetFilter:targetFilter
- scopeFilter:scopeFilter
+// Get all groups.
+[apiInstance getAllGroupsWith:accept
offset:offset
limit:limit
- completionHandler: ^(RelationshipsResponseMessage output, NSError* error) {
+ name:name
+ completionHandler: ^(GroupsResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String}
-var domainName = RAN; // {String} domain name
-var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String}
var opts = {
- 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
- 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
+ 'limit': 56, // {Integer} Result limiter.
+ 'name': name_example // {String} Group name. If not specified, returns all the groups.
};
var callback = function(error, data, response) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getRelationshipsByType(accept, domainName, relationshipTypeName, opts, callback);
+api.getAllGroups(accept, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-getAllGroups-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getRelationshipsByTypeExample
+ public class getAllGroupsExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new GroupsApi();
var accept = application/json; // String | (default to application/json)
- var domainName = RAN; // String | domain name (default to null)
- var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | (default to null)
- var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
- var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+ var name = name_example; // String | Group name. If not specified, returns all the groups. (optional) (default to null)
try {
- // Get topology relationships of a specific relationship type name.
- RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ // Get all groups.
+ GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipsByType: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.getAllGroups: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-php">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-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\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String |
-$domainName = RAN; // String | domain name
-$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
-$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.
+$name = name_example; // String | Group name. If not specified, returns all the groups.
try {
- $result = $api_instance->getRelationshipsByType($accept, $domainName, $relationshipTypeName, $targetFilter, $scopeFilter, $offset, $limit);
+ $result = $api_instance->getAllGroups($accept, $offset, $limit, $name);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->getAllGroups: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String |
-my $domainName = RAN; # String | domain name
-my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String |
-my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
-my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.
+my $name = name_example; # String | Group name. If not specified, returns all the groups.
eval {
- my $result = $api_instance->getRelationshipsByType(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ my $result = $api_instance->getAllGroups(accept => $accept, offset => $offset, limit => $limit, name => $name);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: $@\n";
+ warn "Exception when calling GroupsApi->getAllGroups: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-python">
+ <div class="tab-pane" id="examples-Groups-getAllGroups-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.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.GroupsApi()
accept = application/json # String | (default to application/json)
-domainName = RAN # String | domain name (default to null)
-relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String | (default to null)
-targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)
+name = name_example # String | Group name. If not specified, returns all the groups. (optional) (default to null)
try:
- # Get topology relationships of a specific relationship type name.
- api_response = api_instance.get_relationships_by_type(accept, domainName, relationshipTypeName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ # Get all groups.
+ api_response = api_instance.get_all_groups(accept, offset=offset, limit=limit, name=name)
pprint(api_response)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->getAllGroups: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getAllGroups-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
let accept = application/json; // String
- let domainName = RAN; // String
- let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
- let targetFilter = /sourceIds;/classifiers; // String
- let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
let offset = 56; // Integer
let limit = 56; // Integer
+ let name = name_example; // String
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
+ let mut context = GroupsApi::Context::default();
+ let result = client.getAllGroups(accept, offset, limit, name, &context).wait();
println!("{:?}", result);
}
</div>
<h2>Scopes</h2>
- <table>
-
- </table>
-
- <h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">relationshipTypeName*</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_relationshipTypeName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
- </table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<td>
- <div id="d2e199_getRelationshipsByType_accept">
+ <div id="d2e199_getAllGroups_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-Use *targetFilter* to specify what needs to be returned in the REST response.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">scopeFilter</td>
+ <tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getRelationshipsByType_scopeFilter">
+ <div id="d2e199_getAllGroups_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
</span>
<div class="inner description marked">
-ScopeFilter is used to specify the conditions to be applied.
+Pagination offset.
</div>
</div>
</div>
</td>
</tr>
- <tr><td style="width:150px;">offset</td>
+ <tr><td style="width:150px;">limit</td>
<td>
- <div id="d2e199_getRelationshipsByType_offset">
+ <div id="d2e199_getAllGroups_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</span>
<div class="inner description marked">
-Pagination offset.
+Result limiter.
</div>
</div>
</div>
</td>
</tr>
- <tr><td style="width:150px;">limit</td>
+ <tr><td style="width:150px;">name</td>
<td>
- <div id="d2e199_getRelationshipsByType_limit">
+ <div id="d2e199_getAllGroups_name">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- Integer
+ String
</span>
<div class="inner description marked">
-Result limiter.
+Group name. If not specified, returns all the groups.
</div>
</div>
</div>
</table>
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-200" class="marked"></p>
+ <h3 id="examples-Groups-getAllGroups-title-200"></h3>
+ <p id="examples-Groups-getAllGroups-description-200" class="marked"></p>
<script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ var responseGroups200_description = `OK`;
+ var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
+ if (responseGroups200_description_break == -1) {
+ $("#examples-Groups-getAllGroups-title-200").text("Status: 200 - " + responseGroups200_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-Groups-getAllGroups-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
+ $("#examples-Groups-getAllGroups-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getAllGroups-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getAllGroups-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getAllGroups-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getAllGroups-200-schema">
+ <div id="responses-Groups-getAllGroups-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/RelationshipsResponseMessage"
+ "$ref" : "#/components/schemas/GroupsResponse"
},
"examples" : {
- "relationships" : {
- "$ref" : "#/components/examples/RelationshipsResponseExample"
+ "groups" : {
+ "$ref" : "#/components/examples/GroupsResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-400" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-401" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-401" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-401" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Unauthorized",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-401');
+ $('#responses-Groups-getAllGroups-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getAllGroups-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getAllGroups-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-403" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ <h3 id="examples-Groups-getAllGroups-title-400"></h3>
+ <p id="examples-Groups-getAllGroups-description-400" class="marked"></p>
+ <script>
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-getAllGroups-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-getAllGroups-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-getAllGroups-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getAllGroups-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getAllGroups-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getAllGroups-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getAllGroups-400-schema">
+ <div id="responses-Groups-getAllGroups-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-403');
+ $('#responses-Groups-getAllGroups-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getAllGroups-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getAllGroups-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-500" class="marked"></p>
+ <h3 id="examples-Groups-getAllGroups-title-500"></h3>
+ <p id="examples-Groups-getAllGroups-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-getAllGroups-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-getAllGroups-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-getAllGroups-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getAllGroups-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getAllGroups-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getAllGroups-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getAllGroups-500-schema">
+ <div id="responses-Groups-getAllGroups-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-500');
+ $('#responses-Groups-getAllGroups-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getAllGroups-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getAllGroups-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyByEntityTypeName">
- <article id="api-EntitiesAndRelationships-getTopologyByEntityTypeName-0" data-group="User" data-name="getTopologyByEntityTypeName" data-version="0">
+ <div id="api-Groups-getGroupById">
+ <article id="api-Groups-getGroupById-0" data-group="User" data-name="getGroupById" data-version="0">
<div class="pull-left">
- <h1>getTopologyByEntityTypeName</h1>
- <p>Get all topology entities of a specific entity type.</p>
+ <h1>getGroupById</h1>
+ <p>Get a group with specified id.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all topology entities of a specific entity type.</p>
+ <p class="marked">Get a group with specified id.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}</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-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-getGroupById-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-getGroupById-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-getGroupById-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-getGroupById-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-getGroupById-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-getGroupById-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">
+ <div class="tab-pane active" id="examples-Groups-getGroupById-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
+ "https://localhost/topology-inventory/v1/groups/{groupId}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">
+ <div class="tab-pane" id="examples-Groups-getGroupById-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String groupId = groupId_example; // String |
try {
- EntitiesResponseMessage result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
+ System.err.println("Exception when calling GroupsApi#getGroupById");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
-final String entityTypeName = new String(); // String |
-final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
-final Integer offset = new Integer(); // Integer | Pagination offset.
-final Integer limit = new Integer(); // Integer | Result limiter.
+final String groupId = new String(); // String |
try {
- final result = await api_instance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ final result = await api_instance.getGroupById(accept, groupId);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyByEntityTypeName: $e\n');
+ print('Exception when calling DefaultApi->getGroupById: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
- String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String groupId = groupId_example; // String |
try {
- EntitiesResponseMessage result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
+ System.err.println("Exception when calling GroupsApi#getGroupById");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *domainName = RAN; // domain name (default to null)
-String *entityTypeName = entityTypeName_example; // (default to null)
-String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
-Integer *offset = 56; // Pagination offset. (optional) (default to 0)
-Integer *limit = 56; // Result limiter. (optional) (default to 500)
+String *groupId = groupId_example; // (default to null)
-// Get all topology entities of a specific entity type.
-[apiInstance getTopologyByEntityTypeNameWith:accept
- domainName:domainName
- entityTypeName:entityTypeName
- targetFilter:targetFilter
- scopeFilter:scopeFilter
- offset:offset
- limit:limit
- completionHandler: ^(EntitiesResponseMessage output, NSError* error) {
+// Get a group with specified id.
+[apiInstance getGroupByIdWith:accept
+ groupId:groupId
+ completionHandler: ^(GroupByIdResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String}
-var domainName = RAN; // {String} domain name
-var entityTypeName = entityTypeName_example; // {String}
-var opts = {
- 'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
- 'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
-};
+var groupId = groupId_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getTopologyByEntityTypeName(accept, domainName, entityTypeName, opts, callback);
+api.getGroupById(accept, groupId, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-getGroupById-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyByEntityTypeNameExample
+ public class getGroupByIdExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new GroupsApi();
var accept = application/json; // String | (default to application/json)
- var domainName = RAN; // String | domain name (default to null)
- var entityTypeName = entityTypeName_example; // String | (default to null)
- var targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
- var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
- var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
- var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+ var groupId = groupId_example; // String | (default to null)
try {
- // Get all topology entities of a specific entity type.
- EntitiesResponseMessage result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
+ // Get a group with specified id.
+ GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyByEntityTypeName: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.getGroupById: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">
+ <div class="tab-pane" id="examples-Groups-getGroupById-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\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String |
-$domainName = RAN; // String | domain name
-$entityTypeName = entityTypeName_example; // String |
-$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
-$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
+$groupId = groupId_example; // String |
try {
- $result = $api_instance->getTopologyByEntityTypeName($accept, $domainName, $entityTypeName, $targetFilter, $scopeFilter, $offset, $limit);
+ $result = $api_instance->getGroupById($accept, $groupId);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->getGroupById: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String |
-my $domainName = RAN; # String | domain name
-my $entityTypeName = entityTypeName_example; # String |
-my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
-my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
+my $groupId = groupId_example; # String |
eval {
- my $result = $api_instance->getTopologyByEntityTypeName(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
+ my $result = $api_instance->getGroupById(accept => $accept, groupId => $groupId);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: $@\n";
+ warn "Exception when calling GroupsApi->getGroupById: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">
+ <div class="tab-pane" id="examples-Groups-getGroupById-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.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.GroupsApi()
accept = application/json # String | (default to application/json)
-domainName = RAN # String | domain name (default to null)
-entityTypeName = entityTypeName_example # String | (default to null)
-targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
-scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
+groupId = groupId_example # String | (default to null)
try:
- # Get all topology entities of a specific entity type.
- api_response = api_instance.get_topology_by_entity_type_name(accept, domainName, entityTypeName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
+ # Get a group with specified id.
+ api_response = api_instance.get_group_by_id(accept, groupId)
pprint(api_response)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->getGroupById: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getGroupById-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
let accept = application/json; // String
- let domainName = RAN; // String
- let entityTypeName = entityTypeName_example; // String
- let targetFilter = /sourceIds;/classifiers; // String
- let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
+ let groupId = groupId_example; // String
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
+ let mut context = GroupsApi::Context::default();
+ let result = client.getGroupById(accept, groupId, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">entityTypeName*</td>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_getTopologyByEntityTypeName_entityTypeName">
+ <div id="d2e199_getGroupById_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getTopologyByEntityTypeName_accept">
+ <div id="d2e199_getGroupById_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-Use *targetFilter* to specify what needs to be returned in the REST response.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">scopeFilter</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_scopeFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-ScopeFilter is used to specify the conditions to be applied.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">offset</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">limit</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200" class="marked"></p>
+ <h3 id="examples-Groups-getGroupById-title-200"></h3>
+ <p id="examples-Groups-getGroupById-description-200" class="marked"></p>
<script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ var responseGroups200_description = `OK`;
+ var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
+ if (responseGroups200_description_break == -1) {
+ $("#examples-Groups-getGroupById-title-200").text("Status: 200 - " + responseGroups200_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-Groups-getGroupById-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
+ $("#examples-Groups-getGroupById-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getGroupById-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getGroupById-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getGroupById-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getGroupById-200-schema">
+ <div id="responses-Groups-getGroupById-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EntitiesResponseMessage"
- },
- "examples" : {
- "entities" : {
- "$ref" : "#/components/examples/EntitiesResponseExample"
- }
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/GroupByIdResponse"
},
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "examples" : {
+ "static" : {
+ "$ref" : "#/components/examples/StaticGroupResponseExample"
+ },
+ "dynamic" : {
+ "$ref" : "#/components/examples/DynamicGroupResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400');
+ $('#responses-Groups-getGroupById-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getGroupById-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getGroupById-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401" class="marked"></p>
+ <h3 id="examples-Groups-getGroupById-title-400"></h3>
+ <p id="examples-Groups-getGroupById-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-getGroupById-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Groups-getGroupById-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-getGroupById-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getGroupById-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getGroupById-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getGroupById-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getGroupById-400-schema">
+ <div id="responses-Groups-getGroupById-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401');
+ $('#responses-Groups-getGroupById-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getGroupById-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getGroupById-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403" class="marked"></p>
+ <h3 id="examples-Groups-getGroupById-title-404"></h3>
+ <p id="examples-Groups-getGroupById-description-404" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseGroups404_description = `Not Found`;
+ var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
+ if (responseGroups404_description_break == -1) {
+ $("#examples-Groups-getGroupById-title-404").text("Status: 404 - " + responseGroups404_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-getGroupById-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
+ $("#examples-Groups-getGroupById-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getGroupById-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getGroupById-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getGroupById-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getGroupById-404-schema">
+ <div id="responses-Groups-getGroupById-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403');
+ $('#responses-Groups-getGroupById-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getGroupById-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getGroupById-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500" class="marked"></p>
+ <h3 id="examples-Groups-getGroupById-title-500"></h3>
+ <p id="examples-Groups-getGroupById-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-getGroupById-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-getGroupById-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-getGroupById-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getGroupById-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getGroupById-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getGroupById-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getGroupById-500-schema">
+ <div id="responses-Groups-getGroupById-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500');
+ $('#responses-Groups-getGroupById-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getGroupById-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getGroupById-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyById">
- <article id="api-EntitiesAndRelationships-getTopologyById-0" data-group="User" data-name="getTopologyById" data-version="0">
+ <div id="api-Groups-getMembers">
+ <article id="api-Groups-getMembers-0" data-group="User" data-name="getMembers" data-version="0">
<div class="pull-left">
- <h1>getTopologyById</h1>
- <p>Get topology for entity type name with specified id. Specified id represents the entity instance.</p>
+ <h1>getMembers</h1>
+ <p>Get the members of a group with specified id.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get topology for entity type name with specified id. Specified id represents the entity instance.</p>
+ <p class="marked">Get the members of a group with specified id.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}/members</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-EntitiesAndRelationships-getTopologyById-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-getMembers-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-getMembers-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-getMembers-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-getMembers-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-getMembers-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-getMembers-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyById-0-curl">
+ <div class="tab-pane active" id="examples-Groups-getMembers-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/yang.data+json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}"
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1/groups/{groupId}/members?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-java">
+ <div class="tab-pane" id="examples-Groups-getMembers-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/yang.data+json; // String |
- String domainName = RAN; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String entityId = entityId_example; // String |
+ GroupsApi apiInstance = new GroupsApi();
+ String accept = application/json; // String |
+ String groupId = groupId_example; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
+ System.err.println("Exception when calling GroupsApi#getMembers");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-dart">
+ <div class="tab-pane" id="examples-Groups-getMembers-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
-final String entityTypeName = new String(); // String |
-final String entityId = new String(); // String |
+final String groupId = new String(); // String |
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
try {
- final result = await api_instance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ final result = await api_instance.getMembers(accept, groupId, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyById: $e\n');
+ print('Exception when calling DefaultApi->getMembers: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getMembers-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/yang.data+json; // String |
- String domainName = RAN; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String entityId = entityId_example; // String |
+ GroupsApi apiInstance = new GroupsApi();
+ String accept = application/json; // String |
+ String groupId = groupId_example; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
+ System.err.println("Exception when calling GroupsApi#getMembers");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-groovy">
+ <div class="tab-pane" id="examples-Groups-getMembers-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-objc">
+ <div class="tab-pane" id="examples-Groups-getMembers-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
-String *accept = application/yang.data+json; // (default to application/yang.data+json)
-String *domainName = RAN; // domain name (default to null)
-String *entityTypeName = entityTypeName_example; // (default to null)
-String *entityId = entityId_example; // (default to null)
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *groupId = groupId_example; // (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Get topology for entity type name with specified id. Specified id represents the entity instance.
-[apiInstance getTopologyByIdWith:accept
- domainName:domainName
- entityTypeName:entityTypeName
- entityId:entityId
- completionHandler: ^(Object output, NSError* error) {
+// Get the members of a group with specified id.
+[apiInstance getMembersWith:accept
+ groupId:groupId
+ offset:offset
+ limit:limit
+ completionHandler: ^(MembersResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-javascript">
+ <div class="tab-pane" id="examples-Groups-getMembers-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
-var accept = application/yang.data+json; // {String}
-var domainName = RAN; // {String} domain name
-var entityTypeName = entityTypeName_example; // {String}
-var entityId = entityId_example; // {String}
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
+var accept = application/json; // {String}
+var groupId = groupId_example; // {String}
+var opts = {
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getTopologyById(accept, domainName, entityTypeName, entityId, callback);
+api.getMembers(accept, groupId, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-getMembers-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-csharp">
+ <div class="tab-pane" id="examples-Groups-getMembers-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyByIdExample
+ public class getMembersExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
- var accept = application/yang.data+json; // String | (default to application/yang.data+json)
- var domainName = RAN; // String | domain name (default to null)
- var entityTypeName = entityTypeName_example; // String | (default to null)
- var entityId = entityId_example; // String | (default to null)
+ var apiInstance = new GroupsApi();
+ var accept = application/json; // String | (default to application/json)
+ var groupId = groupId_example; // String | (default to null)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Get topology for entity type name with specified id. Specified id represents the entity instance.
- Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ // Get the members of a group with specified id.
+ MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyById: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.getMembers: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-php">
+ <div class="tab-pane" id="examples-Groups-getMembers-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\EntitiesAndRelationshipsApi();
-$accept = application/yang.data+json; // String |
-$domainName = RAN; // String | domain name
-$entityTypeName = entityTypeName_example; // String |
-$entityId = entityId_example; // String |
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
+$accept = application/json; // String |
+$groupId = groupId_example; // String |
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
try {
- $result = $api_instance->getTopologyById($accept, $domainName, $entityTypeName, $entityId);
+ $result = $api_instance->getMembers($accept, $groupId, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyById: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->getMembers: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-perl">
+ <div class="tab-pane" id="examples-Groups-getMembers-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
-my $accept = application/yang.data+json; # String |
-my $domainName = RAN; # String | domain name
-my $entityTypeName = entityTypeName_example; # String |
-my $entityId = entityId_example; # String |
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
+my $accept = application/json; # String |
+my $groupId = groupId_example; # String |
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
eval {
- my $result = $api_instance->getTopologyById(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId);
+ my $result = $api_instance->getMembers(accept => $accept, groupId => $groupId, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyById: $@\n";
+ warn "Exception when calling GroupsApi->getMembers: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-python">
+ <div class="tab-pane" id="examples-Groups-getMembers-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.EntitiesAndRelationshipsApi()
-accept = application/yang.data+json # String | (default to application/yang.data+json)
-domainName = RAN # String | domain name (default to null)
-entityTypeName = entityTypeName_example # String | (default to null)
-entityId = entityId_example # String | (default to null)
+api_instance = openapi_client.GroupsApi()
+accept = application/json # String | (default to application/json)
+groupId = groupId_example # String | (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Get topology for entity type name with specified id. Specified id represents the entity instance.
- api_response = api_instance.get_topology_by_id(accept, domainName, entityTypeName, entityId)
+ # Get the members of a group with specified id.
+ api_response = api_instance.get_members(accept, groupId, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getTopologyById: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->getMembers: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getMembers-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
- let accept = application/yang.data+json; // String
- let domainName = RAN; // String
- let entityTypeName = entityTypeName_example; // String
- let entityId = entityId_example; // String
+ let accept = application/json; // String
+ let groupId = groupId_example; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyById(accept, domainName, entityTypeName, entityId, &context).wait();
+ let mut context = GroupsApi::Context::default();
+ let result = client.getMembers(accept, groupId, offset, limit, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domainName*</td>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_getTopologyById_domainName">
+ <div id="d2e199_getMembers_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
- <div class="inner description marked">
-domain name
- </div>
</div>
<div class="inner required">
Required
</td>
</tr>
- <tr><td style="width:150px;">entityTypeName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyById_entityTypeName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </table>
- <tr><td style="width:150px;">entityId*</td>
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getTopologyById_entityId">
+ <div id="d2e199_getMembers_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Header 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;">Accept*</td>
+ <tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getTopologyById_accept">
+ <div id="d2e199_getMembers_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
</span>
+ <div class="inner description marked">
+Pagination offset.
+ </div>
</div>
- <div class="inner required">
- Required
- </div>
</div>
</div>
</td>
</tr>
- </table>
-
-
-
-
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/yang.data+json" : {
- "schema" : {
- "type" : "object",
- "description" : "Refer to yang model for schema definition"
- },
- "examples" : {
- "entity" : {
- "$ref" : "#/components/examples/EntityResponseExample"
- }
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-400" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-400-schema">Schema</a>
- </li>
-
-
+ <tr><td style="width:150px;">limit</td>
+<td>
- </ul>
+ <div id="d2e199_getMembers_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
+ </table>
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-401" class="marked"></p>
+ <h2>Responses</h2>
+ <h3 id="examples-Groups-getMembers-title-200"></h3>
+ <p id="examples-Groups-getMembers-description-200" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseGroups200_description = `OK`;
+ var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
+ if (responseGroups200_description_break == -1) {
+ $("#examples-Groups-getMembers-title-200").text("Status: 200 - " + responseGroups200_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Groups-getMembers-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
+ $("#examples-Groups-getMembers-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getMembers-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getMembers-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getMembers-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getMembers-200-schema">
+ <div id="responses-Groups-getMembers-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "OK",
"content" : {
- "application/problem+json" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/MembersResponse"
},
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "examples" : {
+ "members" : {
+ "$ref" : "#/components/examples/MembersResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-401');
+ $('#responses-Groups-getMembers-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getMembers-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getMembers-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-403" class="marked"></p>
+ <h3 id="examples-Groups-getMembers-title-400"></h3>
+ <p id="examples-Groups-getMembers-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-getMembers-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-getMembers-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-getMembers-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getMembers-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getMembers-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getMembers-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getMembers-400-schema">
+ <div id="responses-Groups-getMembers-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-403');
+ $('#responses-Groups-getMembers-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getMembers-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getMembers-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-404"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-404" class="marked"></p>
+ <h3 id="examples-Groups-getMembers-title-404"></h3>
+ <p id="examples-Groups-getMembers-description-404" class="marked"></p>
<script>
- var responseEntitiesAndRelationships404_description = `Not Found`;
- var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
- if (responseEntitiesAndRelationships404_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ var responseGroups404_description = `Not Found`;
+ var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
+ if (responseGroups404_description_break == -1) {
+ $("#examples-Groups-getMembers-title-404").text("Status: 404 - " + responseGroups404_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ $("#examples-Groups-getMembers-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
+ $("#examples-Groups-getMembers-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getMembers-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getMembers-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-404-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getMembers-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getMembers-404-schema">
+ <div id="responses-Groups-getMembers-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-404');
+ $('#responses-Groups-getMembers-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getMembers-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getMembers-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-500" class="marked"></p>
+ <h3 id="examples-Groups-getMembers-title-500"></h3>
+ <p id="examples-Groups-getMembers-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-getMembers-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-getMembers-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-getMembers-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getMembers-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getMembers-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getMembers-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getMembers-500-schema">
+ <div id="responses-Groups-getMembers-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-500');
+ $('#responses-Groups-getMembers-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getMembers-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getMembers-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyEntityTypes">
- <article id="api-EntitiesAndRelationships-getTopologyEntityTypes-0" data-group="User" data-name="getTopologyEntityTypes" data-version="0">
+ <div id="api-Groups-getProvidedMembers">
+ <article id="api-Groups-getProvidedMembers-0" data-group="User" data-name="getProvidedMembers" data-version="0">
<div class="pull-left">
- <h1>getTopologyEntityTypes</h1>
- <p>Get all the available topology entity types in domain name.</p>
+ <h1>getProvidedMembers</h1>
+ <p>Get the provided members of a static group with specified id.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all the available topology entity types in domain name.</p>
+ <p class="marked">Get the provided members of a static group with specified id.</p>
<p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types</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-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">Rust</a></li>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}/provided-members</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-Groups-getProvidedMembers-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-getProvidedMembers-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-getProvidedMembers-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-getProvidedMembers-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">
+ <div class="tab-pane active" id="examples-Groups-getProvidedMembers-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types?offset=56&limit=56"
+ "https://localhost/topology-inventory/v1/groups/{groupId}/provided-members?status=status_example&offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
+ String groupId = groupId_example; // String |
+ String status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
+ System.err.println("Exception when calling GroupsApi#getProvidedMembers");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
+final String groupId = new String(); // String |
+final String status = new String(); // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.
try {
- final result = await api_instance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ final result = await api_instance.getProvidedMembers(accept, groupId, status, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyEntityTypes: $e\n');
+ print('Exception when calling DefaultApi->getProvidedMembers: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
- String domainName = RAN; // String | domain name
+ String groupId = groupId_example; // String |
+ String status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
+ System.err.println("Exception when calling GroupsApi#getProvidedMembers");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *domainName = RAN; // domain name (default to null)
+String *groupId = groupId_example; // (default to null)
+String *status = status_example; // Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Get all the available topology entity types in domain name.
-[apiInstance getTopologyEntityTypesWith:accept
- domainName:domainName
+// Get the provided members of a static group with specified id.
+[apiInstance getProvidedMembersWith:accept
+ groupId:groupId
+ status:status
offset:offset
limit:limit
- completionHandler: ^(EntityTypes output, NSError* error) {
+ completionHandler: ^(MembersResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String}
-var domainName = RAN; // {String} domain name
+var groupId = groupId_example; // {String}
var opts = {
+ 'status': status_example, // {String} Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
'offset': 56, // {Integer} Pagination offset.
'limit': 56 // {Integer} Result limiter.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getTopologyEntityTypes(accept, domainName, opts, callback);
+api.getProvidedMembers(accept, groupId, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-getProvidedMembers-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyEntityTypesExample
+ public class getProvidedMembersExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new GroupsApi();
var accept = application/json; // String | (default to application/json)
- var domainName = RAN; // String | domain name (default to null)
+ var groupId = groupId_example; // String | (default to null)
+ var status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Get all the available topology entity types in domain name.
- EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ // Get the provided members of a static group with specified id.
+ MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyEntityTypes: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.getProvidedMembers: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-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\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String |
-$domainName = RAN; // String | domain name
+$groupId = groupId_example; // String |
+$status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.
try {
- $result = $api_instance->getTopologyEntityTypes($accept, $domainName, $offset, $limit);
+ $result = $api_instance->getProvidedMembers($accept, $groupId, $status, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->getProvidedMembers: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String |
-my $domainName = RAN; # String | domain name
+my $groupId = groupId_example; # String |
+my $status = status_example; # String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.
eval {
- my $result = $api_instance->getTopologyEntityTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
+ my $result = $api_instance->getProvidedMembers(accept => $accept, groupId => $groupId, status => $status, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: $@\n";
+ warn "Exception when calling GroupsApi->getProvidedMembers: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-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.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.GroupsApi()
accept = application/json # String | (default to application/json)
-domainName = RAN # String | domain name (default to null)
+groupId = groupId_example # String | (default to null)
+status = status_example # String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Get all the available topology entity types in domain name.
- api_response = api_instance.get_topology_entity_types(accept, domainName, offset=offset, limit=limit)
+ # Get the provided members of a static group with specified id.
+ api_response = api_instance.get_provided_members(accept, groupId, status=status, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->getProvidedMembers: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
let accept = application/json; // String
- let domainName = RAN; // String
+ let groupId = groupId_example; // String
+ let status = status_example; // String
let offset = 56; // Integer
let limit = 56; // Integer
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyEntityTypes(accept, domainName, offset, limit, &context).wait();
+ let mut context = GroupsApi::Context::default();
+ let result = client.getProvidedMembers(accept, groupId, status, offset, limit, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domainName*</td>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_getTopologyEntityTypes_domainName">
+ <div id="d2e199_getProvidedMembers_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
- <div class="inner description marked">
-domain name
- </div>
</div>
<div class="inner required">
Required
<td>
- <div id="d2e199_getTopologyEntityTypes_accept">
+ <div id="d2e199_getProvidedMembers_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
+ <tr><td style="width:150px;">status</td>
+<td>
+
+
+ <div id="d2e199_getProvidedMembers_status">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
<tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getTopologyEntityTypes_offset">
+ <div id="d2e199_getProvidedMembers_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getTopologyEntityTypes_limit">
+ <div id="d2e199_getProvidedMembers_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/EntityTypes"
- },
- "examples" : {
- "entityTypes" : {
- "$ref" : "#/components/examples/EntityTypesResponseExample"
- }
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400" class="marked"></p>
+ <h2>Responses</h2>
+ <h3 id="examples-Groups-getProvidedMembers-title-200"></h3>
+ <p id="examples-Groups-getProvidedMembers-description-200" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseGroups200_description = `OK`;
+ var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
+ if (responseGroups200_description_break == -1) {
+ $("#examples-Groups-getProvidedMembers-title-200").text("Status: 200 - " + responseGroups200_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Groups-getProvidedMembers-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
+ $("#examples-Groups-getProvidedMembers-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getProvidedMembers-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getProvidedMembers-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getProvidedMembers-200-schema">
+ <div id="responses-Groups-getProvidedMembers-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "OK",
"content" : {
- "application/problem+json" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/MembersResponse"
},
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "examples" : {
+ "members" : {
+ "$ref" : "#/components/examples/ProvidedMembersResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400');
+ $('#responses-Groups-getProvidedMembers-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getProvidedMembers-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getProvidedMembers-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401" class="marked"></p>
+ <h3 id="examples-Groups-getProvidedMembers-title-400"></h3>
+ <p id="examples-Groups-getProvidedMembers-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-getProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Groups-getProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-getProvidedMembers-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getProvidedMembers-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getProvidedMembers-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getProvidedMembers-400-schema">
+ <div id="responses-Groups-getProvidedMembers-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401');
+ $('#responses-Groups-getProvidedMembers-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getProvidedMembers-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getProvidedMembers-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403" class="marked"></p>
+ <h3 id="examples-Groups-getProvidedMembers-title-404"></h3>
+ <p id="examples-Groups-getProvidedMembers-description-404" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseGroups404_description = `Not Found`;
+ var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
+ if (responseGroups404_description_break == -1) {
+ $("#examples-Groups-getProvidedMembers-title-404").text("Status: 404 - " + responseGroups404_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-getProvidedMembers-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
+ $("#examples-Groups-getProvidedMembers-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getProvidedMembers-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getProvidedMembers-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getProvidedMembers-404-schema">
+ <div id="responses-Groups-getProvidedMembers-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403');
+ $('#responses-Groups-getProvidedMembers-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getProvidedMembers-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getProvidedMembers-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500" class="marked"></p>
+ <h3 id="examples-Groups-getProvidedMembers-title-500"></h3>
+ <p id="examples-Groups-getProvidedMembers-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-getProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-getProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-getProvidedMembers-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-getProvidedMembers-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-getProvidedMembers-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-getProvidedMembers-500-schema">
+ <div id="responses-Groups-getProvidedMembers-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500');
+ $('#responses-Groups-getProvidedMembers-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-getProvidedMembers-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-getProvidedMembers-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyRelationshipTypes">
- <article id="api-EntitiesAndRelationships-getTopologyRelationshipTypes-0" data-group="User" data-name="getTopologyRelationshipTypes" data-version="0">
+ <div id="api-Groups-updateGroupName">
+ <article id="api-Groups-updateGroupName-0" data-group="User" data-name="updateGroupName" data-version="0">
<div class="pull-left">
- <h1>getTopologyRelationshipTypes</h1>
- <p>Get all the available topology relationship types.</p>
+ <h1>updateGroupName</h1>
+ <p>Update the name of a group.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all the available topology relationship types in a specified domain.</p>
+ <p class="marked">Update the name of a group.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/groups/{groupId}/name</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-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-updateGroupName-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-updateGroupName-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-updateGroupName-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-updateGroupName-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-updateGroupName-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-updateGroupName-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types?offset=56&limit=56"
+ <div class="tab-pane active" id="examples-Groups-updateGroupName-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://localhost/topology-inventory/v1/groups/{groupId}/name" \
+ -d '{
+ "name" : "name"
+}'
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-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.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.GroupsApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ GroupsApi apiInstance = new GroupsApi();
+ String contentType = application/json; // String |
+ String groupId = groupId_example; // String |
+ UpdateGroupNamePayload updateGroupNamePayload = ; // UpdateGroupNamePayload |
try {
- RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
- System.out.println(result);
+ apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
+ System.err.println("Exception when calling GroupsApi#updateGroupName");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final String accept = new String(); // String |
-final String domainName = new String(); // String | domain name
-final Integer offset = new Integer(); // Integer | Pagination offset.
-final Integer limit = new Integer(); // Integer | Result limiter.
+final String contentType = new String(); // String |
+final String groupId = new String(); // String |
+final UpdateGroupNamePayload updateGroupNamePayload = new UpdateGroupNamePayload(); // UpdateGroupNamePayload |
try {
- final result = await api_instance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
+ final result = await api_instance.updateGroupName(contentType, groupId, updateGroupNamePayload);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyRelationshipTypes: $e\n');
+ print('Exception when calling DefaultApi->updateGroupName: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-public class EntitiesAndRelationshipsApiExample {
+public class GroupsApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/json; // String |
- String domainName = RAN; // String | domain name
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ GroupsApi apiInstance = new GroupsApi();
+ String contentType = application/json; // String |
+ String groupId = groupId_example; // String |
+ UpdateGroupNamePayload updateGroupNamePayload = ; // UpdateGroupNamePayload |
try {
- RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
- System.out.println(result);
+ apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
+ System.err.println("Exception when calling GroupsApi#updateGroupName");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
-String *accept = application/json; // (default to application/json)
-String *domainName = RAN; // domain name (default to null)
-Integer *offset = 56; // Pagination offset. (optional) (default to 0)
-Integer *limit = 56; // Result limiter. (optional) (default to 500)
+GroupsApi *apiInstance = [[GroupsApi alloc] init];
+String *contentType = application/json; // (default to application/json)
+String *groupId = groupId_example; // (default to null)
+UpdateGroupNamePayload *updateGroupNamePayload = ; //
-// Get all the available topology relationship types.
-[apiInstance getTopologyRelationshipTypesWith:accept
- domainName:domainName
- offset:offset
- limit:limit
- completionHandler: ^(RelationshipTypes output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+// Update the name of a group.
+[apiInstance updateGroupNameWith:contentType
+ groupId:groupId
+ updateGroupNamePayload:updateGroupNamePayload
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
-var accept = application/json; // {String}
-var domainName = RAN; // {String} domain name
-var opts = {
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
-};
+var api = new TopologyExposureAndInventoryApi.GroupsApi()
+var contentType = application/json; // {String}
+var groupId = groupId_example; // {String}
+var updateGroupNamePayload = ; // {UpdateGroupNamePayload}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.getTopologyRelationshipTypes(accept, domainName, opts, callback);
+api.updateGroupName(contentType, groupId, updateGroupNamePayload, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-updateGroupName-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyRelationshipTypesExample
+ public class updateGroupNameExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
- var accept = application/json; // String | (default to application/json)
- var domainName = RAN; // String | domain name (default to null)
- var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
- var limit = 56; // Integer | Result limiter. (optional) (default to 500)
+ var apiInstance = new GroupsApi();
+ var contentType = application/json; // String | (default to application/json)
+ var groupId = groupId_example; // String | (default to null)
+ var updateGroupNamePayload = new UpdateGroupNamePayload(); // UpdateGroupNamePayload |
try {
- // Get all the available topology relationship types.
- RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
- Debug.WriteLine(result);
+ // Update the name of a group.
+ apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyRelationshipTypes: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.updateGroupName: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-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\EntitiesAndRelationshipsApi();
-$accept = application/json; // String |
-$domainName = RAN; // String | domain name
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
+$api_instance = new OpenAPITools\Client\Api\GroupsApi();
+$contentType = application/json; // String |
+$groupId = groupId_example; // String |
+$updateGroupNamePayload = ; // UpdateGroupNamePayload |
try {
- $result = $api_instance->getTopologyRelationshipTypes($accept, $domainName, $offset, $limit);
- print_r($result);
+ $api_instance->updateGroupName($contentType, $groupId, $updateGroupNamePayload);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->updateGroupName: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::GroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
-my $accept = application/json; # String |
-my $domainName = RAN; # String | domain name
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
+my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
+my $contentType = application/json; # String |
+my $groupId = groupId_example; # String |
+my $updateGroupNamePayload = WWW::OPenAPIClient::Object::UpdateGroupNamePayload->new(); # UpdateGroupNamePayload |
eval {
- my $result = $api_instance->getTopologyRelationshipTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
- print Dumper($result);
+ $api_instance->updateGroupName(contentType => $contentType, groupId => $groupId, updateGroupNamePayload => $updateGroupNamePayload);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: $@\n";
+ warn "Exception when calling GroupsApi->updateGroupName: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">
+ <div class="tab-pane" id="examples-Groups-updateGroupName-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.EntitiesAndRelationshipsApi()
-accept = application/json # String | (default to application/json)
-domainName = RAN # String | domain name (default to null)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
+api_instance = openapi_client.GroupsApi()
+contentType = application/json # String | (default to application/json)
+groupId = groupId_example # String | (default to null)
+updateGroupNamePayload = # UpdateGroupNamePayload |
try:
- # Get all the available topology relationship types.
- api_response = api_instance.get_topology_relationship_types(accept, domainName, offset=offset, limit=limit)
- pprint(api_response)
+ # Update the name of a group.
+ api_instance.update_group_name(contentType, groupId, updateGroupNamePayload)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->updateGroupName: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Groups-updateGroupName-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
- let accept = application/json; // String
- let domainName = RAN; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
+ let contentType = application/json; // String
+ let groupId = groupId_example; // String
+ let updateGroupNamePayload = ; // UpdateGroupNamePayload
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyRelationshipTypes(accept, domainName, offset, limit, &context).wait();
+ let mut context = GroupsApi::Context::default();
+ let result = client.updateGroupName(contentType, groupId, updateGroupNamePayload, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyRelationshipTypes_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_getTopologyRelationshipTypes_accept">
+ <div id="d2e199_updateGroupName_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- </table>
-
-
-
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">offset</td>
-<td>
-
-
- <div id="d2e199_getTopologyRelationshipTypes_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">limit</td>
-<td>
-
-
- <div id="d2e199_getTopologyRelationshipTypes_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">Schema</a>
- </li>
+ </table>
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Content-Type*</td>
+<td>
+ <div id="d2e199_updateGroupName_contentType">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
- </ul>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+ </table>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">updateGroupNamePayload <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/RelationshipTypes"
+ "$ref" : "#/components/schemas/UpdateGroupNamePayload"
},
"examples" : {
- "relationshipTypes" : {
- "$ref" : "#/components/examples/RelationshipTypesResponseExample"
+ "GroupNameUpdatePayload" : {
+ "$ref" : "#/components/examples/UpdateGroupNamePayloadExample"
}
}
}
- }
+ },
+ "required" : true
};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400" class="marked"></p>
+ 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,2,{isBodyParam: true});
+ var result = $('#d2e199_updateGroupName_updateGroupNamePayload');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_updateGroupName_updateGroupNamePayload"></div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-Groups-updateGroupName-title-204"></h3>
+ <p id="examples-Groups-updateGroupName-description-204" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseGroups204_description = `No Content`;
+ var responseGroups204_description_break = responseGroups204_description.indexOf('\n');
+ if (responseGroups204_description_break == -1) {
+ $("#examples-Groups-updateGroupName-title-204").text("Status: 204 - " + responseGroups204_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Groups-updateGroupName-title-204").text("Status: 204 - " + responseGroups204_description.substring(0, responseGroups204_description_break));
+ $("#examples-Groups-updateGroupName-description-204").html(responseGroups204_description.substring(responseGroups204_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-Groups-updateGroupName-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateGroupName-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateGroupName-204-schema">
+ <div id="responses-Groups-updateGroupName-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400');
+ $('#responses-Groups-updateGroupName-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateGroupName-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateGroupName-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401" class="marked"></p>
+ <h3 id="examples-Groups-updateGroupName-title-400"></h3>
+ <p id="examples-Groups-updateGroupName-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseGroups400_description = `Bad Request`;
+ var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
+ if (responseGroups400_description_break == -1) {
+ $("#examples-Groups-updateGroupName-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Groups-updateGroupName-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-updateGroupName-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-updateGroupName-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-updateGroupName-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateGroupName-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateGroupName-400-schema">
+ <div id="responses-Groups-updateGroupName-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401');
+ $('#responses-Groups-updateGroupName-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateGroupName-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateGroupName-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403" class="marked"></p>
+ <h3 id="examples-Groups-updateGroupName-title-404"></h3>
+ <p id="examples-Groups-updateGroupName-description-404" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseGroups404_description = `Not Found`;
+ var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
+ if (responseGroups404_description_break == -1) {
+ $("#examples-Groups-updateGroupName-title-404").text("Status: 404 - " + responseGroups404_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Groups-updateGroupName-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
+ $("#examples-Groups-updateGroupName-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-updateGroupName-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-updateGroupName-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateGroupName-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateGroupName-404-schema">
+ <div id="responses-Groups-updateGroupName-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403');
+ $('#responses-Groups-updateGroupName-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateGroupName-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateGroupName-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500" class="marked"></p>
+ <h3 id="examples-Groups-updateGroupName-title-500"></h3>
+ <p id="examples-Groups-updateGroupName-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseGroups500_description = `Internal Server Error`;
+ var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
+ if (responseGroups500_description_break == -1) {
+ $("#examples-Groups-updateGroupName-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Groups-updateGroupName-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-updateGroupName-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-updateGroupName-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-updateGroupName-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateGroupName-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateGroupName-500-schema">
+ <div id="responses-Groups-updateGroupName-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500');
+ $('#responses-Groups-updateGroupName-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateGroupName-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateGroupName-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-Groups">
- <h1>Groups</h1>
- <div id="api-Groups-createGroup">
- <article id="api-Groups-createGroup-0" data-group="User" data-name="createGroup" data-version="0">
+ <div id="api-Groups-updateProvidedMembers">
+ <article id="api-Groups-updateProvidedMembers-0" data-group="User" data-name="updateProvidedMembers" data-version="0">
<div class="pull-left">
- <h1>createGroup</h1>
- <p>Create a new group.</p>
+ <h1>updateProvidedMembers</h1>
+ <p>Merge or remove members of a static group.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Create a group of entities and/or relationships in a static or dynamic way.</p>
+ <p class="marked">Merge or remove members in an existing topology group. This operation is applicable for static group only.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/groups</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/groups/{groupId}/provided-members-operations</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-Groups-createGroup-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-createGroup-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-createGroup-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-createGroup-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-createGroup-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-createGroup-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Groups-updateProvidedMembers-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-java">Java</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Groups-updateProvidedMembers-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Groups-updateProvidedMembers-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-python">Python</a></li>
+ <li class=""><a href="#examples-Groups-updateProvidedMembers-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-createGroup-0-curl">
+ <div class="tab-pane active" id="examples-Groups-updateProvidedMembers-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/json,application/problem+json" \
+ -H "Accept: application/problem+json" \
-H "Content-Type: application/json" \
- "https://localhost/topology-inventory/v1alpha11/groups" \
+ "https://localhost/topology-inventory/v1/groups/{groupId}/provided-members-operations" \
-d '{
- "name" : "name",
"providedMembers" : [ "{}", "{}" ],
- "type" : "type"
+ "operation" : "merge"
}'
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-java">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
String contentType = application/json; // String |
- CreateGroupPayload createGroupPayload = ; // CreateGroupPayload |
+ String groupId = groupId_example; // String |
+ UpdateProvidedMembersPayload updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload |
try {
- GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
- System.out.println(result);
+ apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#createGroup");
+ System.err.println("Exception when calling GroupsApi#updateProvidedMembers");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-dart">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
final String contentType = new String(); // String |
-final CreateGroupPayload createGroupPayload = new CreateGroupPayload(); // CreateGroupPayload |
+final String groupId = new String(); // String |
+final UpdateProvidedMembersPayload updateProvidedMembersPayload = new UpdateProvidedMembersPayload(); // UpdateProvidedMembersPayload |
try {
- final result = await api_instance.createGroup(accept, contentType, createGroupPayload);
+ final result = await api_instance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->createGroup: $e\n');
+ print('Exception when calling DefaultApi->updateProvidedMembers: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-android">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
public class GroupsApiExample {
GroupsApi apiInstance = new GroupsApi();
String accept = application/json; // String |
String contentType = application/json; // String |
- CreateGroupPayload createGroupPayload = ; // CreateGroupPayload |
+ String groupId = groupId_example; // String |
+ UpdateProvidedMembersPayload updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload |
try {
- GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
- System.out.println(result);
+ apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#createGroup");
+ System.err.println("Exception when calling GroupsApi#updateProvidedMembers");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Groups-createGroup-0-groovy">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Groups-createGroup-0-objc">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
String *contentType = application/json; // (default to application/json)
-CreateGroupPayload *createGroupPayload = ; //
+String *groupId = groupId_example; // (default to null)
+UpdateProvidedMembersPayload *updateProvidedMembersPayload = ; //
-// Create a new group.
-[apiInstance createGroupWith:accept
+// Merge or remove members of a static group.
+[apiInstance updateProvidedMembersWith:accept
contentType:contentType
- createGroupPayload:createGroupPayload
- completionHandler: ^(GroupByIdResponse output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+ groupId:groupId
+ updateProvidedMembersPayload:updateProvidedMembersPayload
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-javascript">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String}
var contentType = application/json; // {String}
-var createGroupPayload = ; // {CreateGroupPayload}
+var groupId = groupId_example; // {String}
+var updateProvidedMembersPayload = ; // {UpdateProvidedMembersPayload}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.createGroup(accept, contentType, createGroupPayload, callback);
+api.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Groups-createGroup-0-angular">
+ <!--<div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Groups-createGroup-0-csharp">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class createGroupExample
+ public class updateProvidedMembersExample
{
public void main()
{
var apiInstance = new GroupsApi();
var accept = application/json; // String | (default to application/json)
var contentType = application/json; // String | (default to application/json)
- var createGroupPayload = new CreateGroupPayload(); // CreateGroupPayload |
+ var groupId = groupId_example; // String | (default to null)
+ var updateProvidedMembersPayload = new UpdateProvidedMembersPayload(); // UpdateProvidedMembersPayload |
try {
- // Create a new group.
- GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
- Debug.WriteLine(result);
+ // Merge or remove members of a static group.
+ apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
} catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.createGroup: " + e.Message );
+ Debug.Print("Exception when calling GroupsApi.updateProvidedMembers: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-php">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String |
$contentType = application/json; // String |
-$createGroupPayload = ; // CreateGroupPayload |
+$groupId = groupId_example; // String |
+$updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload |
try {
- $result = $api_instance->createGroup($accept, $contentType, $createGroupPayload);
- print_r($result);
+ $api_instance->updateProvidedMembers($accept, $contentType, $groupId, $updateProvidedMembersPayload);
} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->createGroup: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling GroupsApi->updateProvidedMembers: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-perl">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String |
my $contentType = application/json; # String |
-my $createGroupPayload = WWW::OPenAPIClient::Object::CreateGroupPayload->new(); # CreateGroupPayload |
+my $groupId = groupId_example; # String |
+my $updateProvidedMembersPayload = WWW::OPenAPIClient::Object::UpdateProvidedMembersPayload->new(); # UpdateProvidedMembersPayload |
eval {
- my $result = $api_instance->createGroup(accept => $accept, contentType => $contentType, createGroupPayload => $createGroupPayload);
- print Dumper($result);
+ $api_instance->updateProvidedMembers(accept => $accept, contentType => $contentType, groupId => $groupId, updateProvidedMembersPayload => $updateProvidedMembersPayload);
};
if ($@) {
- warn "Exception when calling GroupsApi->createGroup: $@\n";
+ warn "Exception when calling GroupsApi->updateProvidedMembers: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-python">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
api_instance = openapi_client.GroupsApi()
accept = application/json # String | (default to application/json)
contentType = application/json # String | (default to application/json)
-createGroupPayload = # CreateGroupPayload |
+groupId = groupId_example # String | (default to null)
+updateProvidedMembersPayload = # UpdateProvidedMembersPayload |
try:
- # Create a new group.
- api_response = api_instance.create_group(accept, contentType, createGroupPayload)
- pprint(api_response)
+ # Merge or remove members of a static group.
+ api_instance.update_provided_members(accept, contentType, groupId, updateProvidedMembersPayload)
except ApiException as e:
- print("Exception when calling GroupsApi->createGroup: %s\n" % e)</code></pre>
+ print("Exception when calling GroupsApi->updateProvidedMembers: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-createGroup-0-rust">
+ <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-rust">
<pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
pub fn main() {
let accept = application/json; // String
let contentType = application/json; // String
- let createGroupPayload = ; // CreateGroupPayload
+ let groupId = groupId_example; // String
+ let updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload
let mut context = GroupsApi::Context::default();
- let result = client.createGroup(accept, contentType, createGroupPayload, &context).wait();
+ let result = client.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">groupId*</td>
+<td>
+
+
+ <div id="d2e199_updateProvidedMembers_groupId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<td>
- <div id="d2e199_createGroup_accept">
+ <div id="d2e199_updateProvidedMembers_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_createGroup_contentType">
+ <div id="d2e199_updateProvidedMembers_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">createGroupPayload <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">updateProvidedMembersPayload <span style="color:red;">*</span></td>
<td>
<p class="marked"></p>
<script>
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/CreateGroupPayload"
+ "$ref" : "#/components/schemas/UpdateProvidedMembersPayload"
},
"examples" : {
- "staticGroup" : {
- "$ref" : "#/components/examples/CreateStaticGroupPayloadExample"
+ "mergeMembersPayload" : {
+ "$ref" : "#/components/examples/MergeProvidedMembersPayloadExample"
},
- "dynamicGroup" : {
- "$ref" : "#/components/examples/CreateDynamicGroupGetEntitiesByDomainPayloadExample"
+ "deleteMembersPayload" : {
+ "$ref" : "#/components/examples/RemoveProvidedMembersPayloadExample"
}
}
}
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_createGroup_createGroupPayload');
+ var result = $('#d2e199_updateProvidedMembers_updateProvidedMembersPayload');
result.empty();
result.append(view.render());
});
</script>
-<div id="d2e199_createGroup_createGroupPayload"></div>
+<div id="d2e199_updateProvidedMembers_updateProvidedMembersPayload"></div>
</td>
</tr>
<h2>Responses</h2>
- <h3 id="examples-Groups-createGroup-title-201"></h3>
- <p id="examples-Groups-createGroup-description-201" class="marked"></p>
+ <h3 id="examples-Groups-updateProvidedMembers-title-204"></h3>
+ <p id="examples-Groups-updateProvidedMembers-description-204" class="marked"></p>
<script>
- var responseGroups201_description = `Created`;
- var responseGroups201_description_break = responseGroups201_description.indexOf('\n');
- if (responseGroups201_description_break == -1) {
- $("#examples-Groups-createGroup-title-201").text("Status: 201 - " + responseGroups201_description);
+ var responseGroups204_description = `No Content`;
+ var responseGroups204_description_break = responseGroups204_description.indexOf('\n');
+ if (responseGroups204_description_break == -1) {
+ $("#examples-Groups-updateProvidedMembers-title-204").text("Status: 204 - " + responseGroups204_description);
} else {
- $("#examples-Groups-createGroup-title-201").text("Status: 201 - " + responseGroups201_description.substring(0, responseGroups201_description_break));
- $("#examples-Groups-createGroup-description-201").html(responseGroups201_description.substring(responseGroups201_description_break));
+ $("#examples-Groups-updateProvidedMembers-title-204").text("Status: 204 - " + responseGroups204_description.substring(0, responseGroups204_description_break));
+ $("#examples-Groups-updateProvidedMembers-description-204").html(responseGroups204_description.substring(responseGroups204_description_break));
}
</script>
- <ul id="responses-detail-Groups-createGroup-201" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Groups-createGroup-201-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-Groups-updateProvidedMembers-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-Groups-createGroup-201-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-createGroup-201-schema">
- <div id="responses-Groups-createGroup-schema-201" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateProvidedMembers-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateProvidedMembers-204-schema">
+ <div id="responses-Groups-updateProvidedMembers-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Created",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/GroupByIdResponse"
- },
- "examples" : {
- "static" : {
- "$ref" : "#/components/examples/StaticGroupResponseExample"
- },
- "dynamic" : {
- "$ref" : "#/components/examples/DynamicGroupResponseExample"
- }
- }
- }
- }
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-createGroup-201-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-createGroup-schema-201');
+ $('#responses-Groups-updateProvidedMembers-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateProvidedMembers-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-createGroup-201-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateProvidedMembers-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-createGroup-title-400"></h3>
- <p id="examples-Groups-createGroup-description-400" class="marked"></p>
+ <h3 id="examples-Groups-updateProvidedMembers-title-400"></h3>
+ <p id="examples-Groups-updateProvidedMembers-description-400" class="marked"></p>
<script>
var responseGroups400_description = `Bad Request`;
var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
if (responseGroups400_description_break == -1) {
- $("#examples-Groups-createGroup-title-400").text("Status: 400 - " + responseGroups400_description);
+ $("#examples-Groups-updateProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description);
} else {
- $("#examples-Groups-createGroup-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-createGroup-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Groups-updateProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
+ $("#examples-Groups-updateProvidedMembers-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
}
</script>
- <ul id="responses-detail-Groups-createGroup-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-updateProvidedMembers-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-createGroup-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-updateProvidedMembers-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-createGroup-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-createGroup-400-schema">
- <div id="responses-Groups-createGroup-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateProvidedMembers-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateProvidedMembers-400-schema">
+ <div id="responses-Groups-updateProvidedMembers-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-createGroup-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-createGroup-schema-400');
+ $('#responses-Groups-updateProvidedMembers-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateProvidedMembers-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-createGroup-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateProvidedMembers-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-createGroup-title-500"></h3>
- <p id="examples-Groups-createGroup-description-500" class="marked"></p>
+ <h3 id="examples-Groups-updateProvidedMembers-title-500"></h3>
+ <p id="examples-Groups-updateProvidedMembers-description-500" class="marked"></p>
<script>
var responseGroups500_description = `Internal Server Error`;
var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
if (responseGroups500_description_break == -1) {
- $("#examples-Groups-createGroup-title-500").text("Status: 500 - " + responseGroups500_description);
+ $("#examples-Groups-updateProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description);
} else {
- $("#examples-Groups-createGroup-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-createGroup-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Groups-updateProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
+ $("#examples-Groups-updateProvidedMembers-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
}
</script>
- <ul id="responses-detail-Groups-createGroup-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Groups-updateProvidedMembers-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-createGroup-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Groups-updateProvidedMembers-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-createGroup-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-createGroup-500-schema">
- <div id="responses-Groups-createGroup-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Groups-updateProvidedMembers-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Groups-updateProvidedMembers-500-schema">
+ <div id="responses-Groups-updateProvidedMembers-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-createGroup-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-createGroup-schema-500');
+ $('#responses-Groups-updateProvidedMembers-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Groups-updateProvidedMembers-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-createGroup-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Groups-updateProvidedMembers-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Groups-deleteGroup">
- <article id="api-Groups-deleteGroup-0" data-group="User" data-name="deleteGroup" data-version="0">
+ </section>
+ <section id="api-Schemas">
+ <h1>Schemas</h1>
+ <div id="api-Schemas-createSchema">
+ <article id="api-Schemas-createSchema-0" data-group="User" data-name="createSchema" data-version="0">
<div class="pull-left">
- <h1>deleteGroup</h1>
- <p>Delete a group with specified id.</p>
+ <h1>createSchema</h1>
+ <p>Create a new schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Delete a group with specified id.</p>
+ <p class="marked">Create a new schema. The request body contains the schema in YANG format.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/groups/{groupId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/schemas</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-Groups-deleteGroup-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-deleteGroup-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-deleteGroup-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-deleteGroup-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-deleteGroup-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-deleteGroup-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-createSchema-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-createSchema-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-createSchema-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-createSchema-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-createSchema-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-deleteGroup-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
+ <div class="tab-pane active" id="examples-Schemas-createSchema-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
-H "Accept: application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/groups/{groupId}"
+ -H "Content-Type: multipart/form-data" \
+ "https://localhost/topology-inventory/v1/schemas"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-java">
+ <div class="tab-pane" id="examples-Schemas-createSchema-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.GroupsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
- String groupId = groupId_example; // String |
+ SchemasApi apiInstance = new SchemasApi();
+ String accept = application/json; // String |
+ String contentType = multipart/form-data; // String |
+ File file = BINARY_DATA_HERE; // File | multipartFile
try {
- apiInstance.deleteGroup(groupId);
+ apiInstance.createSchema(accept, contentType, file);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#deleteGroup");
+ System.err.println("Exception when calling SchemasApi#createSchema");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-dart">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final String groupId = new String(); // String |
+final String accept = new String(); // String |
+final String contentType = new String(); // String |
+final File file = new File(); // File | multipartFile
try {
- final result = await api_instance.deleteGroup(groupId);
+ final result = await api_instance.createSchema(accept, contentType, file);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->deleteGroup: $e\n');
+ print('Exception when calling DefaultApi->createSchema: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
- String groupId = groupId_example; // String |
+ SchemasApi apiInstance = new SchemasApi();
+ String accept = application/json; // String |
+ String contentType = multipart/form-data; // String |
+ File file = BINARY_DATA_HERE; // File | multipartFile
try {
- apiInstance.deleteGroup(groupId);
+ apiInstance.createSchema(accept, contentType, file);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#deleteGroup");
+ System.err.println("Exception when calling SchemasApi#createSchema");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-objc">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
-String *groupId = groupId_example; // (default to null)
+SchemasApi *apiInstance = [[SchemasApi alloc] init];
+String *accept = application/json; // (default to application/json)
+String *contentType = multipart/form-data; // (default to multipart/form-data)
+File *file = BINARY_DATA_HERE; // multipartFile (default to null)
-// Delete a group with specified id.
-[apiInstance deleteGroupWith:groupId
+// Create a new schema.
+[apiInstance createSchemaWith:accept
+ contentType:contentType
+ file:file
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-javascript">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
-var groupId = groupId_example; // {String}
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
+var accept = application/json; // {String}
+var contentType = multipart/form-data; // {String}
+var file = BINARY_DATA_HERE; // {File} multipartFile
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully.');
}
};
-api.deleteGroup(groupId, callback);
+api.createSchema(accept, contentType, file, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Groups-deleteGroup-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-createSchema-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class deleteGroupExample
+ public class createSchemaExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new GroupsApi();
- var groupId = groupId_example; // String | (default to null)
+ var apiInstance = new SchemasApi();
+ var accept = application/json; // String | (default to application/json)
+ var contentType = multipart/form-data; // String | (default to multipart/form-data)
+ var file = BINARY_DATA_HERE; // File | multipartFile (default to null)
try {
- // Delete a group with specified id.
- apiInstance.deleteGroup(groupId);
+ // Create a new schema.
+ apiInstance.createSchema(accept, contentType, file);
} catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.deleteGroup: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.createSchema: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-php">
+ <div class="tab-pane" id="examples-Schemas-createSchema-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\GroupsApi();
-$groupId = groupId_example; // String |
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
+$accept = application/json; // String |
+$contentType = multipart/form-data; // String |
+$file = BINARY_DATA_HERE; // File | multipartFile
try {
- $api_instance->deleteGroup($groupId);
+ $api_instance->createSchema($accept, $contentType, $file);
} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->createSchema: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-perl">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
-my $groupId = groupId_example; # String |
+my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $accept = application/json; # String |
+my $contentType = multipart/form-data; # String |
+my $file = BINARY_DATA_HERE; # File | multipartFile
eval {
- $api_instance->deleteGroup(groupId => $groupId);
+ $api_instance->createSchema(accept => $accept, contentType => $contentType, file => $file);
};
if ($@) {
- warn "Exception when calling GroupsApi->deleteGroup: $@\n";
+ warn "Exception when calling SchemasApi->createSchema: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-python">
+ <div class="tab-pane" id="examples-Schemas-createSchema-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.GroupsApi()
-groupId = groupId_example # String | (default to null)
+api_instance = openapi_client.SchemasApi()
+accept = application/json # String | (default to application/json)
+contentType = multipart/form-data # String | (default to multipart/form-data)
+file = BINARY_DATA_HERE # File | multipartFile (default to null)
try:
- # Delete a group with specified id.
- api_instance.delete_group(groupId)
+ # Create a new schema.
+ api_instance.create_schema(accept, contentType, file)
except ApiException as e:
- print("Exception when calling GroupsApi->deleteGroup: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->createSchema: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-deleteGroup-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
- let groupId = groupId_example; // String
+ let accept = application/json; // String
+ let contentType = multipart/form-data; // String
+ let file = BINARY_DATA_HERE; // File
- let mut context = GroupsApi::Context::default();
- let result = client.deleteGroup(groupId, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.createSchema(accept, contentType, file, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
+
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">groupId*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_deleteGroup_groupId">
+ <div id="d2e199_createSchema_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">Content-Type*</td>
+<td>
+
+
+ <div id="d2e199_createSchema_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
+ <div class="methodsubtabletitle">Form parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">file*</td>
+<td>
+
+
+ <div id="d2e199_createSchema_file">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ File
+ </span>
+ <span class="format">
+ (binary)
+ </span>
+
+ <div class="inner description marked">
+multipartFile
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+ </table>
<h2>Responses</h2>
- <h3 id="examples-Groups-deleteGroup-title-204"></h3>
- <p id="examples-Groups-deleteGroup-description-204" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-201"></h3>
+ <p id="examples-Schemas-createSchema-description-201" class="marked"></p>
<script>
- var responseGroups204_description = `No Content`;
- var responseGroups204_description_break = responseGroups204_description.indexOf('\n');
- if (responseGroups204_description_break == -1) {
- $("#examples-Groups-deleteGroup-title-204").text("Status: 204 - " + responseGroups204_description);
+ var responseSchemas201_description = `Created without response body`;
+ var responseSchemas201_description_break = responseSchemas201_description.indexOf('\n');
+ if (responseSchemas201_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description);
} else {
- $("#examples-Groups-deleteGroup-title-204").text("Status: 204 - " + responseGroups204_description.substring(0, responseGroups204_description_break));
- $("#examples-Groups-deleteGroup-description-204").html(responseGroups204_description.substring(responseGroups204_description_break));
+ $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description.substring(0, responseSchemas201_description_break));
+ $("#examples-Schemas-createSchema-description-201").html(responseSchemas201_description.substring(responseSchemas201_description_break));
}
</script>
- <ul id="responses-detail-Groups-deleteGroup-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-201" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Schemas-createSchema-201-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-201-schema">
+ <div id="responses-Schemas-createSchema-schema-201" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Created without response body"
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-createSchema-201-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-201');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-createSchema-201-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-createSchema-title-400"></h3>
+ <p id="examples-Schemas-createSchema-description-400" class="marked"></p>
+ <script>
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
+ } else {
+ $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-createSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Schemas-createSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Schemas-createSchema-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-400-schema">
+ <div id="responses-Schemas-createSchema-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-createSchema-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-createSchema-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-createSchema-title-401"></h3>
+ <p id="examples-Schemas-createSchema-description-401" class="marked"></p>
+ <script>
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
+ } else {
+ $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-createSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Schemas-createSchema-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-401-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Groups-deleteGroup-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-deleteGroup-204-schema">
- <div id="responses-Groups-deleteGroup-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-401-schema">
+ <div id="responses-Schemas-createSchema-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-deleteGroup-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-deleteGroup-schema-204');
+ $('#responses-Schemas-createSchema-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-deleteGroup-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-deleteGroup-title-400"></h3>
- <p id="examples-Groups-deleteGroup-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-403"></h3>
+ <p id="examples-Schemas-createSchema-description-403" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-deleteGroup-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
} else {
- $("#examples-Groups-deleteGroup-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-deleteGroup-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-createSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
}
</script>
- <ul id="responses-detail-Groups-deleteGroup-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-deleteGroup-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-deleteGroup-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-deleteGroup-400-schema">
- <div id="responses-Groups-deleteGroup-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-403-schema">
+ <div id="responses-Schemas-createSchema-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-deleteGroup-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-deleteGroup-schema-400');
+ $('#responses-Schemas-createSchema-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-deleteGroup-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-deleteGroup-title-404"></h3>
- <p id="examples-Groups-deleteGroup-description-404" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-409"></h3>
+ <p id="examples-Schemas-createSchema-description-409" class="marked"></p>
<script>
- var responseGroups404_description = `Not Found`;
- var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
- if (responseGroups404_description_break == -1) {
- $("#examples-Groups-deleteGroup-title-404").text("Status: 404 - " + responseGroups404_description);
+ var responseSchemas409_description = `Conflict`;
+ var responseSchemas409_description_break = responseSchemas409_description.indexOf('\n');
+ if (responseSchemas409_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description);
} else {
- $("#examples-Groups-deleteGroup-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
- $("#examples-Groups-deleteGroup-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
+ $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description.substring(0, responseSchemas409_description_break));
+ $("#examples-Schemas-createSchema-description-409").html(responseSchemas409_description.substring(responseSchemas409_description_break));
}
</script>
- <ul id="responses-detail-Groups-deleteGroup-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-409" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-deleteGroup-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-409-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-deleteGroup-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-deleteGroup-404-schema">
- <div id="responses-Groups-deleteGroup-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-409-schema">
+ <div id="responses-Schemas-createSchema-schema-409" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Conflict",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
+ "status" : "409",
+ "title" : "Conflicting request",
+ "details" : "The request cannot be processed as the resource is in use."
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-deleteGroup-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-deleteGroup-schema-404');
+ $('#responses-Schemas-createSchema-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-409');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-deleteGroup-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-409-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-deleteGroup-title-500"></h3>
- <p id="examples-Groups-deleteGroup-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-500"></h3>
+ <p id="examples-Schemas-createSchema-description-500" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-deleteGroup-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-Groups-deleteGroup-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-deleteGroup-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-createSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Groups-deleteGroup-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-deleteGroup-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-deleteGroup-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-deleteGroup-500-schema">
- <div id="responses-Groups-deleteGroup-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-500-schema">
+ <div id="responses-Schemas-createSchema-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-deleteGroup-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-deleteGroup-schema-500');
+ $('#responses-Schemas-createSchema-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-deleteGroup-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Groups-getAllGroups">
- <article id="api-Groups-getAllGroups-0" data-group="User" data-name="getAllGroups" data-version="0">
+ <div id="api-Schemas-deleteSchema">
+ <article id="api-Schemas-deleteSchema-0" data-group="User" data-name="deleteSchema" data-version="0">
<div class="pull-left">
- <h1>getAllGroups</h1>
- <p>Get all groups.</p>
+ <h1>deleteSchema</h1>
+ <p>Delete a schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all groups.</p>
+ <p class="marked">Delete a schema.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/schemas/{schemaName}</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-Groups-getAllGroups-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-getAllGroups-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-getAllGroups-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-getAllGroups-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-getAllGroups-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-getAllGroups-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-deleteSchema-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-getAllGroups-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/groups?offset=56&limit=56&name=name_example"
+ <div class="tab-pane active" id="examples-Schemas-deleteSchema-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://localhost/topology-inventory/v1/schemas/{schemaName}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-java">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-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.GroupsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
- String name = name_example; // String | Group name. If not specified, returns all the groups.
+ String schemaName = schemaName_example; // String |
try {
- GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
- System.out.println(result);
+ apiInstance.deleteSchema(accept, schemaName);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getAllGroups");
+ System.err.println("Exception when calling SchemasApi#deleteSchema");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-dart">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final Integer offset = new Integer(); // Integer | Pagination offset.
-final Integer limit = new Integer(); // Integer | Result limiter.
-final String name = new String(); // String | Group name. If not specified, returns all the groups.
+final String schemaName = new String(); // String |
try {
- final result = await api_instance.getAllGroups(accept, offset, limit, name);
+ final result = await api_instance.deleteSchema(accept, schemaName);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getAllGroups: $e\n');
+ print('Exception when calling DefaultApi->deleteSchema: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
- String name = name_example; // String | Group name. If not specified, returns all the groups.
+ String schemaName = schemaName_example; // String |
try {
- GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
- System.out.println(result);
+ apiInstance.deleteSchema(accept, schemaName);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getAllGroups");
+ System.err.println("Exception when calling SchemasApi#deleteSchema");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-objc">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
+SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = application/json; // (default to application/json)
-Integer *offset = 56; // Pagination offset. (optional) (default to 0)
-Integer *limit = 56; // Result limiter. (optional) (default to 500)
-String *name = name_example; // Group name. If not specified, returns all the groups. (optional) (default to null)
+String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
-// Get all groups.
-[apiInstance getAllGroupsWith:accept
- offset:offset
- limit:limit
- name:name
- completionHandler: ^(GroupsResponse output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+// Delete a schema.
+[apiInstance deleteSchemaWith:accept
+ schemaName:schemaName
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-javascript">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String}
-var opts = {
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56, // {Integer} Result limiter.
- 'name': name_example // {String} Group name. If not specified, returns all the groups.
-};
+var schemaName = schemaName_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.getAllGroups(accept, opts, callback);
+api.deleteSchema(accept, schemaName, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Groups-getAllGroups-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-deleteSchema-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getAllGroupsExample
+ public class deleteSchemaExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new GroupsApi();
+ var apiInstance = new SchemasApi();
var accept = application/json; // String | (default to application/json)
- var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
- var limit = 56; // Integer | Result limiter. (optional) (default to 500)
- var name = name_example; // String | Group name. If not specified, returns all the groups. (optional) (default to null)
+ var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
try {
- // Get all groups.
- GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
- Debug.WriteLine(result);
+ // Delete a schema.
+ apiInstance.deleteSchema(accept, schemaName);
} catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.getAllGroups: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.deleteSchema: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-php">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-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\GroupsApi();
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String |
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
-$name = name_example; // String | Group name. If not specified, returns all the groups.
+$schemaName = schemaName_example; // String |
try {
- $result = $api_instance->getAllGroups($accept, $offset, $limit, $name);
- print_r($result);
+ $api_instance->deleteSchema($accept, $schemaName);
} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->getAllGroups: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->deleteSchema: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-perl">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
+my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String |
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
-my $name = name_example; # String | Group name. If not specified, returns all the groups.
+my $schemaName = schemaName_example; # String |
eval {
- my $result = $api_instance->getAllGroups(accept => $accept, offset => $offset, limit => $limit, name => $name);
- print Dumper($result);
+ $api_instance->deleteSchema(accept => $accept, schemaName => $schemaName);
};
if ($@) {
- warn "Exception when calling GroupsApi->getAllGroups: $@\n";
+ warn "Exception when calling SchemasApi->deleteSchema: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-python">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-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.GroupsApi()
+api_instance = openapi_client.SchemasApi()
accept = application/json # String | (default to application/json)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
-name = name_example # String | Group name. If not specified, returns all the groups. (optional) (default to null)
+schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
try:
- # Get all groups.
- api_response = api_instance.get_all_groups(accept, offset=offset, limit=limit, name=name)
- pprint(api_response)
+ # Delete a schema.
+ api_instance.delete_schema(accept, schemaName)
except ApiException as e:
- print("Exception when calling GroupsApi->getAllGroups: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->deleteSchema: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getAllGroups-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
let accept = application/json; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
- let name = name_example; // String
+ let schemaName = schemaName_example; // String
- let mut context = GroupsApi::Context::default();
- let result = client.getAllGroups(accept, offset, limit, name, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.deleteSchema(accept, schemaName, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Header parameters</div>
+ <div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">schemaName*</td>
<td>
- <div id="d2e199_getAllGroups_accept">
+ <div id="d2e199_deleteSchema_schemaName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
-
-
- <div class="methodsubtabletitle">Query parameters</div>
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">offset</td>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getAllGroups_offset">
+ <div id="d2e199_deleteSchema_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- Integer
+ String
</span>
- <div class="inner description marked">
-Pagination offset.
- </div>
</div>
+ <div class="inner required">
+ Required
+ </div>
</div>
</div>
</td>
</tr>
- <tr><td style="width:150px;">limit</td>
-<td>
+ </table>
- <div id="d2e199_getAllGroups_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">name</td>
-<td>
+ <h2>Responses</h2>
+ <h3 id="examples-Schemas-deleteSchema-title-204"></h3>
+ <p id="examples-Schemas-deleteSchema-description-204" class="marked"></p>
+ <script>
+ var responseSchemas204_description = `No Content`;
+ var responseSchemas204_description_break = responseSchemas204_description.indexOf('\n');
+ if (responseSchemas204_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description);
+ } else {
+ $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description.substring(0, responseSchemas204_description_break));
+ $("#examples-Schemas-deleteSchema-description-204").html(responseSchemas204_description.substring(responseSchemas204_description_break));
+ }
+ </script>
- <div id="d2e199_getAllGroups_name">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
+ <ul id="responses-detail-Schemas-deleteSchema-204" class="nav nav-tabs nav-tabs-examples" >
- <div class="inner description marked">
-Group name. If not specified, returns all the groups.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ </ul>
+
+
+ <div class="tab-content" id="responses-Schemas-deleteSchema-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-204-schema">
+ <div id="responses-Schemas-deleteSchema-schema-204" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "No Content",
+ "content" : { }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-deleteSchema-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-204');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-deleteSchema-204-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-deleteSchema-title-400"></h3>
+ <p id="examples-Schemas-deleteSchema-description-400" class="marked"></p>
+ <script>
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
+ } else {
+ $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-deleteSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Schemas-deleteSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Schemas-deleteSchema-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-400-schema">
+ <div id="responses-Schemas-deleteSchema-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Responses</h2>
- <h3 id="examples-Groups-getAllGroups-title-200"></h3>
- <p id="examples-Groups-getAllGroups-description-200" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-deleteSchema-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-deleteSchema-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-deleteSchema-title-401"></h3>
+ <p id="examples-Schemas-deleteSchema-description-401" class="marked"></p>
<script>
- var responseGroups200_description = `OK`;
- var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
- if (responseGroups200_description_break == -1) {
- $("#examples-Groups-getAllGroups-title-200").text("Status: 200 - " + responseGroups200_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-Groups-getAllGroups-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
- $("#examples-Groups-getAllGroups-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
+ $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-deleteSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-Groups-getAllGroups-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getAllGroups-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getAllGroups-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getAllGroups-200-schema">
- <div id="responses-Groups-getAllGroups-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-401-schema">
+ <div id="responses-Schemas-deleteSchema-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Unauthorized",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/GroupsResponse"
+ "$ref" : "#/components/schemas/ErrorMessage"
},
- "examples" : {
- "groups" : {
- "$ref" : "#/components/examples/GroupsResponseExample"
- }
+ "example" : {
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getAllGroups-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getAllGroups-schema-200');
+ $('#responses-Schemas-deleteSchema-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getAllGroups-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getAllGroups-title-400"></h3>
- <p id="examples-Groups-getAllGroups-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-deleteSchema-title-403"></h3>
+ <p id="examples-Schemas-deleteSchema-description-403" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-getAllGroups-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
} else {
- $("#examples-Groups-getAllGroups-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-getAllGroups-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-deleteSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
}
</script>
- <ul id="responses-detail-Groups-getAllGroups-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getAllGroups-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getAllGroups-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getAllGroups-400-schema">
- <div id="responses-Groups-getAllGroups-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-403-schema">
+ <div id="responses-Schemas-deleteSchema-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getAllGroups-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getAllGroups-schema-400');
+ $('#responses-Schemas-deleteSchema-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getAllGroups-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getAllGroups-title-500"></h3>
- <p id="examples-Groups-getAllGroups-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-deleteSchema-title-500"></h3>
+ <p id="examples-Schemas-deleteSchema-description-500" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-getAllGroups-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-Groups-getAllGroups-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-getAllGroups-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-deleteSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Groups-getAllGroups-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getAllGroups-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getAllGroups-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getAllGroups-500-schema">
- <div id="responses-Groups-getAllGroups-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-500-schema">
+ <div id="responses-Schemas-deleteSchema-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getAllGroups-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getAllGroups-schema-500');
+ $('#responses-Schemas-deleteSchema-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getAllGroups-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Groups-getGroupById">
- <article id="api-Groups-getGroupById-0" data-group="User" data-name="getGroupById" data-version="0">
+ <div id="api-Schemas-getSchemaByName">
+ <article id="api-Schemas-getSchemaByName-0" data-group="User" data-name="getSchemaByName" data-version="0">
<div class="pull-left">
- <h1>getGroupById</h1>
- <p>Get a group with specified id.</p>
+ <h1>getSchemaByName</h1>
+ <p>Get the model schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get a group with specified id.</p>
+ <p class="marked">Get the model schema by name.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas/{schemaName}/content</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-Groups-getGroupById-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-getGroupById-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-getGroupById-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-getGroupById-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-getGroupById-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-getGroupById-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-getSchemaByName-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-getGroupById-0-curl">
+ <div class="tab-pane active" id="examples-Schemas-getSchemaByName-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/groups/{groupId}"
+ -H "Accept: text/plain,application/problem+json" \
+ "https://localhost/topology-inventory/v1/schemas/{schemaName}/content"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-java">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-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.GroupsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
- String accept = application/json; // String |
- String groupId = groupId_example; // String |
+ SchemasApi apiInstance = new SchemasApi();
+ String accept = accept_example; // String |
+ String schemaName = schemaName_example; // String |
try {
- GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
+ 'String' result = apiInstance.getSchemaByName(accept, schemaName);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getGroupById");
+ System.err.println("Exception when calling SchemasApi#getSchemaByName");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-dart">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String groupId = new String(); // String |
+final String schemaName = new String(); // String |
try {
- final result = await api_instance.getGroupById(accept, groupId);
+ final result = await api_instance.getSchemaByName(accept, schemaName);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getGroupById: $e\n');
+ print('Exception when calling DefaultApi->getSchemaByName: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
- String accept = application/json; // String |
- String groupId = groupId_example; // String |
+ SchemasApi apiInstance = new SchemasApi();
+ String accept = accept_example; // String |
+ String schemaName = schemaName_example; // String |
try {
- GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
+ 'String' result = apiInstance.getSchemaByName(accept, schemaName);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getGroupById");
+ System.err.println("Exception when calling SchemasApi#getSchemaByName");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Groups-getGroupById-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Groups-getGroupById-0-objc">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
-String *accept = application/json; // (default to application/json)
-String *groupId = groupId_example; // (default to null)
+SchemasApi *apiInstance = [[SchemasApi alloc] init];
+String *accept = accept_example; // (default to text/plain)
+String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
-// Get a group with specified id.
-[apiInstance getGroupByIdWith:accept
- groupId:groupId
- completionHandler: ^(GroupByIdResponse output, NSError* error) {
+// Get the model schema.
+[apiInstance getSchemaByNameWith:accept
+ schemaName:schemaName
+ completionHandler: ^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-javascript">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
-var accept = application/json; // {String}
-var groupId = groupId_example; // {String}
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
+var accept = accept_example; // {String}
+var schemaName = schemaName_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getGroupById(accept, groupId, callback);
+api.getSchemaByName(accept, schemaName, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Groups-getGroupById-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-getSchemaByName-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Groups-getGroupById-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getGroupByIdExample
+ public class getSchemaByNameExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new GroupsApi();
- var accept = application/json; // String | (default to application/json)
- var groupId = groupId_example; // String | (default to null)
+ var apiInstance = new SchemasApi();
+ var accept = accept_example; // String | (default to text/plain)
+ var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
try {
- // Get a group with specified id.
- GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
+ // Get the model schema.
+ 'String' result = apiInstance.getSchemaByName(accept, schemaName);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.getGroupById: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.getSchemaByName: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-php">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-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\GroupsApi();
-$accept = application/json; // String |
-$groupId = groupId_example; // String |
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
+$accept = accept_example; // String |
+$schemaName = schemaName_example; // String |
try {
- $result = $api_instance->getGroupById($accept, $groupId);
+ $result = $api_instance->getSchemaByName($accept, $schemaName);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->getGroupById: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->getSchemaByName: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-perl">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
-my $accept = application/json; # String |
-my $groupId = groupId_example; # String |
+my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $accept = accept_example; # String |
+my $schemaName = schemaName_example; # String |
eval {
- my $result = $api_instance->getGroupById(accept => $accept, groupId => $groupId);
+ my $result = $api_instance->getSchemaByName(accept => $accept, schemaName => $schemaName);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling GroupsApi->getGroupById: $@\n";
+ warn "Exception when calling SchemasApi->getSchemaByName: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-python">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-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.GroupsApi()
-accept = application/json # String | (default to application/json)
-groupId = groupId_example # String | (default to null)
+api_instance = openapi_client.SchemasApi()
+accept = accept_example # String | (default to text/plain)
+schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
try:
- # Get a group with specified id.
- api_response = api_instance.get_group_by_id(accept, groupId)
+ # Get the model schema.
+ api_response = api_instance.get_schema_by_name(accept, schemaName)
pprint(api_response)
except ApiException as e:
- print("Exception when calling GroupsApi->getGroupById: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->getSchemaByName: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getGroupById-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
- let accept = application/json; // String
- let groupId = groupId_example; // String
+ let accept = accept_example; // String
+ let schemaName = schemaName_example; // String
- let mut context = GroupsApi::Context::default();
- let result = client.getGroupById(accept, groupId, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.getSchemaByName(accept, schemaName, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">groupId*</td>
+ <tr><td style="width:150px;">schemaName*</td>
<td>
- <div id="d2e199_getGroupById_groupId">
+ <div id="d2e199_getSchemaByName_schemaName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getGroupById_accept">
+ <div id="d2e199_getSchemaByName_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<h2>Responses</h2>
- <h3 id="examples-Groups-getGroupById-title-200"></h3>
- <p id="examples-Groups-getGroupById-description-200" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-200"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-200" class="marked"></p>
<script>
- var responseGroups200_description = `OK`;
- var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
- if (responseGroups200_description_break == -1) {
- $("#examples-Groups-getGroupById-title-200").text("Status: 200 - " + responseGroups200_description);
+ var responseSchemas200_description = `OK`;
+ var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
+ if (responseSchemas200_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description);
} else {
- $("#examples-Groups-getGroupById-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
- $("#examples-Groups-getGroupById-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
+ $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
+ $("#examples-Schemas-getSchemaByName-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
}
</script>
- <ul id="responses-detail-Groups-getGroupById-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getGroupById-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getGroupById-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getGroupById-200-schema">
- <div id="responses-Groups-getGroupById-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-200-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "OK",
"content" : {
- "application/json" : {
+ "text/plain" : {
"schema" : {
- "$ref" : "#/components/schemas/GroupByIdResponse"
+ "type" : "string"
},
"examples" : {
- "static" : {
- "$ref" : "#/components/examples/StaticGroupResponseExample"
- },
- "dynamic" : {
- "$ref" : "#/components/examples/DynamicGroupResponseExample"
+ "schema" : {
+ "$ref" : "#/components/examples/SchemaResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getGroupById-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getGroupById-schema-200');
+ $('#responses-Schemas-getSchemaByName-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getGroupById-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getGroupById-title-400"></h3>
- <p id="examples-Groups-getGroupById-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-400"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-400" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-getGroupById-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description);
} else {
- $("#examples-Groups-getGroupById-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-getGroupById-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-getSchemaByName-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
}
</script>
- <ul id="responses-detail-Groups-getGroupById-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getGroupById-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getGroupById-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getGroupById-400-schema">
- <div id="responses-Groups-getGroupById-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-400-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getGroupById-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getGroupById-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Groups-getGroupById-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Groups-getGroupById-title-404"></h3>
- <p id="examples-Groups-getGroupById-description-404" class="marked"></p>
- <script>
- var responseGroups404_description = `Not Found`;
- var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
- if (responseGroups404_description_break == -1) {
- $("#examples-Groups-getGroupById-title-404").text("Status: 404 - " + responseGroups404_description);
- } else {
- $("#examples-Groups-getGroupById-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
- $("#examples-Groups-getGroupById-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Groups-getGroupById-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Groups-getGroupById-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Groups-getGroupById-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getGroupById-404-schema">
- <div id="responses-Groups-getGroupById-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Not Found",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getGroupById-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getGroupById-schema-404');
+ $('#responses-Schemas-getSchemaByName-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getGroupById-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getGroupById-title-500"></h3>
- <p id="examples-Groups-getGroupById-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-401"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-401" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-getGroupById-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-Groups-getGroupById-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-getGroupById-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-getSchemaByName-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-Groups-getGroupById-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getGroupById-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getGroupById-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getGroupById-500-schema">
- <div id="responses-Groups-getGroupById-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-401-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getGroupById-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getGroupById-schema-500');
+ $('#responses-Schemas-getSchemaByName-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getGroupById-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- </article>
- </div>
- <hr>
- <div id="api-Groups-getMembers">
- <article id="api-Groups-getMembers-0" data-group="User" data-name="getMembers" data-version="0">
- <div class="pull-left">
- <h1>getMembers</h1>
- <p>Get the members of a group with specified id.</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Get the members of a group with specified id.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}/members</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-Groups-getMembers-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-getMembers-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-getMembers-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-getMembers-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-getMembers-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-getMembers-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-getMembers-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/groups/{groupId}/members?offset=56&limit=56"
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-Groups-getMembers-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.GroupsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class GroupsApiExample {
- public static void main(String[] args) {
-
- // Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
- String accept = application/json; // String |
- String groupId = groupId_example; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
-
- try {
- MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getMembers");
- e.printStackTrace();
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-getMembers-0-dart">
- <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
-
-final api_instance = DefaultApi();
-
-final String accept = new String(); // String |
-final String groupId = new String(); // String |
-final Integer offset = new Integer(); // Integer | Pagination offset.
-final Integer limit = new Integer(); // Integer | Result limiter.
-
-try {
- final result = await api_instance.getMembers(accept, groupId, offset, limit);
- print(result);
-} catch (e) {
- print('Exception when calling DefaultApi->getMembers: $e\n');
-}
-
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-getMembers-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-
-public class GroupsApiExample {
- public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
- String accept = application/json; // String |
- String groupId = groupId_example; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
-
- try {
- MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getMembers");
- e.printStackTrace();
- }
- }
-}</code></pre>
- </div>
- <!--
- <div class="tab-pane" id="examples-Groups-getMembers-0-groovy">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div> -->
- <div class="tab-pane" id="examples-Groups-getMembers-0-objc">
- <pre class="prettyprint"><code class="language-cpp">
-
-// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
-String *accept = application/json; // (default to application/json)
-String *groupId = groupId_example; // (default to null)
-Integer *offset = 56; // Pagination offset. (optional) (default to 0)
-Integer *limit = 56; // Result limiter. (optional) (default to 500)
-
-// Get the members of a group with specified id.
-[apiInstance getMembersWith:accept
- groupId:groupId
- offset:offset
- limit:limit
- completionHandler: ^(MembersResponse output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
- if (error) {
- NSLog(@"Error: %@", error);
- }
-}];
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-getMembers-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
-
-// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
-var accept = application/json; // {String}
-var groupId = groupId_example; // {String}
-var opts = {
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
-};
-
-var callback = function(error, data, response) {
- if (error) {
- console.error(error);
- } else {
- console.log('API called successfully. Returned data: ' + data);
- }
-};
-api.getMembers(accept, groupId, opts, callback);
-</code></pre>
- </div>
-
- <!--<div class="tab-pane" id="examples-Groups-getMembers-0-angular">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div>-->
- <div class="tab-pane" id="examples-Groups-getMembers-0-csharp">
- <pre class="prettyprint"><code class="language-cs">using System;
-using System.Diagnostics;
-using Org.OpenAPITools.Api;
-using Org.OpenAPITools.Client;
-using Org.OpenAPITools.Model;
-
-namespace Example
-{
- public class getMembersExample
- {
- public void main()
- {
-
- // Create an instance of the API class
- var apiInstance = new GroupsApi();
- var accept = application/json; // String | (default to application/json)
- var groupId = groupId_example; // String | (default to null)
- var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
- var limit = 56; // Integer | Result limiter. (optional) (default to 500)
-
- try {
- // Get the members of a group with specified id.
- MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
- Debug.WriteLine(result);
- } catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.getMembers: " + e.Message );
- }
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-getMembers-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\GroupsApi();
-$accept = application/json; // String |
-$groupId = groupId_example; // String |
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
-
-try {
- $result = $api_instance->getMembers($accept, $groupId, $offset, $limit);
- print_r($result);
-} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->getMembers: ', $e->getMessage(), PHP_EOL;
-}
-?></code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-getMembers-0-perl">
- <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
-use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
+ <h3 id="examples-Schemas-getSchemaByName-title-403"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-403" class="marked"></p>
+ <script>
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description);
+ } else {
+ $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-getSchemaByName-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ }
+ </script>
-# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
-my $accept = application/json; # String |
-my $groupId = groupId_example; # String |
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
-eval {
- my $result = $api_instance->getMembers(accept => $accept, groupId => $groupId, offset => $offset, limit => $limit);
- print Dumper($result);
-};
-if ($@) {
- warn "Exception when calling GroupsApi->getMembers: $@\n";
-}</code></pre>
- </div>
+ <ul id="responses-detail-Schemas-getSchemaByName-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-403-schema">Schema</a>
+ </li>
- <div class="tab-pane" id="examples-Groups-getMembers-0-python">
- <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-# Create an instance of the API class
-api_instance = openapi_client.GroupsApi()
-accept = application/json # String | (default to application/json)
-groupId = groupId_example # String | (default to null)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
-try:
- # Get the members of a group with specified id.
- api_response = api_instance.get_members(accept, groupId, offset=offset, limit=limit)
- pprint(api_response)
-except ApiException as e:
- print("Exception when calling GroupsApi->getMembers: %s\n" % e)</code></pre>
- </div>
- <div class="tab-pane" id="examples-Groups-getMembers-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
+ </ul>
-pub fn main() {
- let accept = application/json; // String
- let groupId = groupId_example; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
- let mut context = GroupsApi::Context::default();
- let result = client.getMembers(accept, groupId, offset, limit, &context).wait();
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-403-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- println!("{:?}", result);
-}
-</code></pre>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemaByName-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemaByName-403-schema-data' type='hidden' value=''></input>
+ </div>
</div>
- </div>
+ <h3 id="examples-Schemas-getSchemaByName-title-404"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-404" class="marked"></p>
+ <script>
+ var responseSchemas404_description = `Not Found`;
+ var responseSchemas404_description_break = responseSchemas404_description.indexOf('\n');
+ if (responseSchemas404_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description);
+ } else {
+ $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description.substring(0, responseSchemas404_description_break));
+ $("#examples-Schemas-getSchemaByName-description-404").html(responseSchemas404_description.substring(responseSchemas404_description_break));
+ }
+ </script>
- <h2>Scopes</h2>
- <table>
-
- </table>
- <h2>Parameters</h2>
+ <ul id="responses-detail-Schemas-getSchemaByName-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-404-schema">Schema</a>
+ </li>
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">groupId*</td>
-<td>
- <div id="d2e199_getMembers_groupId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </ul>
- </table>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-404-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemaByName-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemaByName-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-getSchemaByName-title-406"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-406" class="marked"></p>
+ <script>
+ var responseSchemas406_description = `Not Acceptable`;
+ var responseSchemas406_description_break = responseSchemas406_description.indexOf('\n');
+ if (responseSchemas406_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-406").text("Status: 406 - " + responseSchemas406_description);
+ } else {
+ $("#examples-Schemas-getSchemaByName-title-406").text("Status: 406 - " + responseSchemas406_description.substring(0, responseSchemas406_description_break));
+ $("#examples-Schemas-getSchemaByName-description-406").html(responseSchemas406_description.substring(responseSchemas406_description_break));
+ }
+ </script>
- <div id="d2e199_getMembers_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
+ <ul id="responses-detail-Schemas-getSchemaByName-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-406-schema">Schema</a>
+ </li>
+
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+
+ </ul>
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-406-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">offset</td>
-<td>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemaByName-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemaByName-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-getSchemaByName-title-414"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-414" class="marked"></p>
+ <script>
+ var responseSchemas414_description = `URI Too Large`;
+ var responseSchemas414_description_break = responseSchemas414_description.indexOf('\n');
+ if (responseSchemas414_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-414").text("Status: 414 - " + responseSchemas414_description);
+ } else {
+ $("#examples-Schemas-getSchemaByName-title-414").text("Status: 414 - " + responseSchemas414_description.substring(0, responseSchemas414_description_break));
+ $("#examples-Schemas-getSchemaByName-description-414").html(responseSchemas414_description.substring(responseSchemas414_description_break));
+ }
+ </script>
- <div id="d2e199_getMembers_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ <ul id="responses-detail-Schemas-getSchemaByName-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-414-schema">Schema</a>
+ </li>
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">limit</td>
-<td>
- <div id="d2e199_getMembers_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ </ul>
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-414-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Responses</h2>
- <h3 id="examples-Groups-getMembers-title-200"></h3>
- <p id="examples-Groups-getMembers-description-200" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemaByName-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemaByName-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-getSchemaByName-title-429"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-429" class="marked"></p>
<script>
- var responseGroups200_description = `OK`;
- var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
- if (responseGroups200_description_break == -1) {
- $("#examples-Groups-getMembers-title-200").text("Status: 200 - " + responseGroups200_description);
+ var responseSchemas429_description = `Too Many Requests`;
+ var responseSchemas429_description_break = responseSchemas429_description.indexOf('\n');
+ if (responseSchemas429_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-429").text("Status: 429 - " + responseSchemas429_description);
} else {
- $("#examples-Groups-getMembers-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
- $("#examples-Groups-getMembers-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
+ $("#examples-Schemas-getSchemaByName-title-429").text("Status: 429 - " + responseSchemas429_description.substring(0, responseSchemas429_description_break));
+ $("#examples-Schemas-getSchemaByName-description-429").html(responseSchemas429_description.substring(responseSchemas429_description_break));
}
</script>
- <ul id="responses-detail-Groups-getMembers-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getMembers-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getMembers-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getMembers-200-schema">
- <div id="responses-Groups-getMembers-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-429-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Too Many Requests",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/MembersResponse"
- },
- "examples" : {
- "members" : {
- "$ref" : "#/components/examples/MembersResponseExample"
- }
+ "$ref" : "#/components/schemas/ErrorMessage"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getMembers-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getMembers-schema-200');
+ $('#responses-Schemas-getSchemaByName-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getMembers-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getMembers-title-400"></h3>
- <p id="examples-Groups-getMembers-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-500"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-500" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-getMembers-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-Groups-getMembers-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-getMembers-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-getSchemaByName-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Groups-getMembers-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getMembers-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getMembers-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getMembers-400-schema">
- <div id="responses-Groups-getMembers-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-500-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getMembers-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getMembers-schema-400');
+ $('#responses-Schemas-getSchemaByName-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getMembers-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getMembers-title-404"></h3>
- <p id="examples-Groups-getMembers-description-404" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-502"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-502" class="marked"></p>
<script>
- var responseGroups404_description = `Not Found`;
- var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
- if (responseGroups404_description_break == -1) {
- $("#examples-Groups-getMembers-title-404").text("Status: 404 - " + responseGroups404_description);
+ var responseSchemas502_description = `Bad Gateway`;
+ var responseSchemas502_description_break = responseSchemas502_description.indexOf('\n');
+ if (responseSchemas502_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-502").text("Status: 502 - " + responseSchemas502_description);
} else {
- $("#examples-Groups-getMembers-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
- $("#examples-Groups-getMembers-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
+ $("#examples-Schemas-getSchemaByName-title-502").text("Status: 502 - " + responseSchemas502_description.substring(0, responseSchemas502_description_break));
+ $("#examples-Schemas-getSchemaByName-description-502").html(responseSchemas502_description.substring(responseSchemas502_description_break));
}
</script>
- <ul id="responses-detail-Groups-getMembers-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getMembers-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getMembers-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getMembers-404-schema">
- <div id="responses-Groups-getMembers-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-502-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getMembers-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getMembers-schema-404');
+ $('#responses-Schemas-getSchemaByName-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getMembers-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getMembers-title-500"></h3>
- <p id="examples-Groups-getMembers-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-503"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-503" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-getMembers-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseSchemas503_description = `Service Unavailable`;
+ var responseSchemas503_description_break = responseSchemas503_description.indexOf('\n');
+ if (responseSchemas503_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-503").text("Status: 503 - " + responseSchemas503_description);
} else {
- $("#examples-Groups-getMembers-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-getMembers-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Schemas-getSchemaByName-title-503").text("Status: 503 - " + responseSchemas503_description.substring(0, responseSchemas503_description_break));
+ $("#examples-Schemas-getSchemaByName-description-503").html(responseSchemas503_description.substring(responseSchemas503_description_break));
}
</script>
- <ul id="responses-detail-Groups-getMembers-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getMembers-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getMembers-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getMembers-500-schema">
- <div id="responses-Groups-getMembers-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-503-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getMembers-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getMembers-schema-500');
+ $('#responses-Schemas-getSchemaByName-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getMembers-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Groups-getProvidedMembers">
- <article id="api-Groups-getProvidedMembers-0" data-group="User" data-name="getProvidedMembers" data-version="0">
+ <div id="api-Schemas-getSchemas">
+ <article id="api-Schemas-getSchemas-0" data-group="User" data-name="getSchemas" data-version="0">
<div class="pull-left">
- <h1>getProvidedMembers</h1>
- <p>Get the provided members of a static group with specified id.</p>
+ <h1>getSchemas</h1>
+ <p>Get a list of all pre defined schemas.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get the provided members of a static group with specified id.</p>
+ <p class="marked">Get a list of all topology model schemas.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}/provided-members</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas</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-Groups-getProvidedMembers-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-getProvidedMembers-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-getProvidedMembers-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-getProvidedMembers-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-getSchemas-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemas-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemas-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemas-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemas-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-getProvidedMembers-0-curl">
+ <div class="tab-pane active" id="examples-Schemas-getSchemas-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/groups/{groupId}/provided-members?status=status_example&offset=56&limit=56"
+ "https://localhost/topology-inventory/v1/schemas?domain=RAN&offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-java">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-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.GroupsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String groupId = groupId_example; // String |
- String status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+ String domain = RAN; // String |
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
+ Schemas result = apiInstance.getSchemas(accept, domain, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getProvidedMembers");
+ System.err.println("Exception when calling SchemasApi#getSchemas");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-dart">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String groupId = new String(); // String |
-final String status = new String(); // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+final String domain = new String(); // String |
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.
try {
- final result = await api_instance.getProvidedMembers(accept, groupId, status, offset, limit);
+ final result = await api_instance.getSchemas(accept, domain, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getProvidedMembers: $e\n');
+ print('Exception when calling DefaultApi->getSchemas: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class GroupsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String groupId = groupId_example; // String |
- String status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+ String domain = RAN; // String |
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
+ Schemas result = apiInstance.getSchemas(accept, domain, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#getProvidedMembers");
+ System.err.println("Exception when calling SchemasApi#getSchemas");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-objc">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
+SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *groupId = groupId_example; // (default to null)
-String *status = status_example; // Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
+String *domain = RAN; // (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Get the provided members of a static group with specified id.
-[apiInstance getProvidedMembersWith:accept
- groupId:groupId
- status:status
+// Get a list of all pre defined schemas.
+[apiInstance getSchemasWith:accept
+ domain:domain
offset:offset
limit:limit
- completionHandler: ^(MembersResponse output, NSError* error) {
+ completionHandler: ^(Schemas output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-javascript">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String}
-var groupId = groupId_example; // {String}
var opts = {
- 'status': status_example, // {String} Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+ 'domain': RAN, // {String}
'offset': 56, // {Integer} Pagination offset.
'limit': 56 // {Integer} Result limiter.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getProvidedMembers(accept, groupId, opts, callback);
+api.getSchemas(accept, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Groups-getProvidedMembers-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-getSchemas-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getProvidedMembersExample
+ public class getSchemasExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new GroupsApi();
+ var apiInstance = new SchemasApi();
var accept = application/json; // String | (default to application/json)
- var groupId = groupId_example; // String | (default to null)
- var status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
+ var domain = RAN; // String | (optional) (default to null)
var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Get the provided members of a static group with specified id.
- MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
+ // Get a list of all pre defined schemas.
+ Schemas result = apiInstance.getSchemas(accept, domain, offset, limit);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.getProvidedMembers: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.getSchemas: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-php">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-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\GroupsApi();
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String |
-$groupId = groupId_example; // String |
-$status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+$domain = RAN; // String |
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.
try {
- $result = $api_instance->getProvidedMembers($accept, $groupId, $status, $offset, $limit);
+ $result = $api_instance->getSchemas($accept, $domain, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->getProvidedMembers: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->getSchemas: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-perl">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
+my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String |
-my $groupId = groupId_example; # String |
-my $status = status_example; # String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
+my $domain = RAN; # String |
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.
eval {
- my $result = $api_instance->getProvidedMembers(accept => $accept, groupId => $groupId, status => $status, offset => $offset, limit => $limit);
+ my $result = $api_instance->getSchemas(accept => $accept, domain => $domain, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling GroupsApi->getProvidedMembers: $@\n";
+ warn "Exception when calling SchemasApi->getSchemas: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-python">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-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.GroupsApi()
+api_instance = openapi_client.SchemasApi()
accept = application/json # String | (default to application/json)
-groupId = groupId_example # String | (default to null)
-status = status_example # String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
+domain = RAN # String | (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Get the provided members of a static group with specified id.
- api_response = api_instance.get_provided_members(accept, groupId, status=status, offset=offset, limit=limit)
+ # Get a list of all pre defined schemas.
+ api_response = api_instance.get_schemas(accept, domain=domain, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
- print("Exception when calling GroupsApi->getProvidedMembers: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->getSchemas: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-getProvidedMembers-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
let accept = application/json; // String
- let groupId = groupId_example; // String
- let status = status_example; // String
+ let domain = RAN; // String
let offset = 56; // Integer
let limit = 56; // Integer
- let mut context = GroupsApi::Context::default();
- let result = client.getProvidedMembers(accept, groupId, status, offset, limit, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.getSchemas(accept, domain, offset, limit, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">groupId*</td>
-<td>
-
-
- <div id="d2e199_getProvidedMembers_groupId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<td>
- <div id="d2e199_getProvidedMembers_accept">
+ <div id="d2e199_getSchemas_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">status</td>
+ <tr><td style="width:150px;">domain</td>
<td>
- <div id="d2e199_getProvidedMembers_status">
+ <div id="d2e199_getSchemas_domain">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
- <div class="inner description marked">
-Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
- </div>
</div>
</div>
</div>
<td>
- <div id="d2e199_getProvidedMembers_offset">
+ <div id="d2e199_getSchemas_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getProvidedMembers_limit">
+ <div id="d2e199_getSchemas_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
<h2>Responses</h2>
- <h3 id="examples-Groups-getProvidedMembers-title-200"></h3>
- <p id="examples-Groups-getProvidedMembers-description-200" class="marked"></p>
- <script>
- var responseGroups200_description = `OK`;
- var responseGroups200_description_break = responseGroups200_description.indexOf('\n');
- if (responseGroups200_description_break == -1) {
- $("#examples-Groups-getProvidedMembers-title-200").text("Status: 200 - " + responseGroups200_description);
- } else {
- $("#examples-Groups-getProvidedMembers-title-200").text("Status: 200 - " + responseGroups200_description.substring(0, responseGroups200_description_break));
- $("#examples-Groups-getProvidedMembers-description-200").html(responseGroups200_description.substring(responseGroups200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Groups-getProvidedMembers-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Groups-getProvidedMembers-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getProvidedMembers-200-schema">
- <div id="responses-Groups-getProvidedMembers-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/MembersResponse"
- },
- "examples" : {
- "members" : {
- "$ref" : "#/components/examples/ProvidedMembersResponseExample"
- }
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getProvidedMembers-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getProvidedMembers-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Groups-getProvidedMembers-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Groups-getProvidedMembers-title-400"></h3>
- <p id="examples-Groups-getProvidedMembers-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-200"></h3>
+ <p id="examples-Schemas-getSchemas-description-200" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-getProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseSchemas200_description = `OK`;
+ var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
+ if (responseSchemas200_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description);
} else {
- $("#examples-Groups-getProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-getProvidedMembers-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
+ $("#examples-Schemas-getSchemas-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
}
</script>
- <ul id="responses-detail-Groups-getProvidedMembers-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-200-schema">Schema</a>
</li>
</ul>
-
- <div class="tab-content" id="responses-Groups-getProvidedMembers-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getProvidedMembers-400-schema">
- <div id="responses-Groups-getProvidedMembers-schema-400" class="exampleStyle">
+
+ <div class="tab-content" id="responses-Schemas-getSchemas-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-200-schema">
+ <div id="responses-Schemas-getSchemas-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "OK",
"content" : {
- "application/problem+json" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/Schemas"
},
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "examples" : {
+ "schemas" : {
+ "$ref" : "#/components/examples/SchemasResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getProvidedMembers-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getProvidedMembers-schema-400');
+ $('#responses-Schemas-getSchemas-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getProvidedMembers-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getProvidedMembers-title-404"></h3>
- <p id="examples-Groups-getProvidedMembers-description-404" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-400"></h3>
+ <p id="examples-Schemas-getSchemas-description-400" class="marked"></p>
<script>
- var responseGroups404_description = `Not Found`;
- var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
- if (responseGroups404_description_break == -1) {
- $("#examples-Groups-getProvidedMembers-title-404").text("Status: 404 - " + responseGroups404_description);
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description);
} else {
- $("#examples-Groups-getProvidedMembers-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
- $("#examples-Groups-getProvidedMembers-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
+ $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-getSchemas-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
}
</script>
- <ul id="responses-detail-Groups-getProvidedMembers-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getProvidedMembers-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getProvidedMembers-404-schema">
- <div id="responses-Groups-getProvidedMembers-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-400-schema">
+ <div id="responses-Schemas-getSchemas-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getProvidedMembers-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getProvidedMembers-schema-404');
+ $('#responses-Schemas-getSchemas-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getProvidedMembers-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-getProvidedMembers-title-500"></h3>
- <p id="examples-Groups-getProvidedMembers-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-401"></h3>
+ <p id="examples-Schemas-getSchemas-description-401" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-getProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-Groups-getProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-getProvidedMembers-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-getSchemas-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-Groups-getProvidedMembers-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-getProvidedMembers-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-getProvidedMembers-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-getProvidedMembers-500-schema">
- <div id="responses-Groups-getProvidedMembers-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-401-schema">
+ <div id="responses-Schemas-getSchemas-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-getProvidedMembers-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-getProvidedMembers-schema-500');
+ $('#responses-Schemas-getSchemas-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-getProvidedMembers-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- </article>
- </div>
- <hr>
- <div id="api-Groups-updateGroupName">
- <article id="api-Groups-updateGroupName-0" data-group="User" data-name="updateGroupName" data-version="0">
- <div class="pull-left">
- <h1>updateGroupName</h1>
- <p>Update the name of a group.</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Update the name of a group.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/groups/{groupId}/name</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-Groups-updateGroupName-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-updateGroupName-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-updateGroupName-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-updateGroupName-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-updateGroupName-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-updateGroupName-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-updateGroupName-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: application/problem+json" \
- -H "Content-Type: application/json" \
- "https://localhost/topology-inventory/v1alpha11/groups/{groupId}/name" \
- -d '{
- "name" : "name"
-}'
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-Groups-updateGroupName-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.GroupsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class GroupsApiExample {
- public static void main(String[] args) {
-
- // Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
- String contentType = application/json; // String |
- String groupId = groupId_example; // String |
- UpdateGroupNamePayload updateGroupNamePayload = ; // UpdateGroupNamePayload |
-
- try {
- apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
- } catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#updateGroupName");
- e.printStackTrace();
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-dart">
- <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
-
-final api_instance = DefaultApi();
-
-final String contentType = new String(); // String |
-final String groupId = new String(); // String |
-final UpdateGroupNamePayload updateGroupNamePayload = new UpdateGroupNamePayload(); // UpdateGroupNamePayload |
-
-try {
- final result = await api_instance.updateGroupName(contentType, groupId, updateGroupNamePayload);
- print(result);
-} catch (e) {
- print('Exception when calling DefaultApi->updateGroupName: $e\n');
-}
-
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
-
-public class GroupsApiExample {
- public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
- String contentType = application/json; // String |
- String groupId = groupId_example; // String |
- UpdateGroupNamePayload updateGroupNamePayload = ; // UpdateGroupNamePayload |
-
- try {
- apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
- } catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#updateGroupName");
- e.printStackTrace();
- }
- }
-}</code></pre>
- </div>
- <!--
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-groovy">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div> -->
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-objc">
- <pre class="prettyprint"><code class="language-cpp">
-
-// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
-String *contentType = application/json; // (default to application/json)
-String *groupId = groupId_example; // (default to null)
-UpdateGroupNamePayload *updateGroupNamePayload = ; //
-
-// Update the name of a group.
-[apiInstance updateGroupNameWith:contentType
- groupId:groupId
- updateGroupNamePayload:updateGroupNamePayload
- completionHandler: ^(NSError* error) {
- if (error) {
- NSLog(@"Error: %@", error);
- }
-}];
-</code></pre>
- </div>
+ <h3 id="examples-Schemas-getSchemas-title-403"></h3>
+ <p id="examples-Schemas-getSchemas-description-403" class="marked"></p>
+ <script>
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description);
+ } else {
+ $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-getSchemas-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
-// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
-var contentType = application/json; // {String}
-var groupId = groupId_example; // {String}
-var updateGroupNamePayload = ; // {UpdateGroupNamePayload}
+ <ul id="responses-detail-Schemas-getSchemas-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-403-schema">Schema</a>
+ </li>
-var callback = function(error, data, response) {
- if (error) {
- console.error(error);
- } else {
- console.log('API called successfully.');
- }
-};
-api.updateGroupName(contentType, groupId, updateGroupNamePayload, callback);
-</code></pre>
- </div>
- <!--<div class="tab-pane" id="examples-Groups-updateGroupName-0-angular">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div>-->
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-csharp">
- <pre class="prettyprint"><code class="language-cs">using System;
-using System.Diagnostics;
-using Org.OpenAPITools.Api;
-using Org.OpenAPITools.Client;
-using Org.OpenAPITools.Model;
-namespace Example
-{
- public class updateGroupNameExample
- {
- public void main()
- {
- // Create an instance of the API class
- var apiInstance = new GroupsApi();
- var contentType = application/json; // String | (default to application/json)
- var groupId = groupId_example; // String | (default to null)
- var updateGroupNamePayload = new UpdateGroupNamePayload(); // UpdateGroupNamePayload |
+ </ul>
- try {
- // Update the name of a group.
- apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
- } catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.updateGroupName: " + e.Message );
- }
- }
+
+ <div class="tab-content" id="responses-Schemas-getSchemas-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-403-schema">
+ <div id="responses-Schemas-getSchemas-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
}
-}
-</code></pre>
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemas-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemas-403-schema-data' type='hidden' value=''></input>
+ </div>
</div>
+ <h3 id="examples-Schemas-getSchemas-title-404"></h3>
+ <p id="examples-Schemas-getSchemas-description-404" class="marked"></p>
+ <script>
+ var responseSchemas404_description = `Not Found`;
+ var responseSchemas404_description_break = responseSchemas404_description.indexOf('\n');
+ if (responseSchemas404_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-404").text("Status: 404 - " + responseSchemas404_description);
+ } else {
+ $("#examples-Schemas-getSchemas-title-404").text("Status: 404 - " + responseSchemas404_description.substring(0, responseSchemas404_description_break));
+ $("#examples-Schemas-getSchemas-description-404").html(responseSchemas404_description.substring(responseSchemas404_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-Groups-updateGroupName-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\GroupsApi();
-$contentType = application/json; // String |
-$groupId = groupId_example; // String |
-$updateGroupNamePayload = ; // UpdateGroupNamePayload |
+ <ul id="responses-detail-Schemas-getSchemas-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-404-schema">Schema</a>
+ </li>
-try {
- $api_instance->updateGroupName($contentType, $groupId, $updateGroupNamePayload);
-} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->updateGroupName: ', $e->getMessage(), PHP_EOL;
-}
-?></code></pre>
- </div>
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-perl">
- <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
-use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
-# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
-my $contentType = application/json; # String |
-my $groupId = groupId_example; # String |
-my $updateGroupNamePayload = WWW::OPenAPIClient::Object::UpdateGroupNamePayload->new(); # UpdateGroupNamePayload |
-eval {
- $api_instance->updateGroupName(contentType => $contentType, groupId => $groupId, updateGroupNamePayload => $updateGroupNamePayload);
-};
-if ($@) {
- warn "Exception when calling GroupsApi->updateGroupName: $@\n";
-}</code></pre>
- </div>
+ </ul>
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-python">
- <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-# Create an instance of the API class
-api_instance = openapi_client.GroupsApi()
-contentType = application/json # String | (default to application/json)
-groupId = groupId_example # String | (default to null)
-updateGroupNamePayload = # UpdateGroupNamePayload |
+ <div class="tab-content" id="responses-Schemas-getSchemas-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-404-schema">
+ <div id="responses-Schemas-getSchemas-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
-try:
- # Update the name of a group.
- api_instance.update_group_name(contentType, groupId, updateGroupNamePayload)
-except ApiException as e:
- print("Exception when calling GroupsApi->updateGroupName: %s\n" % e)</code></pre>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemas-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemas-404-schema-data' type='hidden' value=''></input>
+ </div>
</div>
+ <h3 id="examples-Schemas-getSchemas-title-406"></h3>
+ <p id="examples-Schemas-getSchemas-description-406" class="marked"></p>
+ <script>
+ var responseSchemas406_description = `Not Acceptable`;
+ var responseSchemas406_description_break = responseSchemas406_description.indexOf('\n');
+ if (responseSchemas406_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-406").text("Status: 406 - " + responseSchemas406_description);
+ } else {
+ $("#examples-Schemas-getSchemas-title-406").text("Status: 406 - " + responseSchemas406_description.substring(0, responseSchemas406_description_break));
+ $("#examples-Schemas-getSchemas-description-406").html(responseSchemas406_description.substring(responseSchemas406_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-Groups-updateGroupName-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
-pub fn main() {
- let contentType = application/json; // String
- let groupId = groupId_example; // String
- let updateGroupNamePayload = ; // UpdateGroupNamePayload
+ <ul id="responses-detail-Schemas-getSchemas-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-406-schema">Schema</a>
+ </li>
- let mut context = GroupsApi::Context::default();
- let result = client.updateGroupName(contentType, groupId, updateGroupNamePayload, &context).wait();
- println!("{:?}", result);
-}
-</code></pre>
- </div>
- </div>
- <h2>Scopes</h2>
- <table>
-
- </table>
- <h2>Parameters</h2>
+ </ul>
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">groupId*</td>
-<td>
+ <div class="tab-content" id="responses-Schemas-getSchemas-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-406-schema">
+ <div id="responses-Schemas-getSchemas-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <div id="d2e199_updateGroupName_groupId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemas-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemas-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-getSchemas-title-414"></h3>
+ <p id="examples-Schemas-getSchemas-description-414" class="marked"></p>
+ <script>
+ var responseSchemas414_description = `URI Too Large`;
+ var responseSchemas414_description_break = responseSchemas414_description.indexOf('\n');
+ if (responseSchemas414_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-414").text("Status: 414 - " + responseSchemas414_description);
+ } else {
+ $("#examples-Schemas-getSchemas-title-414").text("Status: 414 - " + responseSchemas414_description.substring(0, responseSchemas414_description_break));
+ $("#examples-Schemas-getSchemas-description-414").html(responseSchemas414_description.substring(responseSchemas414_description_break));
+ }
+ </script>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ <ul id="responses-detail-Schemas-getSchemas-414" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-414-schema">Schema</a>
+ </li>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Content-Type*</td>
-<td>
- <div id="d2e199_updateGroupName_contentType">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </ul>
- </table>
- <div class="methodsubtabletitle">Body parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">updateGroupNamePayload <span style="color:red;">*</span></td>
-<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
+ <div class="tab-content" id="responses-Schemas-getSchemas-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-414-schema">
+ <div id="responses-Schemas-getSchemas-schema-414" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "URI Too Large",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/UpdateGroupNamePayload"
- },
- "examples" : {
- "GroupNameUpdatePayload" : {
- "$ref" : "#/components/examples/UpdateGroupNamePayloadExample"
- }
+ "$ref" : "#/components/schemas/ErrorMessage"
}
}
- },
- "required" : true
-};
-
- 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 schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_updateGroupName_updateGroupNamePayload');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_updateGroupName_updateGroupNamePayload"></div>
-</td>
-</tr>
-
- </table>
-
-
-
- <h2>Responses</h2>
- <h3 id="examples-Groups-updateGroupName-title-204"></h3>
- <p id="examples-Groups-updateGroupName-description-204" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemas-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-414');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemas-414-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-getSchemas-title-429"></h3>
+ <p id="examples-Schemas-getSchemas-description-429" class="marked"></p>
<script>
- var responseGroups204_description = `No Content`;
- var responseGroups204_description_break = responseGroups204_description.indexOf('\n');
- if (responseGroups204_description_break == -1) {
- $("#examples-Groups-updateGroupName-title-204").text("Status: 204 - " + responseGroups204_description);
+ var responseSchemas429_description = `Too Many Requests`;
+ var responseSchemas429_description_break = responseSchemas429_description.indexOf('\n');
+ if (responseSchemas429_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-429").text("Status: 429 - " + responseSchemas429_description);
} else {
- $("#examples-Groups-updateGroupName-title-204").text("Status: 204 - " + responseGroups204_description.substring(0, responseGroups204_description_break));
- $("#examples-Groups-updateGroupName-description-204").html(responseGroups204_description.substring(responseGroups204_description_break));
+ $("#examples-Schemas-getSchemas-title-429").text("Status: 429 - " + responseSchemas429_description.substring(0, responseSchemas429_description_break));
+ $("#examples-Schemas-getSchemas-description-429").html(responseSchemas429_description.substring(responseSchemas429_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateGroupName-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-429" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-429-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Groups-updateGroupName-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateGroupName-204-schema">
- <div id="responses-Groups-updateGroupName-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-429-schema">
+ <div id="responses-Schemas-getSchemas-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "Too Many Requests",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateGroupName-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateGroupName-schema-204');
+ $('#responses-Schemas-getSchemas-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-updateGroupName-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-updateGroupName-title-400"></h3>
- <p id="examples-Groups-updateGroupName-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-500"></h3>
+ <p id="examples-Schemas-getSchemas-description-500" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-updateGroupName-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-Groups-updateGroupName-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-updateGroupName-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-getSchemas-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateGroupName-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-updateGroupName-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-updateGroupName-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateGroupName-400-schema">
- <div id="responses-Groups-updateGroupName-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-500-schema">
+ <div id="responses-Schemas-getSchemas-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateGroupName-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateGroupName-schema-400');
+ $('#responses-Schemas-getSchemas-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-updateGroupName-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-updateGroupName-title-404"></h3>
- <p id="examples-Groups-updateGroupName-description-404" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-502"></h3>
+ <p id="examples-Schemas-getSchemas-description-502" class="marked"></p>
<script>
- var responseGroups404_description = `Not Found`;
- var responseGroups404_description_break = responseGroups404_description.indexOf('\n');
- if (responseGroups404_description_break == -1) {
- $("#examples-Groups-updateGroupName-title-404").text("Status: 404 - " + responseGroups404_description);
+ var responseSchemas502_description = `Bad Gateway`;
+ var responseSchemas502_description_break = responseSchemas502_description.indexOf('\n');
+ if (responseSchemas502_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-502").text("Status: 502 - " + responseSchemas502_description);
} else {
- $("#examples-Groups-updateGroupName-title-404").text("Status: 404 - " + responseGroups404_description.substring(0, responseGroups404_description_break));
- $("#examples-Groups-updateGroupName-description-404").html(responseGroups404_description.substring(responseGroups404_description_break));
+ $("#examples-Schemas-getSchemas-title-502").text("Status: 502 - " + responseSchemas502_description.substring(0, responseSchemas502_description_break));
+ $("#examples-Schemas-getSchemas-description-502").html(responseSchemas502_description.substring(responseSchemas502_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateGroupName-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-updateGroupName-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-updateGroupName-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateGroupName-404-schema">
- <div id="responses-Groups-updateGroupName-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-502-schema">
+ <div id="responses-Schemas-getSchemas-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateGroupName-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateGroupName-schema-404');
+ $('#responses-Schemas-getSchemas-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-updateGroupName-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-updateGroupName-title-500"></h3>
- <p id="examples-Groups-updateGroupName-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-503"></h3>
+ <p id="examples-Schemas-getSchemas-description-503" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-updateGroupName-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseSchemas503_description = `Service Unavailable`;
+ var responseSchemas503_description_break = responseSchemas503_description.indexOf('\n');
+ if (responseSchemas503_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-503").text("Status: 503 - " + responseSchemas503_description);
} else {
- $("#examples-Groups-updateGroupName-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-updateGroupName-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-Schemas-getSchemas-title-503").text("Status: 503 - " + responseSchemas503_description.substring(0, responseSchemas503_description_break));
+ $("#examples-Schemas-getSchemas-description-503").html(responseSchemas503_description.substring(responseSchemas503_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateGroupName-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-updateGroupName-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-updateGroupName-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateGroupName-500-schema">
- <div id="responses-Groups-updateGroupName-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-503-schema">
+ <div id="responses-Schemas-getSchemas-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateGroupName-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateGroupName-schema-500');
+ $('#responses-Schemas-getSchemas-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-updateGroupName-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
- <hr>
- <div id="api-Groups-updateProvidedMembers">
- <article id="api-Groups-updateProvidedMembers-0" data-group="User" data-name="updateProvidedMembers" data-version="0">
+ <hr>
+ </section>
+ <section id="api-UserDefinedSchemas">
+ <h1>UserDefinedSchemas</h1>
+ <div id="api-UserDefinedSchemas-createUserDefinedSchema">
+ <article id="api-UserDefinedSchemas-createUserDefinedSchema-0" data-group="User" data-name="createUserDefinedSchema" data-version="0">
<div class="pull-left">
- <h1>updateProvidedMembers</h1>
- <p>Merge or remove members of a static group.</p>
+ <h1>createUserDefinedSchema</h1>
+ <p>Create a new user defined schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Merge or remove members in an existing topology group. This operation is applicable for static group only.</p>
+ <p class="marked">Create a new user defined schema. The request body contains the schema in YANG format.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/groups/{groupId}/provided-members-operations</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/user-defined-schemas</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-Groups-updateProvidedMembers-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-java">Java</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Groups-updateProvidedMembers-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Groups-updateProvidedMembers-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-php">PHP</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-python">Python</a></li>
- <li class=""><a href="#examples-Groups-updateProvidedMembers-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-java">Java</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-php">PHP</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-python">Python</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-createUserDefinedSchema-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Groups-updateProvidedMembers-0-curl">
+ <div class="tab-pane active" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/problem+json" \
- -H "Content-Type: application/json" \
- "https://localhost/topology-inventory/v1alpha11/groups/{groupId}/provided-members-operations" \
- -d '{
- "providedMembers" : [ "{}", "{}" ],
- "operation" : "merge"
-}'
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: multipart/form-data" \
+ "https://localhost/topology-inventory/v1/user-defined-schemas"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-java">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-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.GroupsApi;
+import org.openapitools.client.api.UserDefinedSchemasApi;
import java.io.File;
import java.util.*;
-public class GroupsApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- GroupsApi apiInstance = new GroupsApi();
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- String groupId = groupId_example; // String |
- UpdateProvidedMembersPayload updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload |
+ String contentType = multipart/form-data; // String |
+ File file = BINARY_DATA_HERE; // File | multipartFile
try {
- apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
+ UserDefinedSchema result = apiInstance.createUserDefinedSchema(accept, contentType, file);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#updateProvidedMembers");
+ System.err.println("Exception when calling UserDefinedSchemasApi#createUserDefinedSchema");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-dart">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
final String contentType = new String(); // String |
-final String groupId = new String(); // String |
-final UpdateProvidedMembersPayload updateProvidedMembersPayload = new UpdateProvidedMembersPayload(); // UpdateProvidedMembersPayload |
+final File file = new File(); // File | multipartFile
try {
- final result = await api_instance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
+ final result = await api_instance.createUserDefinedSchema(accept, contentType, file);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->updateProvidedMembers: $e\n');
+ print('Exception when calling DefaultApi->createUserDefinedSchema: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GroupsApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.UserDefinedSchemasApi;
-public class GroupsApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
- GroupsApi apiInstance = new GroupsApi();
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- String groupId = groupId_example; // String |
- UpdateProvidedMembersPayload updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload |
+ String contentType = multipart/form-data; // String |
+ File file = BINARY_DATA_HERE; // File | multipartFile
try {
- apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
+ UserDefinedSchema result = apiInstance.createUserDefinedSchema(accept, contentType, file);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GroupsApi#updateProvidedMembers");
+ System.err.println("Exception when calling UserDefinedSchemasApi#createUserDefinedSchema");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-groovy">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-objc">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-GroupsApi *apiInstance = [[GroupsApi alloc] init];
+UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *contentType = application/json; // (default to application/json)
-String *groupId = groupId_example; // (default to null)
-UpdateProvidedMembersPayload *updateProvidedMembersPayload = ; //
+String *contentType = multipart/form-data; // (default to multipart/form-data)
+File *file = BINARY_DATA_HERE; // multipartFile (default to null)
-// Merge or remove members of a static group.
-[apiInstance updateProvidedMembersWith:accept
+// Create a new user defined schema.
+[apiInstance createUserDefinedSchemaWith:accept
contentType:contentType
- groupId:groupId
- updateProvidedMembersPayload:updateProvidedMembersPayload
- completionHandler: ^(NSError* error) {
+ file:file
+ completionHandler: ^(UserDefinedSchema output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-javascript">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.GroupsApi()
+var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = application/json; // {String}
-var contentType = application/json; // {String}
-var groupId = groupId_example; // {String}
-var updateProvidedMembersPayload = ; // {UpdateProvidedMembersPayload}
+var contentType = multipart/form-data; // {String}
+var file = BINARY_DATA_HERE; // {File} multipartFile
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully.');
+ console.log('API called successfully. Returned data: ' + data);
}
};
-api.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload, callback);
+api.createUserDefinedSchema(accept, contentType, file, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-angular">
+ <!--<div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-csharp">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class updateProvidedMembersExample
+ public class createUserDefinedSchemaExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new GroupsApi();
+ var apiInstance = new UserDefinedSchemasApi();
var accept = application/json; // String | (default to application/json)
- var contentType = application/json; // String | (default to application/json)
- var groupId = groupId_example; // String | (default to null)
- var updateProvidedMembersPayload = new UpdateProvidedMembersPayload(); // UpdateProvidedMembersPayload |
+ var contentType = multipart/form-data; // String | (default to multipart/form-data)
+ var file = BINARY_DATA_HERE; // File | multipartFile (default to null)
try {
- // Merge or remove members of a static group.
- apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
+ // Create a new user defined schema.
+ UserDefinedSchema result = apiInstance.createUserDefinedSchema(accept, contentType, file);
+ Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling GroupsApi.updateProvidedMembers: " + e.Message );
+ Debug.Print("Exception when calling UserDefinedSchemasApi.createUserDefinedSchema: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-php">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-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\GroupsApi();
+$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
$accept = application/json; // String |
-$contentType = application/json; // String |
-$groupId = groupId_example; // String |
-$updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload |
+$contentType = multipart/form-data; // String |
+$file = BINARY_DATA_HERE; // File | multipartFile
try {
- $api_instance->updateProvidedMembers($accept, $contentType, $groupId, $updateProvidedMembersPayload);
+ $result = $api_instance->createUserDefinedSchema($accept, $contentType, $file);
+ print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling GroupsApi->updateProvidedMembers: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling UserDefinedSchemasApi->createUserDefinedSchema: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-perl">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GroupsApi;
+use WWW::OPenAPIClient::UserDefinedSchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
+my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
my $accept = application/json; # String |
-my $contentType = application/json; # String |
-my $groupId = groupId_example; # String |
-my $updateProvidedMembersPayload = WWW::OPenAPIClient::Object::UpdateProvidedMembersPayload->new(); # UpdateProvidedMembersPayload |
+my $contentType = multipart/form-data; # String |
+my $file = BINARY_DATA_HERE; # File | multipartFile
eval {
- $api_instance->updateProvidedMembers(accept => $accept, contentType => $contentType, groupId => $groupId, updateProvidedMembersPayload => $updateProvidedMembersPayload);
+ my $result = $api_instance->createUserDefinedSchema(accept => $accept, contentType => $contentType, file => $file);
+ print Dumper($result);
};
if ($@) {
- warn "Exception when calling GroupsApi->updateProvidedMembers: $@\n";
+ warn "Exception when calling UserDefinedSchemasApi->createUserDefinedSchema: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-python">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-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.GroupsApi()
+api_instance = openapi_client.UserDefinedSchemasApi()
accept = application/json # String | (default to application/json)
-contentType = application/json # String | (default to application/json)
-groupId = groupId_example # String | (default to null)
-updateProvidedMembersPayload = # UpdateProvidedMembersPayload |
+contentType = multipart/form-data # String | (default to multipart/form-data)
+file = BINARY_DATA_HERE # File | multipartFile (default to null)
try:
- # Merge or remove members of a static group.
- api_instance.update_provided_members(accept, contentType, groupId, updateProvidedMembersPayload)
+ # Create a new user defined schema.
+ api_response = api_instance.create_user_defined_schema(accept, contentType, file)
+ pprint(api_response)
except ApiException as e:
- print("Exception when calling GroupsApi->updateProvidedMembers: %s\n" % e)</code></pre>
+ print("Exception when calling UserDefinedSchemasApi->createUserDefinedSchema: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Groups-updateProvidedMembers-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GroupsApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-createUserDefinedSchema-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate UserDefinedSchemasApi;
pub fn main() {
let accept = application/json; // String
- let contentType = application/json; // String
- let groupId = groupId_example; // String
- let updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload
+ let contentType = multipart/form-data; // String
+ let file = BINARY_DATA_HERE; // File
- let mut context = GroupsApi::Context::default();
- let result = client.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload, &context).wait();
+ let mut context = UserDefinedSchemasApi::Context::default();
+ let result = client.createUserDefinedSchema(accept, contentType, file, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">groupId*</td>
-<td>
-
-
- <div id="d2e199_updateProvidedMembers_groupId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<td>
- <div id="d2e199_updateProvidedMembers_accept">
+ <div id="d2e199_createUserDefinedSchema_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_updateProvidedMembers_contentType">
+ <div id="d2e199_createUserDefinedSchema_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Body parameters</div>
+
+ <div class="methodsubtabletitle">Form parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">updateProvidedMembersPayload <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">file*</td>
<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/UpdateProvidedMembersPayload"
- },
- "examples" : {
- "mergeMembersPayload" : {
- "$ref" : "#/components/examples/MergeProvidedMembersPayloadExample"
- },
- "deleteMembersPayload" : {
- "$ref" : "#/components/examples/RemoveProvidedMembersPayloadExample"
- }
- }
- }
- },
- "required" : true
-};
- 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,2,{isBodyParam: true});
- var result = $('#d2e199_updateProvidedMembers_updateProvidedMembersPayload');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_updateProvidedMembers_updateProvidedMembersPayload"></div>
+ <div id="d2e199_createUserDefinedSchema_file">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ File
+ </span>
+ <span class="format">
+ (binary)
+ </span>
+
+ <div class="inner description marked">
+multipartFile
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
</td>
</tr>
</table>
-
<h2>Responses</h2>
- <h3 id="examples-Groups-updateProvidedMembers-title-204"></h3>
- <p id="examples-Groups-updateProvidedMembers-description-204" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-201"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-201" class="marked"></p>
<script>
- var responseGroups204_description = `No Content`;
- var responseGroups204_description_break = responseGroups204_description.indexOf('\n');
- if (responseGroups204_description_break == -1) {
- $("#examples-Groups-updateProvidedMembers-title-204").text("Status: 204 - " + responseGroups204_description);
+ var responseUserDefinedSchemas201_description = `Created`;
+ var responseUserDefinedSchemas201_description_break = responseUserDefinedSchemas201_description.indexOf('\n');
+ if (responseUserDefinedSchemas201_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-201").text("Status: 201 - " + responseUserDefinedSchemas201_description);
} else {
- $("#examples-Groups-updateProvidedMembers-title-204").text("Status: 204 - " + responseGroups204_description.substring(0, responseGroups204_description_break));
- $("#examples-Groups-updateProvidedMembers-description-204").html(responseGroups204_description.substring(responseGroups204_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-201").text("Status: 201 - " + responseUserDefinedSchemas201_description.substring(0, responseUserDefinedSchemas201_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-201").html(responseUserDefinedSchemas201_description.substring(responseUserDefinedSchemas201_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateProvidedMembers-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-201" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-201-schema">Schema</a>
+ </li>
+
+ <li class="">
+ <a data-toggle="tab" href="#responses-createUserDefinedSchema-201-headers">Headers</a>
+ </li>
+
</ul>
- <div class="tab-content" id="responses-Groups-updateProvidedMembers-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateProvidedMembers-204-schema">
- <div id="responses-Groups-updateProvidedMembers-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-201-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-201-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-201" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "Created",
+ "headers" : {
+ "Location" : {
+ "description" : "Contains the URI of the newly created resource",
+ "required" : true,
+ "style" : "simple",
+ "explode" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UserDefinedSchema"
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateProvidedMembers-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateProvidedMembers-schema-204');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-201-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-201');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-updateProvidedMembers-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-201-schema-data' type='hidden' value=''></input>
</div>
- </div>
- <h3 id="examples-Groups-updateProvidedMembers-title-400"></h3>
- <p id="examples-Groups-updateProvidedMembers-description-400" class="marked"></p>
+ <div class="tab-pane" id="responses-createUserDefinedSchema-201-headers">
+ <table>
+ <tr>
+ <th width="150px">Name</th>
+ <th width="100px">Type</th>
+ <th width="100px">Format</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>Location</td>
+ <td>String</td>
+ <td></td>
+ <td>Contains the URI of the newly created resource</td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-400"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-400" class="marked"></p>
<script>
- var responseGroups400_description = `Bad Request`;
- var responseGroups400_description_break = responseGroups400_description.indexOf('\n');
- if (responseGroups400_description_break == -1) {
- $("#examples-Groups-updateProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description);
+ var responseUserDefinedSchemas400_description = `Bad Request`;
+ var responseUserDefinedSchemas400_description_break = responseUserDefinedSchemas400_description.indexOf('\n');
+ if (responseUserDefinedSchemas400_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description);
} else {
- $("#examples-Groups-updateProvidedMembers-title-400").text("Status: 400 - " + responseGroups400_description.substring(0, responseGroups400_description_break));
- $("#examples-Groups-updateProvidedMembers-description-400").html(responseGroups400_description.substring(responseGroups400_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description.substring(0, responseUserDefinedSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-400").html(responseUserDefinedSchemas400_description.substring(responseUserDefinedSchemas400_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateProvidedMembers-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-updateProvidedMembers-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-updateProvidedMembers-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateProvidedMembers-400-schema">
- <div id="responses-Groups-updateProvidedMembers-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-400-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateProvidedMembers-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateProvidedMembers-schema-400');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Groups-updateProvidedMembers-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Groups-updateProvidedMembers-title-500"></h3>
- <p id="examples-Groups-updateProvidedMembers-description-500" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-401"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-401" class="marked"></p>
<script>
- var responseGroups500_description = `Internal Server Error`;
- var responseGroups500_description_break = responseGroups500_description.indexOf('\n');
- if (responseGroups500_description_break == -1) {
- $("#examples-Groups-updateProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description);
+ var responseUserDefinedSchemas401_description = `Unauthorized`;
+ var responseUserDefinedSchemas401_description_break = responseUserDefinedSchemas401_description.indexOf('\n');
+ if (responseUserDefinedSchemas401_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description);
} else {
- $("#examples-Groups-updateProvidedMembers-title-500").text("Status: 500 - " + responseGroups500_description.substring(0, responseGroups500_description_break));
- $("#examples-Groups-updateProvidedMembers-description-500").html(responseGroups500_description.substring(responseGroups500_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description.substring(0, responseUserDefinedSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-401").html(responseUserDefinedSchemas401_description.substring(responseUserDefinedSchemas401_description_break));
}
</script>
- <ul id="responses-detail-Groups-updateProvidedMembers-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Groups-updateProvidedMembers-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Groups-updateProvidedMembers-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Groups-updateProvidedMembers-500-schema">
- <div id="responses-Groups-updateProvidedMembers-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-401-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
console.log(err);
});
}
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Groups-updateProvidedMembers-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Groups-updateProvidedMembers-schema-500');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Groups-updateProvidedMembers-500-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- </article>
- </div>
- <hr>
- </section>
- <section id="api-Schemas">
- <h1>Schemas</h1>
- <div id="api-Schemas-createSchema">
- <article id="api-Schemas-createSchema-0" data-group="User" data-name="createSchema" data-version="0">
- <div class="pull-left">
- <h1>createSchema</h1>
- <p>Create a new schema.</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Create a new schema. The request body contains the schema in YANG format.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/schemas</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-Schemas-createSchema-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-createSchema-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-createSchema-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-createSchema-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-createSchema-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-createSchema-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/problem+json" \
- -H "Content-Type: multipart/form-data" \
- "https://localhost/topology-inventory/v1alpha11/schemas"
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-Schemas-createSchema-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.SchemasApi;
-
-import java.io.File;
-import java.util.*;
-
-public class SchemasApiExample {
- public static void main(String[] args) {
-
- // Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
- String accept = application/json; // String |
- String contentType = multipart/form-data; // String |
- File file = BINARY_DATA_HERE; // File | multipartFile
-
- try {
- apiInstance.createSchema(accept, contentType, file);
- } catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#createSchema");
- e.printStackTrace();
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Schemas-createSchema-0-dart">
- <pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
-
-final api_instance = DefaultApi();
-
-final String accept = new String(); // String |
-final String contentType = new String(); // String |
-final File file = new File(); // File | multipartFile
-
-try {
- final result = await api_instance.createSchema(accept, contentType, file);
- print(result);
-} catch (e) {
- print('Exception when calling DefaultApi->createSchema: $e\n');
-}
-
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Schemas-createSchema-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-
-public class SchemasApiExample {
- public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
- String accept = application/json; // String |
- String contentType = multipart/form-data; // String |
- File file = BINARY_DATA_HERE; // File | multipartFile
-
- try {
- apiInstance.createSchema(accept, contentType, file);
- } catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#createSchema");
- e.printStackTrace();
- }
- }
-}</code></pre>
- </div>
- <!--
- <div class="tab-pane" id="examples-Schemas-createSchema-0-groovy">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div> -->
- <div class="tab-pane" id="examples-Schemas-createSchema-0-objc">
- <pre class="prettyprint"><code class="language-cpp">
-
-// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
-String *accept = application/json; // (default to application/json)
-String *contentType = multipart/form-data; // (default to multipart/form-data)
-File *file = BINARY_DATA_HERE; // multipartFile (default to null)
-
-// Create a new schema.
-[apiInstance createSchemaWith:accept
- contentType:contentType
- file:file
- completionHandler: ^(NSError* error) {
- if (error) {
- NSLog(@"Error: %@", error);
- }
-}];
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-Schemas-createSchema-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
-
-// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.SchemasApi()
-var accept = application/json; // {String}
-var contentType = multipart/form-data; // {String}
-var file = BINARY_DATA_HERE; // {File} multipartFile
-
-var callback = function(error, data, response) {
- if (error) {
- console.error(error);
- } else {
- console.log('API called successfully.');
- }
-};
-api.createSchema(accept, contentType, file, callback);
-</code></pre>
- </div>
-
- <!--<div class="tab-pane" id="examples-Schemas-createSchema-0-angular">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div>-->
- <div class="tab-pane" id="examples-Schemas-createSchema-0-csharp">
- <pre class="prettyprint"><code class="language-cs">using System;
-using System.Diagnostics;
-using Org.OpenAPITools.Api;
-using Org.OpenAPITools.Client;
-using Org.OpenAPITools.Model;
-
-namespace Example
-{
- public class createSchemaExample
- {
- public void main()
- {
-
- // Create an instance of the API class
- var apiInstance = new SchemasApi();
- var accept = application/json; // String | (default to application/json)
- var contentType = multipart/form-data; // String | (default to multipart/form-data)
- var file = BINARY_DATA_HERE; // File | multipartFile (default to null)
-
- try {
- // Create a new schema.
- apiInstance.createSchema(accept, contentType, file);
- } catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.createSchema: " + e.Message );
- }
- }
- }
-}
-</code></pre>
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-401-schema-data' type='hidden' value=''></input>
+ </div>
</div>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-403"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-403" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas403_description = `Forbidden`;
+ var responseUserDefinedSchemas403_description_break = responseUserDefinedSchemas403_description.indexOf('\n');
+ if (responseUserDefinedSchemas403_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description);
+ } else {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description.substring(0, responseUserDefinedSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-403").html(responseUserDefinedSchemas403_description.substring(responseUserDefinedSchemas403_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-Schemas-createSchema-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\SchemasApi();
-$accept = application/json; // String |
-$contentType = multipart/form-data; // String |
-$file = BINARY_DATA_HERE; // File | multipartFile
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-403-schema">Schema</a>
+ </li>
-try {
- $api_instance->createSchema($accept, $contentType, $file);
-} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->createSchema: ', $e->getMessage(), PHP_EOL;
-}
-?></code></pre>
- </div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-perl">
- <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
-use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
-# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
-my $accept = application/json; # String |
-my $contentType = multipart/form-data; # String |
-my $file = BINARY_DATA_HERE; # File | multipartFile
-eval {
- $api_instance->createSchema(accept => $accept, contentType => $contentType, file => $file);
-};
-if ($@) {
- warn "Exception when calling SchemasApi->createSchema: $@\n";
-}</code></pre>
- </div>
+ </ul>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-python">
- <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-# Create an instance of the API class
-api_instance = openapi_client.SchemasApi()
-accept = application/json # String | (default to application/json)
-contentType = multipart/form-data # String | (default to multipart/form-data)
-file = BINARY_DATA_HERE # File | multipartFile (default to null)
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-403-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
-try:
- # Create a new schema.
- api_instance.create_schema(accept, contentType, file)
-except ApiException as e:
- print("Exception when calling SchemasApi->createSchema: %s\n" % e)</code></pre>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-403-schema-data' type='hidden' value=''></input>
+ </div>
</div>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-404"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-404" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas404_description = `Not Found`;
+ var responseUserDefinedSchemas404_description_break = responseUserDefinedSchemas404_description.indexOf('\n');
+ if (responseUserDefinedSchemas404_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description);
+ } else {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description.substring(0, responseUserDefinedSchemas404_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-404").html(responseUserDefinedSchemas404_description.substring(responseUserDefinedSchemas404_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
-pub fn main() {
- let accept = application/json; // String
- let contentType = multipart/form-data; // String
- let file = BINARY_DATA_HERE; // File
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-404-schema">Schema</a>
+ </li>
- let mut context = SchemasApi::Context::default();
- let result = client.createSchema(accept, contentType, file, &context).wait();
- println!("{:?}", result);
-}
-</code></pre>
- </div>
- </div>
- <h2>Scopes</h2>
- <table>
-
- </table>
- <h2>Parameters</h2>
+ </ul>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-404-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-409"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-409" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas409_description = `Conflict`;
+ var responseUserDefinedSchemas409_description_break = responseUserDefinedSchemas409_description.indexOf('\n');
+ if (responseUserDefinedSchemas409_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-409").text("Status: 409 - " + responseUserDefinedSchemas409_description);
+ } else {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-409").text("Status: 409 - " + responseUserDefinedSchemas409_description.substring(0, responseUserDefinedSchemas409_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-409").html(responseUserDefinedSchemas409_description.substring(responseUserDefinedSchemas409_description_break));
+ }
+ </script>
- <div id="d2e199_createSchema_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-409" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-409-schema">Schema</a>
+ </li>
- <tr><td style="width:150px;">Content-Type*</td>
-<td>
- <div id="d2e199_createSchema_contentType">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-409-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-409" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Conflict",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- </table>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-409');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-409-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-411"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-411" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas411_description = `Length Required`;
+ var responseUserDefinedSchemas411_description_break = responseUserDefinedSchemas411_description.indexOf('\n');
+ if (responseUserDefinedSchemas411_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-411").text("Status: 411 - " + responseUserDefinedSchemas411_description);
+ } else {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-411").text("Status: 411 - " + responseUserDefinedSchemas411_description.substring(0, responseUserDefinedSchemas411_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-411").html(responseUserDefinedSchemas411_description.substring(responseUserDefinedSchemas411_description_break));
+ }
+ </script>
- <div class="methodsubtabletitle">Form parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">file*</td>
-<td>
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-411" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-411-schema">Schema</a>
+ </li>
- <div id="d2e199_createSchema_file">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- File
- </span>
- <span class="format">
- (binary)
- </span>
- <div class="inner description marked">
-multipartFile
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ </ul>
- <h2>Responses</h2>
- <h3 id="examples-Schemas-createSchema-title-201"></h3>
- <p id="examples-Schemas-createSchema-description-201" class="marked"></p>
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-411-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-411-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-411" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Length Required",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-411-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-411');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-411-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-413"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-413" class="marked"></p>
<script>
- var responseSchemas201_description = `Created without response body`;
- var responseSchemas201_description_break = responseSchemas201_description.indexOf('\n');
- if (responseSchemas201_description_break == -1) {
- $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description);
+ var responseUserDefinedSchemas413_description = `Payload Too Large`;
+ var responseUserDefinedSchemas413_description_break = responseUserDefinedSchemas413_description.indexOf('\n');
+ if (responseUserDefinedSchemas413_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-413").text("Status: 413 - " + responseUserDefinedSchemas413_description);
} else {
- $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description.substring(0, responseSchemas201_description_break));
- $("#examples-Schemas-createSchema-description-201").html(responseSchemas201_description.substring(responseSchemas201_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-413").text("Status: 413 - " + responseUserDefinedSchemas413_description.substring(0, responseUserDefinedSchemas413_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-413").html(responseUserDefinedSchemas413_description.substring(responseUserDefinedSchemas413_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-201" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-413" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-413-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-201-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-201-schema">
- <div id="responses-Schemas-createSchema-schema-201" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-413-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-413-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-413" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Created without response body"
+ "description" : "Payload Too Large",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-201-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-201');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-413-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-413');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-201-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-413-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-400"></h3>
- <p id="examples-Schemas-createSchema-description-400" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-415"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-415" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseUserDefinedSchemas415_description = `Unsupported Media Type`;
+ var responseUserDefinedSchemas415_description_break = responseUserDefinedSchemas415_description.indexOf('\n');
+ if (responseUserDefinedSchemas415_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-415").text("Status: 415 - " + responseUserDefinedSchemas415_description);
} else {
- $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-createSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-415").text("Status: 415 - " + responseUserDefinedSchemas415_description.substring(0, responseUserDefinedSchemas415_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-415").html(responseUserDefinedSchemas415_description.substring(responseUserDefinedSchemas415_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-415" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-415-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-400-schema">
- <div id="responses-Schemas-createSchema-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-415-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-415-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-415" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Unsupported Media Type",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-400');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-415-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-415');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-415-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-401"></h3>
- <p id="examples-Schemas-createSchema-description-401" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-429"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-429" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseUserDefinedSchemas429_description = `Too Many Requests`;
+ var responseUserDefinedSchemas429_description_break = responseUserDefinedSchemas429_description.indexOf('\n');
+ if (responseUserDefinedSchemas429_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description);
} else {
- $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-createSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description.substring(0, responseUserDefinedSchemas429_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-429").html(responseUserDefinedSchemas429_description.substring(responseUserDefinedSchemas429_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-401-schema">
- <div id="responses-Schemas-createSchema-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-429-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Too Many Requests",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-401');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-403"></h3>
- <p id="examples-Schemas-createSchema-description-403" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-500"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-500" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseUserDefinedSchemas500_description = `Internal Server Error`;
+ var responseUserDefinedSchemas500_description_break = responseUserDefinedSchemas500_description.indexOf('\n');
+ if (responseUserDefinedSchemas500_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description);
} else {
- $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-createSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description.substring(0, responseUserDefinedSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-500").html(responseUserDefinedSchemas500_description.substring(responseUserDefinedSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-403-schema">
- <div id="responses-Schemas-createSchema-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-500-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-403');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-409"></h3>
- <p id="examples-Schemas-createSchema-description-409" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-502"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-502" class="marked"></p>
<script>
- var responseSchemas409_description = `Conflict`;
- var responseSchemas409_description_break = responseSchemas409_description.indexOf('\n');
- if (responseSchemas409_description_break == -1) {
- $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description);
+ var responseUserDefinedSchemas502_description = `Bad Gateway`;
+ var responseUserDefinedSchemas502_description_break = responseUserDefinedSchemas502_description.indexOf('\n');
+ if (responseUserDefinedSchemas502_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description);
} else {
- $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description.substring(0, responseSchemas409_description_break));
- $("#examples-Schemas-createSchema-description-409").html(responseSchemas409_description.substring(responseSchemas409_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description.substring(0, responseUserDefinedSchemas502_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-502").html(responseUserDefinedSchemas502_description.substring(responseUserDefinedSchemas502_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-409" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-409-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-409-schema">
- <div id="responses-Schemas-createSchema-schema-409" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-502-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Conflict",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "409",
- "title" : "Conflicting request",
- "details" : "The request cannot be processed as the resource is in use."
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-409');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-409-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-500"></h3>
- <p id="examples-Schemas-createSchema-description-500" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-createUserDefinedSchema-title-503"></h3>
+ <p id="examples-UserDefinedSchemas-createUserDefinedSchema-description-503" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseUserDefinedSchemas503_description = `Service Unavailable`;
+ var responseUserDefinedSchemas503_description_break = responseUserDefinedSchemas503_description.indexOf('\n');
+ if (responseUserDefinedSchemas503_description_break == -1) {
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description);
} else {
- $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-createSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description.substring(0, responseUserDefinedSchemas503_description_break));
+ $("#examples-UserDefinedSchemas-createUserDefinedSchema-description-503").html(responseUserDefinedSchemas503_description.substring(responseUserDefinedSchemas503_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-createUserDefinedSchema-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-createUserDefinedSchema-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-500-schema">
- <div id="responses-Schemas-createSchema-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-createUserDefinedSchema-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-createUserDefinedSchema-503-schema">
+ <div id="responses-UserDefinedSchemas-createUserDefinedSchema-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-500');
+ $('#responses-UserDefinedSchemas-createUserDefinedSchema-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-createUserDefinedSchema-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-createUserDefinedSchema-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Schemas-deleteSchema">
- <article id="api-Schemas-deleteSchema-0" data-group="User" data-name="deleteSchema" data-version="0">
+ <div id="api-UserDefinedSchemas-deleteUserDefinedSchema">
+ <article id="api-UserDefinedSchemas-deleteUserDefinedSchema-0" data-group="User" data-name="deleteUserDefinedSchema" data-version="0">
<div class="pull-left">
- <h1>deleteSchema</h1>
- <p>Delete a schema.</p>
+ <h1>deleteUserDefinedSchema</h1>
+ <p>Delete a user defined schema.</p>
</div>
<div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Delete a schema.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/schemas/{schemaName}</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-Schemas-deleteSchema-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-deleteSchema-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-deleteSchema-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-rust">Rust</a></li>
+ <div class="clearfix"></div>
+ <p></p>
+ <p class="marked">Delete a user defined schema.</p>
+ <p></p>
+ <br />
+ <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/user-defined-schemas/{schemaName}</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-UserDefinedSchemas-deleteUserDefinedSchema-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-java">Java</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-php">PHP</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-python">Python</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-deleteUserDefinedSchema-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-deleteSchema-0-curl">
+ <div class="tab-pane active" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
-H "Accept: application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/schemas/{schemaName}"
+ "https://localhost/topology-inventory/v1/user-defined-schemas/{schemaName}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-java">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-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.SchemasApi;
+import org.openapitools.client.api.UserDefinedSchemasApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
String accept = application/json; // String |
String schemaName = schemaName_example; // String |
try {
- apiInstance.deleteSchema(accept, schemaName);
+ apiInstance.deleteUserDefinedSchema(accept, schemaName);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#deleteSchema");
+ System.err.println("Exception when calling UserDefinedSchemasApi#deleteUserDefinedSchema");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-dart">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String schemaName = new String(); // String |
try {
- final result = await api_instance.deleteSchema(accept, schemaName);
+ final result = await api_instance.deleteUserDefinedSchema(accept, schemaName);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->deleteSchema: $e\n');
+ print('Exception when calling DefaultApi->deleteUserDefinedSchema: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.UserDefinedSchemasApi;
-public class SchemasApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
String accept = application/json; // String |
String schemaName = schemaName_example; // String |
try {
- apiInstance.deleteSchema(accept, schemaName);
+ apiInstance.deleteUserDefinedSchema(accept, schemaName);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#deleteSchema");
+ System.err.println("Exception when calling UserDefinedSchemasApi#deleteUserDefinedSchema");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-groovy">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-objc">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
+UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = application/json; // (default to application/json)
String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
-// Delete a schema.
-[apiInstance deleteSchemaWith:accept
+// Delete a user defined schema.
+[apiInstance deleteUserDefinedSchemaWith:accept
schemaName:schemaName
completionHandler: ^(NSError* error) {
if (error) {
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-javascript">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.SchemasApi()
+var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = application/json; // {String}
var schemaName = schemaName_example; // {String}
console.log('API called successfully.');
}
};
-api.deleteSchema(accept, schemaName, callback);
+api.deleteUserDefinedSchema(accept, schemaName, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-deleteSchema-0-angular">
+ <!--<div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-csharp">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class deleteSchemaExample
+ public class deleteUserDefinedSchemaExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
+ var apiInstance = new UserDefinedSchemasApi();
var accept = application/json; // String | (default to application/json)
var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
try {
- // Delete a schema.
- apiInstance.deleteSchema(accept, schemaName);
+ // Delete a user defined schema.
+ apiInstance.deleteUserDefinedSchema(accept, schemaName);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.deleteSchema: " + e.Message );
+ Debug.Print("Exception when calling UserDefinedSchemasApi.deleteUserDefinedSchema: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-php">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-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\SchemasApi();
+$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
$accept = application/json; // String |
$schemaName = schemaName_example; // String |
try {
- $api_instance->deleteSchema($accept, $schemaName);
+ $api_instance->deleteUserDefinedSchema($accept, $schemaName);
} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->deleteSchema: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling UserDefinedSchemasApi->deleteUserDefinedSchema: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-perl">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+use WWW::OPenAPIClient::UserDefinedSchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
my $accept = application/json; # String |
my $schemaName = schemaName_example; # String |
eval {
- $api_instance->deleteSchema(accept => $accept, schemaName => $schemaName);
+ $api_instance->deleteUserDefinedSchema(accept => $accept, schemaName => $schemaName);
};
if ($@) {
- warn "Exception when calling SchemasApi->deleteSchema: $@\n";
+ warn "Exception when calling UserDefinedSchemasApi->deleteUserDefinedSchema: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-python">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-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.SchemasApi()
+api_instance = openapi_client.UserDefinedSchemasApi()
accept = application/json # String | (default to application/json)
schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
try:
- # Delete a schema.
- api_instance.delete_schema(accept, schemaName)
+ # Delete a user defined schema.
+ api_instance.delete_user_defined_schema(accept, schemaName)
except ApiException as e:
- print("Exception when calling SchemasApi->deleteSchema: %s\n" % e)</code></pre>
+ print("Exception when calling UserDefinedSchemasApi->deleteUserDefinedSchema: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-deleteUserDefinedSchema-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate UserDefinedSchemasApi;
pub fn main() {
let accept = application/json; // String
let schemaName = schemaName_example; // String
- let mut context = SchemasApi::Context::default();
- let result = client.deleteSchema(accept, schemaName, &context).wait();
+ let mut context = UserDefinedSchemasApi::Context::default();
+ let result = client.deleteUserDefinedSchema(accept, schemaName, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_deleteSchema_schemaName">
+ <div id="d2e199_deleteUserDefinedSchema_schemaName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_deleteUserDefinedSchema_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
- <div id="d2e199_deleteSchema_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
+ <h2>Responses</h2>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-204"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-204" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas204_description = `No Content`;
+ var responseUserDefinedSchemas204_description_break = responseUserDefinedSchemas204_description.indexOf('\n');
+ if (responseUserDefinedSchemas204_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-204").text("Status: 204 - " + responseUserDefinedSchemas204_description);
+ } else {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-204").text("Status: 204 - " + responseUserDefinedSchemas204_description.substring(0, responseUserDefinedSchemas204_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-204").html(responseUserDefinedSchemas204_description.substring(responseUserDefinedSchemas204_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-204" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-204-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-204" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "No Content",
+ "content" : { }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-204');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-204-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-400"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-400" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas400_description = `Bad Request`;
+ var responseUserDefinedSchemas400_description_break = responseUserDefinedSchemas400_description.indexOf('\n');
+ if (responseUserDefinedSchemas400_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description);
+ } else {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description.substring(0, responseUserDefinedSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-400").html(responseUserDefinedSchemas400_description.substring(responseUserDefinedSchemas400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-400-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-401"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-401" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas401_description = `Unauthorized`;
+ var responseUserDefinedSchemas401_description_break = responseUserDefinedSchemas401_description.indexOf('\n');
+ if (responseUserDefinedSchemas401_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description);
+ } else {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description.substring(0, responseUserDefinedSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-401").html(responseUserDefinedSchemas401_description.substring(responseUserDefinedSchemas401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-401-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-403"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-403" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas403_description = `Forbidden`;
+ var responseUserDefinedSchemas403_description_break = responseUserDefinedSchemas403_description.indexOf('\n');
+ if (responseUserDefinedSchemas403_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description);
+ } else {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description.substring(0, responseUserDefinedSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-403").html(responseUserDefinedSchemas403_description.substring(responseUserDefinedSchemas403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-403-schema">Schema</a>
+ </li>
+
+
- </table>
+ </ul>
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-403-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Responses</h2>
- <h3 id="examples-Schemas-deleteSchema-title-204"></h3>
- <p id="examples-Schemas-deleteSchema-description-204" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-404"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-404" class="marked"></p>
<script>
- var responseSchemas204_description = `No Content`;
- var responseSchemas204_description_break = responseSchemas204_description.indexOf('\n');
- if (responseSchemas204_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description);
+ var responseUserDefinedSchemas404_description = `Not Found`;
+ var responseUserDefinedSchemas404_description_break = responseUserDefinedSchemas404_description.indexOf('\n');
+ if (responseUserDefinedSchemas404_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description);
} else {
- $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description.substring(0, responseSchemas204_description_break));
- $("#examples-Schemas-deleteSchema-description-204").html(responseSchemas204_description.substring(responseSchemas204_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description.substring(0, responseUserDefinedSchemas404_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-404").html(responseUserDefinedSchemas404_description.substring(responseUserDefinedSchemas404_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-404-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-204-schema">
- <div id="responses-Schemas-deleteSchema-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-404-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-204');
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-400"></h3>
- <p id="examples-Schemas-deleteSchema-description-400" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-429"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-429" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseUserDefinedSchemas429_description = `Too Many Requests`;
+ var responseUserDefinedSchemas429_description_break = responseUserDefinedSchemas429_description.indexOf('\n');
+ if (responseUserDefinedSchemas429_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description);
} else {
- $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-deleteSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description.substring(0, responseUserDefinedSchemas429_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-429").html(responseUserDefinedSchemas429_description.substring(responseUserDefinedSchemas429_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-400-schema">
- <div id="responses-Schemas-deleteSchema-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-429-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Too Many Requests",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-400');
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-401"></h3>
- <p id="examples-Schemas-deleteSchema-description-401" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-500"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-500" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseUserDefinedSchemas500_description = `Internal Server Error`;
+ var responseUserDefinedSchemas500_description_break = responseUserDefinedSchemas500_description.indexOf('\n');
+ if (responseUserDefinedSchemas500_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description);
} else {
- $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-deleteSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description.substring(0, responseUserDefinedSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-500").html(responseUserDefinedSchemas500_description.substring(responseUserDefinedSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-401-schema">
- <div id="responses-Schemas-deleteSchema-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-500-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-401');
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-403"></h3>
- <p id="examples-Schemas-deleteSchema-description-403" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-502"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-502" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseUserDefinedSchemas502_description = `Bad Gateway`;
+ var responseUserDefinedSchemas502_description_break = responseUserDefinedSchemas502_description.indexOf('\n');
+ if (responseUserDefinedSchemas502_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description);
} else {
- $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-deleteSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description.substring(0, responseUserDefinedSchemas502_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-502").html(responseUserDefinedSchemas502_description.substring(responseUserDefinedSchemas502_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-403-schema">
- <div id="responses-Schemas-deleteSchema-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-502-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-403');
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-500"></h3>
- <p id="examples-Schemas-deleteSchema-description-500" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-deleteUserDefinedSchema-title-503"></h3>
+ <p id="examples-UserDefinedSchemas-deleteUserDefinedSchema-description-503" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseUserDefinedSchemas503_description = `Service Unavailable`;
+ var responseUserDefinedSchemas503_description_break = responseUserDefinedSchemas503_description.indexOf('\n');
+ if (responseUserDefinedSchemas503_description_break == -1) {
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description);
} else {
- $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-deleteSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description.substring(0, responseUserDefinedSchemas503_description_break));
+ $("#examples-UserDefinedSchemas-deleteUserDefinedSchema-description-503").html(responseUserDefinedSchemas503_description.substring(responseUserDefinedSchemas503_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-deleteUserDefinedSchema-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-deleteUserDefinedSchema-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-500-schema">
- <div id="responses-Schemas-deleteSchema-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-deleteUserDefinedSchema-503-schema">
+ <div id="responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-500');
+ $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-deleteUserDefinedSchema-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-deleteUserDefinedSchema-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Schemas-getSchemaByName">
- <article id="api-Schemas-getSchemaByName-0" data-group="User" data-name="getSchemaByName" data-version="0">
+ <div id="api-UserDefinedSchemas-getUserDefinedSchemaByName">
+ <article id="api-UserDefinedSchemas-getUserDefinedSchemaByName-0" data-group="User" data-name="getUserDefinedSchemaByName" data-version="0">
<div class="pull-left">
- <h1>getSchemaByName</h1>
- <p>Get the model schema.</p>
+ <h1>getUserDefinedSchemaByName</h1>
+ <p>Get the user defined model schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get the model schema by name.</p>
+ <p class="marked">Get the user defined model schema by name.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas/{schemaName}/content</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/user-defined-schemas/{schemaName}/content</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-Schemas-getSchemaByName-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-java">Java</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-php">PHP</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-python">Python</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-getSchemaByName-0-curl">
+ <div class="tab-pane active" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: text/plain,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/schemas/{schemaName}/content"
+ "https://localhost/topology-inventory/v1/user-defined-schemas/{schemaName}/content"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-java">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-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.SchemasApi;
+import org.openapitools.client.api.UserDefinedSchemasApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
- String accept = application/json; // String |
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
+ String accept = accept_example; // String |
String schemaName = schemaName_example; // String |
try {
- 'String' result = apiInstance.getSchemaByName(accept, schemaName);
+ 'String' result = apiInstance.getUserDefinedSchemaByName(accept, schemaName);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemaByName");
+ System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemaByName");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-dart">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String schemaName = new String(); // String |
try {
- final result = await api_instance.getSchemaByName(accept, schemaName);
+ final result = await api_instance.getUserDefinedSchemaByName(accept, schemaName);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getSchemaByName: $e\n');
+ print('Exception when calling DefaultApi->getUserDefinedSchemaByName: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.UserDefinedSchemasApi;
-public class SchemasApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
- String accept = application/json; // String |
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
+ String accept = accept_example; // String |
String schemaName = schemaName_example; // String |
try {
- 'String' result = apiInstance.getSchemaByName(accept, schemaName);
+ 'String' result = apiInstance.getUserDefinedSchemaByName(accept, schemaName);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemaByName");
+ System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemaByName");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-groovy">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-objc">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
-String *accept = application/json; // (default to application/json)
+UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
+String *accept = accept_example; // (default to text/plain)
String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
-// Get the model schema.
-[apiInstance getSchemaByNameWith:accept
+// Get the user defined model schema.
+[apiInstance getUserDefinedSchemaByNameWith:accept
schemaName:schemaName
completionHandler: ^('String' output, NSError* error) {
if (output) {
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-javascript">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.SchemasApi()
-var accept = application/json; // {String}
+var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
+var accept = accept_example; // {String}
var schemaName = schemaName_example; // {String}
var callback = function(error, data, response) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getSchemaByName(accept, schemaName, callback);
+api.getUserDefinedSchemaByName(accept, schemaName, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-getSchemaByName-0-angular">
+ <!--<div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-csharp">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getSchemaByNameExample
+ public class getUserDefinedSchemaByNameExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
- var accept = application/json; // String | (default to application/json)
+ var apiInstance = new UserDefinedSchemasApi();
+ var accept = accept_example; // String | (default to text/plain)
var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
try {
- // Get the model schema.
- 'String' result = apiInstance.getSchemaByName(accept, schemaName);
+ // Get the user defined model schema.
+ 'String' result = apiInstance.getUserDefinedSchemaByName(accept, schemaName);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.getSchemaByName: " + e.Message );
+ Debug.Print("Exception when calling UserDefinedSchemasApi.getUserDefinedSchemaByName: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-php">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-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\SchemasApi();
-$accept = application/json; // String |
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
+$accept = accept_example; // String |
$schemaName = schemaName_example; // String |
try {
- $result = $api_instance->getSchemaByName($accept, $schemaName);
+ $result = $api_instance->getUserDefinedSchemaByName($accept, $schemaName);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->getSchemaByName: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling UserDefinedSchemasApi->getUserDefinedSchemaByName: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-perl">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+use WWW::OPenAPIClient::UserDefinedSchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
-my $accept = application/json; # String |
+my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
+my $accept = accept_example; # String |
my $schemaName = schemaName_example; # String |
eval {
- my $result = $api_instance->getSchemaByName(accept => $accept, schemaName => $schemaName);
+ my $result = $api_instance->getUserDefinedSchemaByName(accept => $accept, schemaName => $schemaName);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling SchemasApi->getSchemaByName: $@\n";
+ warn "Exception when calling UserDefinedSchemasApi->getUserDefinedSchemaByName: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-python">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-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.SchemasApi()
-accept = application/json # String | (default to application/json)
+api_instance = openapi_client.UserDefinedSchemasApi()
+accept = accept_example # String | (default to text/plain)
schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
try:
- # Get the model schema.
- api_response = api_instance.get_schema_by_name(accept, schemaName)
+ # Get the user defined model schema.
+ api_response = api_instance.get_user_defined_schema_by_name(accept, schemaName)
pprint(api_response)
except ApiException as e:
- print("Exception when calling SchemasApi->getSchemaByName: %s\n" % e)</code></pre>
+ print("Exception when calling UserDefinedSchemasApi->getUserDefinedSchemaByName: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate UserDefinedSchemasApi;
pub fn main() {
- let accept = application/json; // String
+ let accept = accept_example; // String
let schemaName = schemaName_example; // String
- let mut context = SchemasApi::Context::default();
- let result = client.getSchemaByName(accept, schemaName, &context).wait();
+ let mut context = UserDefinedSchemasApi::Context::default();
+ let result = client.getUserDefinedSchemaByName(accept, schemaName, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_getSchemaByName_schemaName">
+ <div id="d2e199_getUserDefinedSchemaByName_schemaName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getUserDefinedSchemaByName_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- </table>
+ </table>
+
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-200"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-200" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas200_description = `OK`;
+ var responseUserDefinedSchemas200_description_break = responseUserDefinedSchemas200_description.indexOf('\n');
+ if (responseUserDefinedSchemas200_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-200").text("Status: 200 - " + responseUserDefinedSchemas200_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-200").text("Status: 200 - " + responseUserDefinedSchemas200_description.substring(0, responseUserDefinedSchemas200_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-200").html(responseUserDefinedSchemas200_description.substring(responseUserDefinedSchemas200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-200-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "text/plain" : {
+ "schema" : {
+ "type" : "string"
+ },
+ "examples" : {
+ "schema" : {
+ "$ref" : "#/components/examples/SchemaResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-400"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-400" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas400_description = `Bad Request`;
+ var responseUserDefinedSchemas400_description_break = responseUserDefinedSchemas400_description.indexOf('\n');
+ if (responseUserDefinedSchemas400_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description.substring(0, responseUserDefinedSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-400").html(responseUserDefinedSchemas400_description.substring(responseUserDefinedSchemas400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-400-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-400-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-401"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-401" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas401_description = `Unauthorized`;
+ var responseUserDefinedSchemas401_description_break = responseUserDefinedSchemas401_description.indexOf('\n');
+ if (responseUserDefinedSchemas401_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description.substring(0, responseUserDefinedSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-401").html(responseUserDefinedSchemas401_description.substring(responseUserDefinedSchemas401_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-401-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-401-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-401-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-403"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-403" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas403_description = `Forbidden`;
+ var responseUserDefinedSchemas403_description_break = responseUserDefinedSchemas403_description.indexOf('\n');
+ if (responseUserDefinedSchemas403_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description.substring(0, responseUserDefinedSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-403").html(responseUserDefinedSchemas403_description.substring(responseUserDefinedSchemas403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-403-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-404"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-404" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas404_description = `Not Found`;
+ var responseUserDefinedSchemas404_description_break = responseUserDefinedSchemas404_description.indexOf('\n');
+ if (responseUserDefinedSchemas404_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description.substring(0, responseUserDefinedSchemas404_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-404").html(responseUserDefinedSchemas404_description.substring(responseUserDefinedSchemas404_description_break));
+ }
+ </script>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-404-schema">Schema</a>
+ </li>
- <div id="d2e199_getSchemaByName_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ </ul>
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-404-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <h2>Responses</h2>
- <h3 id="examples-Schemas-getSchemaByName-title-200"></h3>
- <p id="examples-Schemas-getSchemaByName-description-200" class="marked"></p>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-406"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-406" class="marked"></p>
<script>
- var responseSchemas200_description = `OK`;
- var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
- if (responseSchemas200_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description);
+ var responseUserDefinedSchemas406_description = `Not Acceptable`;
+ var responseUserDefinedSchemas406_description_break = responseUserDefinedSchemas406_description.indexOf('\n');
+ if (responseUserDefinedSchemas406_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-406").text("Status: 406 - " + responseUserDefinedSchemas406_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
- $("#examples-Schemas-getSchemaByName-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-406").text("Status: 406 - " + responseUserDefinedSchemas406_description.substring(0, responseUserDefinedSchemas406_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-406").html(responseUserDefinedSchemas406_description.substring(responseUserDefinedSchemas406_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-406" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-406-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-200-schema">
- <div id="responses-Schemas-getSchemaByName-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-406-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-406" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Not Acceptable",
"content" : {
- "text/plain" : {
+ "application/problem+json" : {
"schema" : {
- "type" : "string"
- },
- "examples" : {
- "schema" : {
- "$ref" : "#/components/examples/SchemaResponseExample"
- }
+ "$ref" : "#/components/schemas/ErrorMessage"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-200');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-406');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-406-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-400"></h3>
- <p id="examples-Schemas-getSchemaByName-description-400" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-414"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-414" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseUserDefinedSchemas414_description = `URI Too Large`;
+ var responseUserDefinedSchemas414_description_break = responseUserDefinedSchemas414_description.indexOf('\n');
+ if (responseUserDefinedSchemas414_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-414").text("Status: 414 - " + responseUserDefinedSchemas414_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-getSchemaByName-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-414").text("Status: 414 - " + responseUserDefinedSchemas414_description.substring(0, responseUserDefinedSchemas414_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-414").html(responseUserDefinedSchemas414_description.substring(responseUserDefinedSchemas414_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-414" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-414-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-400-schema">
- <div id="responses-Schemas-getSchemaByName-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-414-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-414" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "URI Too Large",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-400');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-414');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-414-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-401"></h3>
- <p id="examples-Schemas-getSchemaByName-description-401" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-429"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-429" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseUserDefinedSchemas429_description = `Too Many Requests`;
+ var responseUserDefinedSchemas429_description_break = responseUserDefinedSchemas429_description.indexOf('\n');
+ if (responseUserDefinedSchemas429_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-getSchemaByName-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description.substring(0, responseUserDefinedSchemas429_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-429").html(responseUserDefinedSchemas429_description.substring(responseUserDefinedSchemas429_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-401-schema">
- <div id="responses-Schemas-getSchemaByName-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-429-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Too Many Requests",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-401');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-403"></h3>
- <p id="examples-Schemas-getSchemaByName-description-403" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-500"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-500" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseUserDefinedSchemas500_description = `Internal Server Error`;
+ var responseUserDefinedSchemas500_description_break = responseUserDefinedSchemas500_description.indexOf('\n');
+ if (responseUserDefinedSchemas500_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-getSchemaByName-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description.substring(0, responseUserDefinedSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-500").html(responseUserDefinedSchemas500_description.substring(responseUserDefinedSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-403-schema">
- <div id="responses-Schemas-getSchemaByName-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-500-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-403');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-404"></h3>
- <p id="examples-Schemas-getSchemaByName-description-404" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-502"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-502" class="marked"></p>
<script>
- var responseSchemas404_description = `Not Found`;
- var responseSchemas404_description_break = responseSchemas404_description.indexOf('\n');
- if (responseSchemas404_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description);
+ var responseUserDefinedSchemas502_description = `Bad Gateway`;
+ var responseUserDefinedSchemas502_description_break = responseUserDefinedSchemas502_description.indexOf('\n');
+ if (responseUserDefinedSchemas502_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description.substring(0, responseSchemas404_description_break));
- $("#examples-Schemas-getSchemaByName-description-404").html(responseSchemas404_description.substring(responseSchemas404_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description.substring(0, responseUserDefinedSchemas502_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-502").html(responseUserDefinedSchemas502_description.substring(responseUserDefinedSchemas502_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-404-schema">
- <div id="responses-Schemas-getSchemaByName-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-502-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-404');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-500"></h3>
- <p id="examples-Schemas-getSchemaByName-description-500" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-503"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-503" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseUserDefinedSchemas503_description = `Service Unavailable`;
+ var responseUserDefinedSchemas503_description_break = responseUserDefinedSchemas503_description.indexOf('\n');
+ if (responseUserDefinedSchemas503_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-getSchemaByName-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description.substring(0, responseUserDefinedSchemas503_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemaByName-description-503").html(responseUserDefinedSchemas503_description.substring(responseUserDefinedSchemas503_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemaByName-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemaByName-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-500-schema">
- <div id="responses-Schemas-getSchemaByName-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-503-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-500');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemaByName-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemaByName-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Schemas-getSchemas">
- <article id="api-Schemas-getSchemas-0" data-group="User" data-name="getSchemas" data-version="0">
+ <div id="api-UserDefinedSchemas-getUserDefinedSchemas">
+ <article id="api-UserDefinedSchemas-getUserDefinedSchemas-0" data-group="User" data-name="getUserDefinedSchemas" data-version="0">
<div class="pull-left">
- <h1>getSchemas</h1>
- <p>Get a list of all schemas.</p>
+ <h1>getUserDefinedSchemas</h1>
+ <p>Get a list of all used defined schemas.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get a list of all schemas.</p>
+ <p class="marked">Get a list of all user defined schemas.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/user-defined-schemas</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-Schemas-getSchemas-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemas-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemas-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemas-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemas-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-java">Java</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-php">PHP</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-python">Python</a></li>
+ <li class=""><a href="#examples-UserDefinedSchemas-getUserDefinedSchemas-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-getSchemas-0-curl">
+ <div class="tab-pane active" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/schemas?domain=RAN&offset=56&limit=56"
+ "https://localhost/topology-inventory/v1/user-defined-schemas?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-java">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-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.SchemasApi;
+import org.openapitools.client.api.UserDefinedSchemasApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
String accept = application/json; // String |
- String domain = RAN; // String |
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
+ UserDefinedSchemas result = apiInstance.getUserDefinedSchemas(accept, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemas");
+ System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemas");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-dart">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String domain = new String(); // String |
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.
try {
- final result = await api_instance.getSchemas(accept, domain, offset, limit);
+ final result = await api_instance.getUserDefinedSchemas(accept, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getSchemas: $e\n');
+ print('Exception when calling DefaultApi->getUserDefinedSchemas: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.UserDefinedSchemasApi;
-public class SchemasApiExample {
+public class UserDefinedSchemasApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
+ UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
String accept = application/json; // String |
- String domain = RAN; // String |
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
+ UserDefinedSchemas result = apiInstance.getUserDefinedSchemas(accept, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemas");
+ System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemas");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-groovy">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-objc">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
+UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *domain = RAN; // (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Get a list of all schemas.
-[apiInstance getSchemasWith:accept
- domain:domain
+// Get a list of all used defined schemas.
+[apiInstance getUserDefinedSchemasWith:accept
offset:offset
limit:limit
- completionHandler: ^(SchemaList output, NSError* error) {
+ completionHandler: ^(UserDefinedSchemas output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-javascript">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-javascript">
<pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyExposureAndInventoryApi.SchemasApi()
+var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = application/json; // {String}
var opts = {
- 'domain': RAN, // {String}
'offset': 56, // {Integer} Pagination offset.
'limit': 56 // {Integer} Result limiter.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getSchemas(accept, opts, callback);
+api.getUserDefinedSchemas(accept, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-getSchemas-0-angular">
+ <!--<div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-csharp">
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getSchemasExample
+ public class getUserDefinedSchemasExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
+ var apiInstance = new UserDefinedSchemasApi();
var accept = application/json; // String | (default to application/json)
- var domain = RAN; // String | (optional) (default to null)
var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Get a list of all schemas.
- SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
+ // Get a list of all used defined schemas.
+ UserDefinedSchemas result = apiInstance.getUserDefinedSchemas(accept, offset, limit);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.getSchemas: " + e.Message );
+ Debug.Print("Exception when calling UserDefinedSchemasApi.getUserDefinedSchemas: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-php">
- <pre class="prettyprint"><code class="language-php"><?php
-require_once(__DIR__ . '/vendor/autoload.php');
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-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\UserDefinedSchemasApi();
+$accept = application/json; // String |
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
+
+try {
+ $result = $api_instance->getUserDefinedSchemas($accept, $offset, $limit);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling UserDefinedSchemasApi->getUserDefinedSchemas: ', $e->getMessage(), PHP_EOL;
+}
+?></code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-perl">
+ <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::UserDefinedSchemasApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
+my $accept = application/json; # String |
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
+
+eval {
+ my $result = $api_instance->getUserDefinedSchemas(accept => $accept, offset => $offset, limit => $limit);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling UserDefinedSchemasApi->getUserDefinedSchemas: $@\n";
+}</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-python">
+ <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.UserDefinedSchemasApi()
+accept = application/json # String | (default to application/json)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
+
+try:
+ # Get a list of all used defined schemas.
+ api_response = api_instance.get_user_defined_schemas(accept, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling UserDefinedSchemasApi->getUserDefinedSchemas: %s\n" % e)</code></pre>
+ </div>
+
+ <div class="tab-pane" id="examples-UserDefinedSchemas-getUserDefinedSchemas-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate UserDefinedSchemasApi;
+
+pub fn main() {
+ let accept = application/json; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = UserDefinedSchemasApi::Context::default();
+ let result = client.getUserDefinedSchemas(accept, offset, limit, &context).wait();
+
+ println!("{:?}", result);
+}
+</code></pre>
+ </div>
+ </div>
+
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
+<td>
+
+
+ <div id="d2e199_getUserDefinedSchemas_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getUserDefinedSchemas_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getUserDefinedSchemas_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <h2>Responses</h2>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-200"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-200" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas200_description = `OK`;
+ var responseUserDefinedSchemas200_description_break = responseUserDefinedSchemas200_description.indexOf('\n');
+ if (responseUserDefinedSchemas200_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-200").text("Status: 200 - " + responseUserDefinedSchemas200_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-200").text("Status: 200 - " + responseUserDefinedSchemas200_description.substring(0, responseUserDefinedSchemas200_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-200").html(responseUserDefinedSchemas200_description.substring(responseUserDefinedSchemas200_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-200-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-200-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UserDefinedSchemas"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-400"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-400" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas400_description = `Bad Request`;
+ var responseUserDefinedSchemas400_description_break = responseUserDefinedSchemas400_description.indexOf('\n');
+ if (responseUserDefinedSchemas400_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-400").text("Status: 400 - " + responseUserDefinedSchemas400_description.substring(0, responseUserDefinedSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-400").html(responseUserDefinedSchemas400_description.substring(responseUserDefinedSchemas400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-400-schema">Schema</a>
+ </li>
+
-// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\SchemasApi();
-$accept = application/json; // String |
-$domain = RAN; // String |
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
-try {
- $result = $api_instance->getSchemas($accept, $domain, $offset, $limit);
- print_r($result);
-} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->getSchemas: ', $e->getMessage(), PHP_EOL;
-}
-?></code></pre>
- </div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-perl">
- <pre class="prettyprint"><code class="language-perl">use Data::Dumper;
-use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+ </ul>
-# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
-my $accept = application/json; # String |
-my $domain = RAN; # String |
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
-eval {
- my $result = $api_instance->getSchemas(accept => $accept, domain => $domain, offset => $offset, limit => $limit);
- print Dumper($result);
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-400-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
};
-if ($@) {
- warn "Exception when calling SchemasApi->getSchemas: $@\n";
-}</code></pre>
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-400-schema-data' type='hidden' value=''></input>
+ </div>
</div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-401"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-401" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas401_description = `Unauthorized`;
+ var responseUserDefinedSchemas401_description_break = responseUserDefinedSchemas401_description.indexOf('\n');
+ if (responseUserDefinedSchemas401_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-401").text("Status: 401 - " + responseUserDefinedSchemas401_description.substring(0, responseUserDefinedSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-401").html(responseUserDefinedSchemas401_description.substring(responseUserDefinedSchemas401_description_break));
+ }
+ </script>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-python">
- <pre class="prettyprint"><code class="language-python">from __future__ import print_statement
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-# Create an instance of the API class
-api_instance = openapi_client.SchemasApi()
-accept = application/json # String | (default to application/json)
-domain = RAN # String | (optional) (default to null)
-offset = 56 # Integer | Pagination offset. (optional) (default to 0)
-limit = 56 # Integer | Result limiter. (optional) (default to 500)
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-401" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-401-schema">Schema</a>
+ </li>
-try:
- # Get a list of all schemas.
- api_response = api_instance.get_schemas(accept, domain=domain, offset=offset, limit=limit)
- pprint(api_response)
-except ApiException as e:
- print("Exception when calling SchemasApi->getSchemas: %s\n" % e)</code></pre>
- </div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
-pub fn main() {
- let accept = application/json; // String
- let domain = RAN; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
- let mut context = SchemasApi::Context::default();
- let result = client.getSchemas(accept, domain, offset, limit, &context).wait();
+ </ul>
- println!("{:?}", result);
-}
-</code></pre>
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-401-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-401" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Unauthorized",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-401');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-401-schema-data' type='hidden' value=''></input>
+ </div>
</div>
- </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-403"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-403" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas403_description = `Forbidden`;
+ var responseUserDefinedSchemas403_description_break = responseUserDefinedSchemas403_description.indexOf('\n');
+ if (responseUserDefinedSchemas403_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-403").text("Status: 403 - " + responseUserDefinedSchemas403_description.substring(0, responseUserDefinedSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-403").html(responseUserDefinedSchemas403_description.substring(responseUserDefinedSchemas403_description_break));
+ }
+ </script>
- <h2>Scopes</h2>
- <table>
-
- </table>
- <h2>Parameters</h2>
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-403-schema">Schema</a>
+ </li>
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
- <div id="d2e199_getSchemas_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
+ </ul>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-403-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Forbidden",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-404"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-404" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas404_description = `Not Found`;
+ var responseUserDefinedSchemas404_description_break = responseUserDefinedSchemas404_description.indexOf('\n');
+ if (responseUserDefinedSchemas404_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-404").text("Status: 404 - " + responseUserDefinedSchemas404_description.substring(0, responseUserDefinedSchemas404_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-404").html(responseUserDefinedSchemas404_description.substring(responseUserDefinedSchemas404_description_break));
+ }
+ </script>
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-404" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-404-schema">Schema</a>
+ </li>
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domain</td>
-<td>
- <div id="d2e199_getSchemas_domain">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </ul>
- <tr><td style="width:150px;">offset</td>
-<td>
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-404-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-404" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Found",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <div id="d2e199_getSchemas_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-404');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-404-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-406"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-406" class="marked"></p>
+ <script>
+ var responseUserDefinedSchemas406_description = `Not Acceptable`;
+ var responseUserDefinedSchemas406_description_break = responseUserDefinedSchemas406_description.indexOf('\n');
+ if (responseUserDefinedSchemas406_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-406").text("Status: 406 - " + responseUserDefinedSchemas406_description);
+ } else {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-406").text("Status: 406 - " + responseUserDefinedSchemas406_description.substring(0, responseUserDefinedSchemas406_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-406").html(responseUserDefinedSchemas406_description.substring(responseUserDefinedSchemas406_description_break));
+ }
+ </script>
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- <tr><td style="width:150px;">limit</td>
-<td>
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-406" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-406-schema">Schema</a>
+ </li>
- <div id="d2e199_getSchemas_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
- </table>
+ </ul>
- <h2>Responses</h2>
- <h3 id="examples-Schemas-getSchemas-title-200"></h3>
- <p id="examples-Schemas-getSchemas-description-200" class="marked"></p>
+
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-406-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-406-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-406" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Not Acceptable",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-406-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-406');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-406-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-414"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-414" class="marked"></p>
<script>
- var responseSchemas200_description = `OK`;
- var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
- if (responseSchemas200_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description);
+ var responseUserDefinedSchemas414_description = `URI Too Large`;
+ var responseUserDefinedSchemas414_description_break = responseUserDefinedSchemas414_description.indexOf('\n');
+ if (responseUserDefinedSchemas414_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-414").text("Status: 414 - " + responseUserDefinedSchemas414_description);
} else {
- $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
- $("#examples-Schemas-getSchemas-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-414").text("Status: 414 - " + responseUserDefinedSchemas414_description.substring(0, responseUserDefinedSchemas414_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-414").html(responseUserDefinedSchemas414_description.substring(responseUserDefinedSchemas414_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-414" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-414-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-200-schema">
- <div id="responses-Schemas-getSchemas-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-414-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-414-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-414" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "URI Too Large",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/SchemaList"
- },
- "examples" : {
- "schemas" : {
- "$ref" : "#/components/examples/SchemasResponseExample"
- }
+ "$ref" : "#/components/schemas/ErrorMessage"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-200');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-414-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-414');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-414-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-400"></h3>
- <p id="examples-Schemas-getSchemas-description-400" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-429"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-429" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseUserDefinedSchemas429_description = `Too Many Requests`;
+ var responseUserDefinedSchemas429_description_break = responseUserDefinedSchemas429_description.indexOf('\n');
+ if (responseUserDefinedSchemas429_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description);
} else {
- $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-getSchemas-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-429").text("Status: 429 - " + responseUserDefinedSchemas429_description.substring(0, responseUserDefinedSchemas429_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-429").html(responseUserDefinedSchemas429_description.substring(responseUserDefinedSchemas429_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-429" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-429-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-400-schema">
- <div id="responses-Schemas-getSchemas-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-429-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-429-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-429" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Too Many Requests",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-400');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-429-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-429');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-429-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-401"></h3>
- <p id="examples-Schemas-getSchemas-description-401" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-500"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-500" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseUserDefinedSchemas500_description = `Internal Server Error`;
+ var responseUserDefinedSchemas500_description_break = responseUserDefinedSchemas500_description.indexOf('\n');
+ if (responseUserDefinedSchemas500_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description);
} else {
- $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-getSchemas-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-500").text("Status: 500 - " + responseUserDefinedSchemas500_description.substring(0, responseUserDefinedSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-500").html(responseUserDefinedSchemas500_description.substring(responseUserDefinedSchemas500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-401-schema">
- <div id="responses-Schemas-getSchemas-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-500-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-401');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-500-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-403"></h3>
- <p id="examples-Schemas-getSchemas-description-403" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-502"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-502" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseUserDefinedSchemas502_description = `Bad Gateway`;
+ var responseUserDefinedSchemas502_description_break = responseUserDefinedSchemas502_description.indexOf('\n');
+ if (responseUserDefinedSchemas502_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description);
} else {
- $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-getSchemas-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-502").text("Status: 502 - " + responseUserDefinedSchemas502_description.substring(0, responseUserDefinedSchemas502_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-502").html(responseUserDefinedSchemas502_description.substring(responseUserDefinedSchemas502_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-502" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-502-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-403-schema">
- <div id="responses-Schemas-getSchemas-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-502-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-502-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-502" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Bad Gateway",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-403');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-502-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-502');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-502-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-500"></h3>
- <p id="examples-Schemas-getSchemas-description-500" class="marked"></p>
+ <h3 id="examples-UserDefinedSchemas-getUserDefinedSchemas-title-503"></h3>
+ <p id="examples-UserDefinedSchemas-getUserDefinedSchemas-description-503" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseUserDefinedSchemas503_description = `Service Unavailable`;
+ var responseUserDefinedSchemas503_description_break = responseUserDefinedSchemas503_description.indexOf('\n');
+ if (responseUserDefinedSchemas503_description_break == -1) {
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description);
} else {
- $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-getSchemas-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-title-503").text("Status: 503 - " + responseUserDefinedSchemas503_description.substring(0, responseUserDefinedSchemas503_description_break));
+ $("#examples-UserDefinedSchemas-getUserDefinedSchemas-description-503").html(responseUserDefinedSchemas503_description.substring(responseUserDefinedSchemas503_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-UserDefinedSchemas-getUserDefinedSchemas-503" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-UserDefinedSchemas-getUserDefinedSchemas-503-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-500-schema">
- <div id="responses-Schemas-getSchemas-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-UserDefinedSchemas-getUserDefinedSchemas-503-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-UserDefinedSchemas-getUserDefinedSchemas-503-schema">
+ <div id="responses-UserDefinedSchemas-getUserDefinedSchemas-schema-503" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Internal Server Error",
+ "description" : "Service Unavailable",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-500');
+ $('#responses-UserDefinedSchemas-getUserDefinedSchemas-503-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-UserDefinedSchemas-getUserDefinedSchemas-schema-503');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-UserDefinedSchemas-getUserDefinedSchemas-503-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
Code Review / smo / teiv.git / commitdiff