Fix the input spec url for code generation in CPS-NCMP and ONAP-DMI-PLUGIN repo 44/141344/2
authoregernug <gerard.nugent@est.tech>
Thu, 19 Jun 2025 10:07:00 +0000 (11:07 +0100)
committeregernug <gerard.nugent@est.tech>
Thu, 19 Jun 2025 14:18:55 +0000 (15:18 +0100)
- Added rst_epilog to conf.py
- Referenced rst_epilog replace in design.rst. Release variable in conf.py now controls what branch we download from.
- Added variable to pom.xml to download OpenAPI files from referenced branch

Issue-ID: CPS-2857

Change-Id: I79503398971f919b3cabc69a485ed7470d1ce7ed
Signed-off-by: egernug <gerard.nugent@est.tech>
dmi-service/pom.xml
docs/conf.py
docs/design.rst

index 60efb44..1b93225 100644 (file)
@@ -61,6 +61,7 @@
         <onap.nexus.url>https://nexus.onap.org</onap.nexus.url>
         <releaseNexusPath>/content/repositories/releases/</releaseNexusPath>
         <snapshotNexusPath>/content/repositories/snapshots/</snapshotNexusPath>
+        <swagger.branch>master</swagger.branch>
     </properties>
 
     <dependencyManagement>
                             <goal>generate</goal>
                         </goals>
                         <configuration>
-                            <inputSpec>https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi.yml</inputSpec>
+                            <inputSpec>https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi.yml;hb=refs/heads/${swagger.branch}</inputSpec>
                             <generatorName>spring</generatorName>
                             <generateSupportingFiles>false</generateSupportingFiles>
                             <invokerPackage>org.onap.cps.ncmp.dmi.rest.controller</invokerPackage>
                             <goal>generate</goal>
                         </goals>
                         <configuration>
-                            <inputSpec>https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi-datajob.yml</inputSpec>
+                            <inputSpec>https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi-datajob.yml;hb=refs/heads/${swagger.branch}</inputSpec>
                             <generatorName>spring</generatorName>
                             <generateSupportingFiles>false</generateSupportingFiles>
                             <invokerPackage>org.onap.cps.ncmp.dmi.datajobs.rest.controller</invokerPackage>
                         </goals>
                         <phase>compile</phase>
                         <configuration>
-                            <inputSpec>https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi.yml</inputSpec>
+                            <inputSpec>https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi.yml;hb=refs/heads/${swagger.branch}</inputSpec>
                             <generatorName>openapi-yaml</generatorName>
                             <configOptions>
                                 <outputFile>openapi.yaml</outputFile>
index 724b903..391d7d9 100644 (file)
@@ -23,6 +23,11 @@ project = "onap"
 release = "master"
 version = "master"
 
+rst_epilog = f"""
+.. |dmi_openapi_url| replace:: `DMI Rest OpenAPI Specification <https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi.yml;hb=refs/heads/{release}>`__
+.. |dmi_openapi_datajob_url| replace:: `DMI Datajob OpenApi Specification <https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi-datajob.yml;hb=refs/heads/{release}>`__
+"""
+
 author = "Open Network Automation Platform"
 # yamllint disable-line rule:line-length
 copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
index 92975cc..a0dd455 100644 (file)
@@ -17,9 +17,10 @@ Offered APIs
 
 The DMI-Plugin supports the public APIs listed in the link below:
 
-:download:`DMI Rest OpenApi Specification <https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi.yml>`
+|dmi_openapi_url|
+
+|dmi_openapi_datajob_url|
 
-:download:`DMI Datajob OpenApi Specification <https://gerrit.onap.org/r/gitweb?p=cps.git;a=blob_plain;f=docs/api/swagger/dmi/openapi-datajob.yml>`
 
 View Offered APIs
 -----------------