From: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Date: Thu, 6 Feb 2025 08:38:49 +0000 (+0100)
Subject: Update AAI api documentation
X-Git-Tag: 1.16.0~3
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=a158e2d6e8df8dd2d16ca85d906da245c82bb881;p=aai%2Faai-common.git

Update AAI api documentation

- update docs to
  - include v30
  - make openapi page easier searchable by mentioning openapi in the title
  - link to openapi page in AAI REST API section

Issue-ID: AAI-4126
Change-Id: I408ea17fa9560fb7b20550086362d3b26d078968
Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
---

diff --git a/docs/index.rst b/docs/index.rst
index 4ba174df..39d962b6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ The key AAI repos for running the AAI REST APIs:
 
    platform/index.rst
    release-notes.rst
+   platform/offeredapis.rst
    AAI REST API Documentation/AAIRESTAPI.rst
    AAI REST API Documentation/bulkApi.rst
    AAI REST API Documentation/customQueries.rst
diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst
index e6dbfd54..d896085f 100644
--- a/docs/platform/offeredapis.rst
+++ b/docs/platform/offeredapis.rst
@@ -3,7 +3,7 @@
 .. _offeredapis:
 
 ========================================
-Offered APIs
+AAI OpenAPI definition
 ========================================
 
 The list of APIs that AAI offers could be found in the following table:
@@ -19,4 +19,5 @@ The list of APIs that AAI offers could be found in the following table:
    :widths: 60,60
 
    "html doc", "yaml doc"
-   ":download:`link <https://lf-onap.atlassian.net/wiki/download/attachments/16506145/aai_swagger_v29.html?api=v2>`", ":download:`link <https://lf-onap.atlassian.net/wiki/download/attachments/16506145/aai_swagger_v29.yaml?api=v2>`"
+   ":download:`v30 <https://lf-onap.atlassian.net/wiki/download/attachments/110952449/aai_swagger_v30.html?api=v2>`", ":download:`v30 <https://lf-onap.atlassian.net/wiki/download/attachments/110952449/aai_swagger_v30.yaml?api=v2>`"
+   ":download:`v29 <https://lf-onap.atlassian.net/wiki/download/attachments/110952449/aai_swagger_v29.html?api=v2>`", ":download:`v29 <https://lf-onap.atlassian.net/wiki/download/attachments/110952449/aai_swagger_v29.yaml?api=v2>`"
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 516a784b..53fd7182 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -10,7 +10,7 @@ AAI Release Notes
 Abstract
 ========
 
-This document provides release notes for the Active and Available Inventory Project's Kohn Release
+This document provides release notes for the Active and Available Inventory Project's Oslo Release
 
 Release Data
 ============