<#-- ============LICENSE_START======================================================= org.onap.aai ================================================================================ Copyright © 2017-18 AT&T Intellectual Property. All rights reserved. Copyright © 2018 Huawei Technologies (Australia) Pty Ltd. All rights reserved. ================================================================================ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ============LICENSE_END========================================================= ECOMP is a trademark and service mark of AT&T Intellectual Property. --> Active and Available Inventory REST API.

Active and Available Inventory REST API.

Version: ${version}

${description}

Schemes: https

Summary

    <#list aaiApis?keys as key>
  1. Tag: ${key}
  2. Paths
  3. Schema definitions
<#list aaiApis?keys as key>

Tag: ${key}

<#list aaiApis[key] as api> <#list api.getHttpMethods() as httpVerb>
OperationDescription
${httpVerb.getType()?upper_case} ${api.getPath()}

${httpVerb.getSummary()}

Paths

<#list sortedAaiApis?keys as key> <#list sortedAaiApis[key] as api> <#list api.getHttpMethods() as httpVerb>
${httpVerb.getSummary()}

${httpVerb.getType()?upper_case} ${api.getPath()}

Tags: ${api.getTag()}

${httpVerb.getSummary()}

<#if httpVerb.isConsumerEnabled()>

application/json application/xml

<#if httpVerb.isBodyParametersEnabled()>

${httpVerb.getBodyParameters()["description"]}

<#if httpVerb.isParametersEnabled()>
<#list httpVerb.getParameters() as param>
${param["name"]} <#if param['description']??>

${param["description"]}

${param["in"]} <#if param['type']??> ${param["type"]} <#if param['required']>

application/json application/xml

<#list httpVerb.getResponses() as response>
${response.getResponseCode()} OK

successful operation

<#if httpVerb.isHasReturnSchema()>
default

Response codes found in response codes.

Schema definitions

<#list definitions as definition>

${definition.getDefinitionName()}: object

<#if definition.isHasDescription()>
${definition.getDefinitionDescription()}
<#list definition.getRegularPropertyList() as definitionProperty>
${definitionProperty.getPropertyName()}: <#if definitionProperty.isHasType()> ${definitionProperty.getPropertyType()} <#if definitionProperty.isRequired()>
<#if definitionProperty.isHasPropertyDescription()>

${definitionProperty.getPropertyDescription()}

<#list definition.getSchemaPropertyList() as definitionProperty>
${definitionProperty.getPropertyName()}: <#if definitionProperty.isHasType()> ${definitionProperty.getPropertyType()} <#if definitionProperty.isRequired()>