H Customization of OpenAPI JSON

This section details the customization of openAPI JSON file.

The ocnrf_configuration_openapi_25.2.201.json openAPI file provides options to configure the details two servers: one for NRF configuration, status, state data APIs, and another for OCNRF DBTier APIs.

1. Open the ocnrf_configuration_openapi_25.2.201.json file.
2. Edit the servers section as per the deployment. Two servers can be configured as follows:
   • "url": http://xxx.x.x.x:xxxx/, - Indicates the CNC Console host and port details
   • "url": http://xxx.x.x.x:xxxx/, - Indicates the OCNRF DBTier host and port details
3. Select the correct server details as per the API can be used as per the description in the below example:

   
   "servers": [
       {
         "url": http://xxx.x.x.x:xxxx/,
         "description": "<cncc service host details>:<cncc service port details>. Can be used for APIs that belongs to section: OCNRF Alternate Route Configuration, OCNRF Configuration,  OCNRF Configuration Status, OCNRF Egress Gateway Configuration, OCNRF Ingress Gateway Configuration, OCNRF Perf-Info Configuration, OCNRF State Data"
       },
       {
         "url":  http://xxx.x.x.x:xxxx/,
         "description": "<db-monitor-svc host details>:<db-monitor-svc port details>. Can be used for APIs that belongs to section: OCNRF Dbtier Version, OCNRF Dbtier Replication, OCNRF Dbtier Cluster,  OCNRF Dbtier Backup, OCNRF Dbtier Health, OCNRF Dbtier Fault Recovery, OCNRF Dbtier Replication Status Across All, OCNRF Dbtier Replication Status Across All Given SiteName and RemoteSiteName, OCNRF Dbtier Statistics Report Db Info"
       }
     ],
   

   Note:

   Apart from URL, no other content should be edited or updated in the openAPI file.