# ============LICENSE_START===============================================
# Copyright (C) 2020-2023 Nordix Foundation. All rights reserved.
+# Copyright (C) 2024 OpenInfra Foundation Europe. 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.
os: ubuntu-22.04
tools:
python: "3.11"
+ jobs:
+ post_build:
+ - cp -v docs/offeredapis/openapitoolgen/offeredapis/pms-api/pms-api.html $READTHEDOCS_OUTPUT/html
python:
install:
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2024 OpenInfra Foundation Europe
+
+.. _api_docs:
+
+========
+API Docs
+========
+
+To view the Open API specification for A1 PMS, please see the following.
+
+.. raw:: html
+
+ <ul>
+ <li><a href="./pms-api.html">A1 Policy Management Service API and SDK Documentation</a></li>
+ </ul>
# ============LICENSE_START===============================================
# Copyright (C) 2021-2022 Nordix Foundation. All rights reserved.
+# Copyright (C) 2024 OpenInfra Foundation Europe. 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.
extensions = ['sphinx.ext.intersphinx',]
+html_extra_path = [
+ 'offeredapis/openapitoolgen/offeredapis/pms-api'
+]
+
#intershpinx mapping with other projects
intersphinx_mapping = {}
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. Copyright (C) 2023 Nordix
+.. Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
Non-RT RIC A1 Policy Management Service
=======================================
./developer-guide.rst
./installation-guide.rst
./release-notes.rst
+ ./api-docs.rst
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2021 Nordix. All rights reserved.
-.. Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved.
+.. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved.
=============
-Release-Notes
+Release Notes
=============
This document provides the release notes for the release of the Non-RT RIC A1 Policy Management Service.
-Version history A1 Policy Management Service (A1 Policy Agent)
+Version history A1 Policy Management Service (A1 Policy Agent)
==============================================================
+------------+----------+------------------+--------------------+
<appName>ONAP CCSDK A1 Policy Management Service</appName>
<infoUrl>https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP</infoUrl>
<licenseInfo>Copyright (C) 2020-2023 Nordix Foundation. Licensed
- under the Apache License, and Copyright (C) 2024 OpenInfra
+ under the Apache License, and Copyright (C) 2024 OpenInfra
Foundation Europe. All rights reserved.</licenseInfo>
<licenseUrl>http://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
</configOptions>
<resource>
<directory>${project.basedir}/api/pms-api</directory>
<includes>
- <include>index.html</include>
+ <include>pms-api.html</include>
</includes>
</resource>
</resources>