B Open API Specification for nudr-config
The open API specification for nudr-config is as follows:
{
"openapi" : "3.0.0",
"info" : {
"version" : "25.2.200.0.0",
"title" : "OCUDR CONFIGURATION API SPECIFICATION"
},
"tags" : [ {
"name" : "OCUDR CONFIGURATION",
"description" : "Configuration Controller"
} ],
"paths" : {
"/nudr-config/v1/udr.nudrservice.cfg/DR-SERVICE" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns configuration of Data repository service with DR-SERVICE as key and udr.nudrservice.cfg as topic",
"operationId" : "getConfiguredValuesForDR",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DrServiceConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of Data Repository service with DR-SERVICE key and as udr.nudrservice.cfg topic",
"operationId" : "putConfiguredValuesForDR",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DrServiceConfiguration"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.nudrprovservice.cfg/DR-PROV-SERVICE" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns configuration of Data repository Provisioning service with DR-PROV-SERVICE as key and udr.nudrprovservice.cfg as topic",
"operationId" : "getConfiguredValuesForDRProv",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DrProvServiceConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of Data Repository Provisioning service with DR-PROV-SERVICE key and as udr.nudrprovservice.cfg topic",
"operationId" : "putConfiguredValuesForDRProv",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DrProvServiceConfiguration"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.notifyservice.cfg/NOTIFY-SERVICE" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns configuration of Notify Service with NOTIFY-SERVICE as key and udr.notifyservice.cfg as topic",
"operationId" : "getConfiguredValuesForNotify",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotifyServiceConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of Notify Service with NOTIFY-SERVICE as Key and udr.notifyservice.cfg as topic",
"operationId" : "putConfiguredValuesForNotify",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotifyServiceConfiguration"
}
}
},
"description" : "Notify Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.diamgateway.cfg/DIAMETER-GATEWAY" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns configuration of Diamgateway with DIAMETER-GATEWAY key and udr.diamgateway.cfg as topic",
"operationId" : "getConfiguredValuesForDiamgateway",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DiameterConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of Diamgateway with DIAMETER-GATEWAY as key and udr.diamgateway.cfg as topic",
"operationId" : "putConfiguredValuesForDiamgateway",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DiameterConfiguration"
}
}
},
"description" : "Diamgateway Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.global.cfg/GLOBAL" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Global Configuration with GLOBAL as key and udr.global.cfg as topic",
"operationId" : "getConfiguredValuesForGlobal",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GlobalConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Returns Global Configuration with GLOBAL as key and udr.global.cfg as topic",
"operationId" : "putConfiguredValuesForGlobal",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GlobalConfiguration"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.diamgateway.congestion.cfg/DGW-CONGESTION" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns configuration of diamgateway congestion with DGW-CONGESTION as key and udr.diamgateway.congestion.cfg as topic",
"operationId" : "getConfiguredValuesForDC",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DiamgatewayCongestion"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of diamgateway congestion with DGW-CONGESTION as key and udr.diamgateway.congestion.cfg topic",
"operationId" : "putConfiguredValuesForDC",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DiamgatewayCongestion"
}
}
},
"description" : "Diamgateway Congestion Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.biservice.cfg/BULK_IMPORT" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Run time status of Bulk Import files",
"operationId" : "getConfiguredValuesForBI",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BIConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.bulkimportservice.cfg/BULK_IMPORT_CFG" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns the configurations of bulk import with udr.bulkimportservice.cfg as topic and BULK_IMPORT_CFG as value",
"operationId" : "getBulkImportCfg",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkImportCfg"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of subscriber bulk import tool congestion with BULK_IMPORT_CFG as key and udr.bulkimportservice.cfg as topic",
"operationId" : "putBulkImportCfg",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkImportCfg"
}
}
},
"description" : "Subscriber Bulk Import Tool Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.exporttool.cfg/EXPORT_TOOL_CFG" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns the configurations of bulk export tool with udr.exporttool.cfg as topic and EXPORT_TOOL_CFG as Key",
"operationId" : "getBulkExportCfg",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkExportCfg"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates configuration of subscriber bulk export tool congestion with udr.exporttool.cfg as topic and EXPORT_TOOL_CFG as Key",
"operationId" : "putBulkExportCfg",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkExportCfg"
}
}
},
"description" : "Subscriber Bulk Export Tool Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns the status of bulk export tool with udr.exporttoolstatus.cfg as topic and EXPORT_TOOL_STATUS as Key",
"operationId" : "getBulkExportToolStatus",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkExportToolStatus"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.exporttoolfilestatus.cfg/EXPORT_TOOL_FILE_STATUS" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns the status of bulk export tool with udr.exporttoolfilestatus.cfg as topic and EXPORT_TOOL_FILE_STATUS as Key",
"operationId" : "getBulkExportFileStatus",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkExportFileStatus"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/export" : {
"post" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "To export configuration data.",
"operationId" : "postExportConfiguration",
"responses" : {
"201" : {
"description" : "CREATED",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "To get export id.",
"operationId" : "getExportConfiguration",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportId"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/export/{exportResourceId}/status" : {
"get" : {
"parameters" : [ {
"in" : "path",
"name" : "exportResourceId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Export process status",
"operationId" : "getExportStatus",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportStatus"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/export/{exportResourceId}/report" : {
"get" : {
"parameters" : [ {
"in" : "path",
"name" : "exportResourceId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Export Report",
"operationId" : "getExportReport",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportReport"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/export/{exportResourceId}/download" : {
"get" : {
"parameters" : [ {
"in" : "path",
"name" : "exportResourceId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Exported configuration download",
"operationId" : "getExportDownload",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Download"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/import" : {
"post" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "To start Import of UDR Configuration",
"operationId" : "postImportConfiguration",
"parameters": [
{
"name": "managedObjects",
"in": "query",
"description": "List of managed objects",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"requestBody": {
"description": "Import file",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"importFile": {
"type": "string",
"format": "binary"
}
},
"required": ["importFile"]
}
}
}
},
"responses" : {
"201" : {
"description" : "CREATED",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "To get import id",
"operationId" : "getImportConfiguration",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportId"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/import/{importResourceId}/status" : {
"get" : {
"parameters" : [ {
"in" : "path",
"name" : "importResourceId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Import status",
"operationId" : "getImportStatus",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportStatus"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/import/{importResourceId}/report" : {
"get" : {
"parameters" : [ {
"in" : "path",
"name" : "importResourceId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Import report",
"operationId" : "getImportReport",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportReport"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-drservice/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log level For Data Repository Service",
"operationId" : "getLogLevelForDR",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log level For Data Repository Service",
"operationId" : "putLogLevelForDr",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Global Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-dr-provservice/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log level For Data Repository Provisioning Service",
"operationId" : "getLogLevelForDRProv",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log level For Data Repository Provisioning Service",
"operationId" : "putLogLevelForDrProv",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Global Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-notify-service/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level For Notify Service",
"operationId" : "getLogLevelForNotify",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level For Notify Service",
"operationId" : "putLogLevelForNotify",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Notify Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-diameterproxy/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of Diameter Proxy Service",
"operationId" : "getLogLevelForDiameter",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level of Diameter Proxy Service",
"operationId" : "putLogLevelForDiameter",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Diameter Proxy Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/diam-gateway/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of Diamgateway Service",
"operationId" : "getLogLevelForDiamgateway",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level of Diamgateway Service",
"operationId" : "putLogLevelForDiamgateway",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Diamgateway Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-bulk-import/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of nudr import service",
"operationId" : "getLogLevelForBulkImport",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level of Bulk Import Microservice",
"operationId" : "putLogLevelForBulkImport",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Diameter Proxy Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-export-tool/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of nudr export service",
"operationId" : "getLogLevelForExportTool",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level of Bulk Export Microservice",
"operationId" : "putLogLevelForExportTool",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Export Tool Logging Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/nudr-config/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of nudr config service",
"operationId" : "getLogLevelForNudrConfig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level of nudr config Microservice",
"operationId" : "putLogLevelForNudrConfig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogConfiguration"
}
}
},
"description" : "Nudr config Logging Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level for Egress Gateway",
"operationId" : "getLogLevelForEgress",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GwLogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level for Egress Gateway",
"operationId" : "putLogLevelForEgress",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GwLogConfiguration"
}
}
},
"description" : "Diameter Proxy Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/nrf-client-nfmanagement/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level Of NRF client NF Mgm Service",
"operationId" : "getLogLevelForNrfClientMgm",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NrfClientConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Log Level Of NRF client NF Mgm Service",
"operationId" : "petLogLevelForNrfClientMgm",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NrfClientConfig"
}
}
},
"description" : "NRF Client Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/all/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level Of All Services",
"operationId" : "getLogLevelForAll",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AllLogs"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-prov/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of ingress gateway provisioning service",
"operationId" : "getLogLevelForIwgProv",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Level of ingress gateway provisioning service",
"operationId" : "putLogLevelForIwgProv",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GwLogConfiguration"
}
}
},
"description" : "Alternate Route Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of ingress gateway signaling service",
"operationId" : "getLogLevelForIwgSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GwLogConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Level of ingress gateway signaling service",
"operationId" : "putLogLevelForIwgSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GwLogConfiguration"
}
}
},
"description" : "Alternate Route Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/alt-route/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of ingress gateway signaling service",
"operationId" : "getLogLevelForAltRoute",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AltRouteConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Level of ingress gateway signaling service",
"operationId" : "putLogLevelForAltRoute",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AltRouteConfig"
}
}
},
"description" : "Alternate Route Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/perf-info/logging" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level of perf-info service",
"operationId" : "getLogLevelForPerfInfo",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates Level of perf-info service",
"operationId" : "putLogLevelForPerfInfo",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "perf-info Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/operationalState" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Operation State of OCUDR",
"operationId" : "getOperationalState",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OperationalStateConfiguration"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Updates on OperationState Configuration",
"operationId" : "putOperationalState",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OperationalStateConfiguration"
}
}
},
"description" : "Operational State Configuration Update",
"required" : true
},
"responses" : {
"200" : {
"description" : "OK"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/operationalStateHistory" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Operation State of OCUDR",
"operationId" : "getOperationalStateHistory",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OperationalStateHistory"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS/{jobId}" : {
"get" : {
"parameters" : [ {
"in" : "path",
"name" : "jobId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns the status of bulk export tool with udr.exporttoolstatus.cfg as topic and EXPORT_TOOL_STATUS as Key",
"operationId" : "getBulkExportToolStatusJobId",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkExportToolStatusJobId"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"delete" : {
"parameters" : [ {
"in" : "path",
"name" : "jobId",
"schema" : {
"type" : "string"
},
"required" : true
} ],
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "To delete any export tool job with jobId",
"operationId" : "deleteExportToolStatusJobId",
"responses" : {
"200" : {
"description" : "OK"
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/app-info/nfScoring" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "The NF-Scoring feature is to calculate the score for a site based on NF-specific factors (metrics, alerts, etc).\n",
"operationId" : "getNfScoring",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AppInfoConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "The NF-Scoring feature is to calculate the score for a site based on NF-specific factors (metrics, alerts, etc).\n",
"operationId" : "putNfScoring",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AppInfoConfig"
}
}
},
"description" : "App Info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "The NF-Scoring feature is to calculate the score for a site based on NF-specific factors (metrics, alerts, etc).\n",
"operationId" : "patchNfScoring",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AppInfoConfig"
}
}
},
"description" : "App info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/nfscore" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "The NF-Scoring feature is to calculate the score for a site based on NF-specific factors (metrics, alerts, etc).\n",
"operationId" : "getNfScore",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AppInfoConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/podProtectionByRateLimiting/node" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used enable the pod rate limiting feature to prevent Ingress Gateway pod overload.\n",
"operationId" : "getPodProtectionByRateLimitingNode",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used enable the pod rate limiting feature to prevent Ingress Gateway pod overload.\n",
"operationId" : "putPodProtectionByRateLimitingNode",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used enable the pod rate limiting feature to prevent Ingress Gateway pod overload.\n",
"operationId" : "patchPodProtectionByRateLimitingNode",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/peersetconfiguration" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This resource is used in SBIRouting feature. This URI can be used to add/update the list of peer sets wherein each peer set consists of id and list of http/https instances. Each instance consists of priority and peer identifier that is mapped to id in peerconfiguration resource. The id of each peer set is mapped to peerSetIdentifier in \"routesconfiguration\" resource. The default value is null.\n",
"operationId" : "getPeerSetConfig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This resource is used in SBIRouting feature. This URI can be used to add/update the list of peer sets wherein each peer set consists of id and list of http/https instances. Each instance consists of priority and peer identifier that is mapped to id in peerconfiguration resource. The id of each peer set is mapped to peerSetIdentifier in \"routesconfiguration\" resource. The default value is null.\n",
"operationId" : "putPeerSetConfig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This resource is used in SBIRouting feature. This URI can be used to add/update the list of peer sets wherein each peer set consists of id and list of http/https instances. Each instance consists of priority and peer identifier that is mapped to id in peerconfiguration resource. The id of each peer set is mapped to peerSetIdentifier in \"routesconfiguration\" resource. The default value is null.\n",
"operationId" : "patchPeerSetConfig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/errorcodeserieslist" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to map errorCodeSeries id and it's corresponding errorCodeSeries configuration. By default this configuration is null.\n",
"operationId" : "getErrorCodeSeriesListIgwSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorCodeSeriesList"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to map errorCodeSeries id and it's corresponding errorCodeSeries configuration. By default this configuration is null.\n",
"operationId" : "putErrorCodeSeriesListIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to map errorCodeSeries id and it's corresponding errorCodeSeries configuration. By default this configuration is null.\n",
"operationId" : "patchErrorCodeSeriesListIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/sbiroutingerrorcriteriasets" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to list/update sbi error criteria sets configuration at Egress gateway. By default this configuration is disabled.\n",
"operationId" : "getSbiroutingErrorCriteriaSets",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to list/update sbi error criteria sets configuration at Egress gateway. By default this configuration is disabled.\n",
"operationId" : "putSbiroutingErrorCriteriaSets",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to list/update sbi error criteria sets configuration at Egress gateway. By default this configuration is disabled.\n",
"operationId" : "patchSbiroutingErrorCriteriaSets",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/congestionConfig/node" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used identify the congestion levels of the pods for the pod rate limiting feature to prevent Egress Gateway pod overload.\n",
"operationId" : "getCongestionConfigNode",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used identify the congestion levels of the pods for the pod rate limiting feature to prevent Egress Gateway pod overload.\n",
"operationId" : "putCongestionConfigNode",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used identify the congestion levels of the pods for the pod rate limiting feature to prevent Egress Gateway pod overload.\n",
"operationId" : "patchCongestionConfigNode",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/configurableerrorcodes" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configurableErrorCodes that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default configurableErrorCodes will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "getConfigurableErrorCodes",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurableErrorCodes"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configurableErrorCodes that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default configurableErrorCodes will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "putConfigurableErrorCodes",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configurableErrorCodes that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default configurableErrorCodes will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "patchConfigurableErrorCodes",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/configurableerrorcodes" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configurableErrorCodes that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default configurableErrorCodes will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "getConfigurableErrorCodesEgw",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConfigurableErrorCodes"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configurableErrorCodes that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default configurableErrorCodes will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "putConfigurableErrorCodesEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configurableErrorCodes that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default configurableErrorCodes will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "patchConfigurableErrorCodesEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/serverheaderdetails" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used for adding \"Server\" header in the error responses sent from IGW depending on the values provided in the json. By default, this feature is disabled. To enable the feature, REST API needs to be invoked and update the enable/disable flag..\n",
"operationId" : "getServerHeaderDetailsIgwSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerHeaderDetails"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used for adding \"Server\" header in the error responses sent from IGW depending on the values provided in the json. By default, this feature is disabled. To enable the feature, REST API needs to be invoked and update the enable/disable flag..\n",
"operationId" : "putServerHeaderDetailsIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update oauth configuration that will be used for validating token sent in request to IGW. By default, instanceId list, keyIdList are null and validation mode is INSTANCEID_ONLY. This configuration is only applicable when oauth feature is enabled via helm chart.\n",
"operationId" : "patchServerHeaderDetailsIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/sbiroutingerroractionsets" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to list/update sbi error action sets configuration at Egress gateway. By default this configuration is disabled..\n",
"operationId" : "getSbiRoutingErroractionSetsEgw",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to list/update sbi error action sets configuration at Egress gateway. By default this configuration is disabled..\n",
"operationId" : "putSbiRoutingErroractionSetsEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to list/update sbi error action sets configuration at Egress gateway. By default this configuration is disabled..\n",
"operationId" : "patchSbiRoutingErroractionSetsEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/routesconfiguration" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "getRoutesConfigurationIgwSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "putRoutesConfigurationIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "patchRoutesConfigurationIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-prov/routesconfiguration" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "getRoutesConfiguration",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "putRoutesConfiguration",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "patchRoutesConfiguration",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/routesconfiguration" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "getRoutesConfigurationEgw",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "putRoutesConfigurationEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to add/update list of routes.\n",
"operationId" : "patchRoutesConfigurationEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/retryprofile" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of peer monitoring configuration.\n",
"operationId" : "getRetryProfileEgw",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of peer monitoring configuration.\n",
"operationId" : "putRetryProfileEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of peer monitoring configuration.\n",
"operationId" : "patchRetryProfileEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/peerconfiguration" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This resource is used in SBIRouting feature. This URI can be used to add/update the list of peers wherein each peer consists of id, host,port/ virtualHost and apiPrefix. The id of each peer will be mapped to peerIdentifier in \"peersetconfiguration\" resource. The default value is null.\n",
"operationId" : "getPeerConfigurationEgw",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This resource is used in SBIRouting feature. This URI can be used to add/update the list of peers wherein each peer consists of id, host,port/ virtualHost and apiPrefix. The id of each peer will be mapped to peerIdentifier in \"peersetconfiguration\" resource. The default value is null.\n",
"operationId" : "putPeerConfigurationEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This resource is used in SBIRouting feature. This URI can be used to add/update the list of peers wherein each peer consists of id, host,port/ virtualHost and apiPrefix. The id of each peer will be mapped to peerIdentifier in \"peersetconfiguration\" resource. The default value is null.\n",
"operationId" : "patchPeerConfigurationEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/ocpolicymapping" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update service names and corresponding policy name for the service which is mapped to \"ocDiscardPolicies\" based on \"policyName\" and also to enable/disable overload control and the sampling period in overload control. By default, overload control feature is disabled and sampling period is 60s. To enable the feature, REST API needs to be invoked and update the enable/disable flag.\n",
"operationId" : "getOcPolicyMappingIgwSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update service names and corresponding policy name for the service which is mapped to \",ocDiscardPolicies\", based on \",policyName\", and also to enable/disable overload control and the sampling period in overload control. By default, overload control feature is disabled and sampling period is 60s. To enable the feature, REST API needs to be invoked and update the enable/disable flag.\n",
"operationId" : "putOcPolicyMappingIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update service names and corresponding policy name for the service which is mapped to \"ocDiscardPolicies\" based on \"policyName\" and also to enable/disable overload control and the sampling period in overload control. By default, overload control feature is disabled and sampling period is 60s. To enable the feature, REST API needs to be invoked and update the enable/disable flag.\n",
"operationId" : "patchOcPolicyMappingIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/ocdiscardpolicies" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update discard policies that will be used in overload control to select appropriate policy from the configured list based on load level of a particular service. By default ocDicardPolicies will be null.\n",
"operationId" : "getOcDiscardPolicies",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update discard policies that will be used in overload control to select appropriate policy from the configured list based on load level of a particular service. By default ocDicardPolicies will be null.\n",
"operationId" : "putOcDiscardPolicies",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update discard policies that will be used in overload control to select appropriate policy from the configured list based on load level of a particular service. By default ocDicardPolicies will be null.\n",
"operationId" : "patchOcDiscardPolicies",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/oauthvalidatorconfiguration" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update/add oauth configuration that will be used for validating token sent in request to IGW. By default, instanceId list, keyIdList are null and validation mode is INSTANCEID_ONLY. This configuration is only applicable when oauth feature is enabled via helm chart.\n",
"operationId" : "getOauthValidatorConfigurationIgwSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update/add oauth configuration that will be used for validating token sent in request to IGW. By default, instanceId list, keyIdList are null and validation mode is INSTANCEID_ONLY. This configuration is only applicable when oauth feature is enabled via helm chart.\n",
"operationId" : "putOauthValidatorConfigurationIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update oauth configuration that will be used for validating token sent in request to IGW. By default, instanceId list, keyIdList are null and validation mode is INSTANCEID_ONLY. This configuration is only applicable when oauth feature is enabled via helm chart.\n",
"operationId" : "patchOauthValidatorConfigurationIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/nrf-client-nfmanagement/nfProfileList" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Returns Log Level Of NFR Client Management",
"operationId" : "getProfileListNrfClientMgm",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NrfClientConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Retrieve the NfProfiles used to register with NRF.\n",
"operationId" : "putProfileListNrfClientMgm",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NrfClientConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "patchProfileListNrfClientMgm",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NrfClientConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/errorcodeprofiles" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "getErrorCodeProfilesIgwSig",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorCodeProfiles"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "putErrorCodeProfilesIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "patchErrorCodeProfilesIgwSig",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/errorcodeprofiles" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "getErrorCodeProfilesEgw",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorCodeProfiles"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "putErrorCodeProfilesEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the errorCodeProfiles that will be used in route level error mapping feature for populating details in error responses when a request is discarded. By default errorCodeProfiles will have value as provided in nf-specific configuration feature, if nf-specific configuration is disabled then default values are considered from values.yaml.\n",
"operationId" : "patchErrorCodeProfilesEgw",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/egw/useragentheader" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of user agent header .\n",
"operationId" : "getUserAgentHeader",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of user agent header .\n",
"operationId" : "putUserAgentHeader",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of user agent header .\n",
"operationId" : "patchUserAgentHeader",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/igw-sig/useragentheadervalidation" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of user agnt header validaiton configuration in IGW.\n",
"operationId" : "getUserAgentHeaderValidation",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of user agnt header validaiton configuration in IGW.\n",
"operationId" : "putUserAgentHeaderValidation",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IGWConfig"
}
}
},
"description" : "DR Service Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"patch" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "This URI can be used to update the configuration of user agnt header validaiton configuration in IGW.\n",
"operationId" : "patchUserAgentHeaderValidation",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "Perf info Configuration",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
},
"/udr/nf-common-component/v1/perf-info/overloadLevelThreshold" : {
"get" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Gets the name of the current active overload threshold profile name.\n",
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
},
"put" : {
"tags" : [ "OCUDR CONFIGURATION" ],
"summary" : "Make the profile as active one.\n",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PerfInfoConfig"
}
}
},
"description" : "OverloadLevelThresholdProfiles PUT",
"required" : true
},
"responses" : {
"201" : {
"description" : "CREATED"
},
"404" : {
"description" : "Not Found",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated" : false
}
}
},
"servers" : [ {
"url" : "//127.0.0.1:8080/"
} ],
"components" : {
"schemas": {
"NotifyServiceConfiguration": {
"type": "object",
"additionalProperties": false,
"properties": {
"notifRetryCount": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"NotifRetryInterval": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"retryErrorCodes": {
"type": "string"
},
"resourceRemovalNotificationEnabled": {
"type": "boolean"
}
}
},
"DrServiceConfiguration": {
"additionalProperties": false,
"properties": {
"subscriptionDataSubscriptionsOnly": {
"type": "boolean"
},
"defaultGroupIdEnabled": {
"type": "boolean"
},
"defaultSLFGroupName": {
"type": "string"
},
"allowSubscriptionRecreation": {
"type": "boolean"
}
}
},
"DrProvServiceConfiguration": {
"additionalProperties": false,
"properties": {
"provLogsEnabled": {
"type": "boolean"
},
"provLogsApiNames": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/ProvLogsApiNames"
}
}
}
},
"ProvLogsApiNames": {
"type": "string"
},
"DiameterConfiguration": {
"type": "object",
"properties": {
"reconnectDelay": {
"type": "integer"
},
"responseTimeout": {
"type": "integer"
},
"connectionTimeOut": {
"type": "integer"
},
"watchdogInterval": {
"type": "integer"
},
"reconnectLimit": {
"type": "integer"
},
"allowedClientNodes": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/ClientNodes"
}
}
}
},
"ClientNodes": {
"type": "object",
"required": [
"identity",
"realm"
],
"properties": {
"responseOnly": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"realm": {
"type": "string"
},
"identity": {
"type": "string"
},
"type": {
"type": "string"
}
},
"additionalProperties": false
},
"GlobalConfiguration": {
"additionalProperties": false,
"type": "object",
"properties": {
"egressGwEnabled": {
"type": "boolean"
},
"snssai": {
"type": "string"
},
"dnn": {
"type": "string"
},
"sbiCorrelationInfoEnable": {
"type": "boolean"
},
"autoCreate": {
"type": "boolean"
},
"subscriberActivityEnabled": {
"type": "boolean"
},
"autoEnrolOnSignalling": {
"type": "boolean"
},
"etagEnabled": {
"type": "boolean"
},
"enableControlledShutdown": {
"type": "boolean"
},
"suppressNotificationEnabled": {
"type": "string"
},
"configClientConnectTimeout": {
"type": "integer"
},
"configClientReadTimeout": {
"type": "integer"
},
"defaultResponse": {
"type": "string"
},
"accessLogEnabled": {
"type": "boolean"
},
"defaultResponseIMEINotFound": {
"type": "string"
},
"imsiLookupFallbackEnabled": {
"type": "boolean"
},
"s13InterfaceEnabled": {
"type": "boolean"
},
"subscriberIdentifers": {
"type": "object",
"properties": {
"msisdn": {
"type": "array",
"items": {
"type": "string"
}
},
"imsi": {
"type": "array",
"items": {
"type": "string"
}
},
"nai": {
"type": "array",
"items": {
"type": "string"
}
},
"extid": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"ProblemDetails": {
"type": "object",
"properties": {
"cause": {
"type": "string"
},
"detail": {
"type": "string"
},
"invalidParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidParam"
}
},
"status": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string"
}
},
"title": "ProblemDetails"
},
"InvalidParam": {
"type": "object",
"properties": {
"param": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"DiamgatewayCongestion": {
"additionalProperties": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"defaultMessagePriority": {
"type": "integer"
},
"sampleCount": {
"type": "integer"
},
"calculationInterval": {
"type": "integer"
},
"loadSheddingRulesMap": {
"$ref": "#/components/schemas/LoadSheddingRulesMap"
},
"priorityRules": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/PriorityRules"
}
},
"thresholds": {
"$ref": "#/components/schemas/Thresholds"
}
}
},
"LoadSheddingRulesMap": {
"type": "object",
"properties": {
"CONGESTED": {
"$ref": "#/components/schemas/CONGESTED"
},
"DOC": {
"$ref": "#/components/schemas/DOC"
}
}
},
"CONGESTED": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"discardPriority": {
"type": "integer"
},
"ansWithResultCode": {
"type": "string"
}
}
},
"DOC": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"discardPriority": {
"type": "integer"
},
"ansWithResultCode": {
"type": "string"
}
}
},
"PriorityRules": {
"type": "object",
"properties": {
"ruleName": {
"type": "string"
},
"messagePriority": {
"type": "integer"
},
"conditions": {
"$ref": "#/components/schemas/Conditions"
}
}
},
"Conditions": {
"type": "object",
"properties": {
"requestType": {
"type": "string"
},
"application": {
"type": "string"
}
}
},
"Thresholds": {
"type": "object",
"properties": {
"CONGESTED": {
"$ref": "#/components/schemas/ThresholdsCONGESTED"
},
"DOC": {
"$ref": "#/components/schemas/ThresholdsDOC"
}
}
},
"ThresholdsCONGESTED": {
"type": "object",
"properties": {
"memory": {
"type": "integer"
},
"cpu": {
"type": "integer"
},
"queue": {
"type": "integer"
}
}
},
"ThresholdsDOC": {
"type": "object",
"properties": {
"memory": {
"type": "integer"
},
"cpu": {
"type": "integer"
},
"queue": {
"type": "integer"
}
}
},
"BulkImportCfg": {
"additionalProperties": false,
"type": "object",
"properties": {
"pollingTimeInterval": {
"type": "number"
},
"pdbiFilePath": {
"type": "string"
},
"remoteDirPath": {
"type": "string"
},
"fileExt": {
"type": "string"
},
"deleteFileFromPVC": {
"type": "boolean"
},
"transferOutPath": {
"type": "string"
}
}
},
"BulkExportCfg": {
"additionalProperties": false,
"type": "object",
"properties": {
"frequencyOfPeriodicDump": {
"type": "string",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"ONE_TIME"
]
},
"startTime": {
"type": "string",
"pattern": "^(\\d{1,2})/(\\d{1,2})/(\\d{4})(\\s+)(\\d{1,2}):(\\d{1,2}):(\\d{1,2})$|^(\\s*)$"
},
"maxNumberOfDumps": {
"type": "integer",
"minimum": 0,
"maximum": 9
},
"fixedDumpFileNameSuffix": {
"type": "string",
"minLength": 0,
"maxLength": 128,
"pattern": "^[^/\\s]*$"
},
"fixedDumpFileNamePrefix": {
"type": "string",
"minLength": 0,
"maxLength": 12,
"pattern": "^[^/\\s]*$"
},
"configuredString": {
"type": "string",
"minLength": 3,
"maxLength": 12
},
"timeStampFormat": {
"type": "string",
"anyOf": [
{
"pattern": "^([yY]{4}[mM]{2}[dD]{2}[hH]{2}[mM]{2}[sS]{2})$"
},
{
"pattern": "^([yY]{4}[mM]{2}[dD]{2}[hH]{2}[mM]{2}[sS]{2})$"
}
]
},
"multiValuedelimiter": {
"type": "string",
"pattern": "^.{1}$"
},
"fieldDelimiter": {
"type": "string",
"pattern": "^.{1}$"
},
"fileExtension": {
"type": "string",
"enum": [
".csv",
".txt",
".exml"
]
},
"remotePath": {
"type": "string",
"pattern": "^.*\/$"
},
"deleteFromPVC": {
"type": "boolean"
},
"imsiCount": {
"type": "integer",
"minimum": 0,
"maximum": 9
},
"msisdnCount": {
"type": "integer",
"minimum": 0,
"maximum": 9
},
"subscriberRangeEnabled": {
"type": "boolean"
},
"newFilePerRangeEnabled": {
"type": "boolean"
},
"subscriberExportRange": {
"$ref": "#/components/schemas/SubscriberExportRange"
},
"exportFileExpiryTime": {
"type": "string",
"pattern": "^[0-9]+[dm]$"
},
"policyDataResources": {
"type": "string",
"enum" : ["sm-data,am-data,ue-policy-set",
"sm-data,ue-policy-set,am-data",
"am-data,ue-policy-set,sm-data",
"am-data,sm-data,ue-policy-set",
"ue-policy-set,am-data,sm-data",
"ue-policy-set,sm-data,am-data",
"sm-data,am-data",
"sm-data,ue-policy-set",
"ue-policy-set,sm-data",
"ue-policy-set,am-data",
"am-data,sm-data",
"am-data,ue-policy-set",
"sm-data",
"am-data",
"ue-policy-set"]
}
}
},
"SubscriberExportRange": {
"type": "object",
"properties": {
"keyType": {
"type": "string",
"enum": [
"imsi",
"msisdn"
]
},
"subscriberRanges": {
"type": "array",
"maxItems": 5,
"items": {
"type": "string",
"pattern": "^[0-9]{5,15}-[0-9]{5,15}$"
}
}
}
},
"BulkExportFileStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BEFObject"
}
},
"BEFObject": {
"properties": {
"jobId": {
"type": "string"
},
"fileName": {
"type": "string"
},
"filePath": {
"type": "string"
},
"completeTime": {
"type": "string"
},
"startTime": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"BulkExportToolStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BEObject"
}
},
"BEObject": {
"properties": {
"jobId": {
"type": "string"
},
"subscriberCount": {
"type": "integer"
},
"exportedSubscriberCount": {
"type": "integer"
},
"jobProgress": {
"type": "string"
},
"status": {
"type": "string"
},
"exportState": {
"type": "string"
}
}
},
"BulkExportToolStatusJobId": {
"type": "object",
"properties": {
"jobId": {
"type": "string"
},
"subscriberCount": {
"type": "integer"
},
"exportedSubscriberCount": {
"type": "integer"
},
"jobProgress": {
"type": "string"
},
"status": {
"type": "string"
},
"exportState": {
"type": "string"
},
"exportFileStatusList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BEJobIdObject"
}
}
}
},
"BEJobIdObject": {
"properties": {
"jobId": {
"type": "string"
},
"fileName": {
"type": "string"
},
"filePath": {
"type": "string"
},
"completeTime": {
"type": "string"
},
"startTime": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"BIConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BIObject"
}
},
"BIObject": {
"properties": {
"importFile": {
"type": "string"
},
"timeQueued": {
"type": "string"
},
"timeStarted": {
"type": "string"
},
"timeCompleted": {
"type": "string"
},
"progress": {
"type": "number"
},
"failedKeys": {
"type": "string"
},
"passCount": {
"type": "integer"
},
"failCount": {
"type": "integer"
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
}
}
},
"ExportConfiguration": {
"type": "object",
"properties": {
"Exportresourceid": {
"type": "string"
}
}
},
"ExportId": {
"type": "array",
"items": {
"type": "string"
}
},
"ImportId": {
"type": "array",
"items": {
"type": "string"
}
},
"ExportStatus": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"exportResourceId": {
"type": "string"
},
"createTimeStamp": {
"type": "string"
},
"percentage": {
"type": "string"
},
"result": {
"type": "string"
}
}
},
"ExportReport": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Report"
}
},
"Report": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ImportConfiguration": {
"type": "object",
"properties": {
"Exportresourceid": {
"type": "string"
}
}
},
"ImportStatus": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"exportResourceId": {
"type": "string"
},
"createTimeStamp": {
"type": "string"
},
"percentage": {
"type": "string"
},
"result": {
"type": "string"
}
}
},
"ImportReport": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Report"
}
},
"Download": {
"type": "object"
},
"LogConfiguration": {
"type": "object",
"required": [
"appLogLevel"
],
"properties": {
"logSubscriberInfo": {
"type": "string"
},
"additionalErrorLogging": {
"type": "string"
},
"appLogLevel": {
"type": "string",
"enum": [
"DEBUG",
"ERROR",
"WARN",
"INFO"
]
},
"packageLogLevel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageLog"
}
}
}
},
"PackageLog": {
"type": "object",
"properties": {
"packageName": {
"type": "string"
},
"logLevelForPackage": {
"type": "string"
}
},
"required": [
"packageName",
"logLevelForPackage"
]
},
"GwLogConfiguration": {
"type": "object",
"required": [
"appLogLevel"
],
"properties": {
"appLogLevel": {
"type": "string",
"enum": [
"DEBUG",
"ERROR",
"WARN",
"INFO"
]
},
"packageLogLevel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageLog"
}
},
"logDiscarding": {
"$ref": "#/components/schemas/GWLogDiscarding"
}
}
},
"GWLogDiscarding": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"featureToThresholdMapping": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/GWFeatureToThresholdMapping"
}
}
}
},
"GWFeatureToThresholdMapping": {
"type": "object",
"properties": {
"feature": {
"type": "string"
},
"thresholdFactor": {
"type": "string"
}
}
},
"AllLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllLogCfg"
}
},
"AllLogCfg": {
"type": "object",
"properties": {
"egress-gateway": {
"type": "string"
},
"nudr-diameterproxy": {
"type": "string"
},
"diam-gateway": {
"type": "string"
},
"alternate-route": {
"type": "string"
},
"nudr-drservice": {
"type": "string"
},
"nudr-notify-service": {
"type": "string"
},
"ingress-gateway": {
"type": "string"
}
}
},
"OperationalStateConfiguration": {
"type": "object",
"properties": {
"operationalState": {
"type": "string"
}
}
},
"OperationalStateHistory": {
"type": "object",
"properties": {
"operationalState": {
"type": "string"
},
"operationalStateHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationStateHistoryArray"
}
}
}
},
"OperationStateHistoryArray": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"LoggingConfig": {
"type": "object",
"description": "An explanation about the purpose of this instance.",
"properties": {
"appLogLevel": {
"type": "string",
"enum": [
"CRITICAL",
"FATAL",
"ERROR",
"WARN",
"WARNING",
"INFO",
"DEBUG",
"TRACE"
],
"description": "An explanation about the purpose of this instance."
},
"packageLogLevel": {
"type": "array",
"minItems": 0,
"maxItems": 10,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/PackageLogLevelItems"
},
"description": "An explanation about the purpose of this instance."
}
},
"required": [
"appLogLevel"
]
},
"PackageLogLevelItems": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"enum": [
"service_monitor",
"flask.app",
"flask",
"dbtest",
"perf_info",
"perfapp",
"data2sum",
"log_level_agent",
"overload_manager",
"root",
"httpx",
"hpack",
"httpcore",
"hpack.hpack",
"hpack.table",
"omc",
"omc.config",
"omc.query",
"omc.metrics"
],
"description": "An explanation about the purpose of this instance."
},
"logLevelForPackage": {
"type": "string",
"enum": [
"CRITICAL",
"FATAL",
"ERROR",
"WARN",
"WARNING",
"INFO",
"DEBUG",
"TRACE"
],
"description": "An explanation about the purpose of this instance."
}
},
"required": [
"packageName",
"logLevelForPackage"
],
"description": "An explanation about the purpose of this instance."
},
"OverloadLevelThreshold": {
"type": "array",
"description": "overload service loadlevel threshold list",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/OverloadServiceThreshold"
}
},
"OverloadServiceThreshold": {
"type": "object",
"properties": {
"svcName": {
"type": "string"
},
"metricsThresholdList": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/MetricsThreshold"
}
}
},
"required": [
"svcName",
"metricsThresholdList"
],
"description": "overload service loadlevel threshod list"
},
"MetricsThreshold": {
"type": "object",
"properties": {
"metricsName": {
"type": "string",
"enum": [
"svc_pending_count",
"svc_failure_count",
"cpu",
"memory"
]
},
"levelThresholdList": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/LevelThreshold"
}
}
},
"required": [
"metricsName",
"levelThresholdList"
],
"description": "overload metrics loadlevel threshod list"
},
"LevelThreshold": {
"type": "object",
"properties": {
"level": {
"type": "string"
},
"onsetValue": {
"type": "integer",
"minimum": 0
},
"abatementValue": {
"type": "integer",
"minimum": 0
}
},
"required": [
"level",
"onsetValue",
"abatementValue"
],
"description": "overload level loadlevel threshod list"
},
"ActiveOverloadLevelThresholdProfile": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isCustomProfile": {
"type": "boolean"
}
},
"required": [
"name",
"isCustomProfile"
]
},
"OverloadLevelThresholdProfile": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"$ref": "#/components/schemas/OverloadLevelThreshold"
}
},
"required": [
"name",
"value"
]
},
"PerfInfoConfig": {
"type": "object",
"properties": {
"logging": {
"$ref": "#/components/schemas/LoggingConfig"
},
"overloadLevelThreshold": {
"$ref": "#/components/schemas/OverloadLevelThreshold"
},
"activeOverloadLevelThresholdProfileName": {
"$ref": "#/components/schemas/ActiveOverloadLevelThresholdProfile"
},
"systemOverloadLevelThresholdProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverloadLevelThresholdProfile"
}
},
"customOverloadLevelThresholdProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverloadLevelThresholdProfile"
}
}
}
},
"AppLoggingConfig": {
"type": "object",
"description": "An explanation about the purpose of this instance.",
"properties": {
"appLogLevel": {
"type": "string",
"enum": [
"CRITICAL",
"FATAL",
"ERROR",
"WARN",
"WARNING",
"INFO",
"DEBUG",
"TRACE"
],
"description": "An explanation about the purpose of this instance."
},
"packageLogLevel": {
"type": "array",
"minItems": 0,
"maxItems": 6,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/PackageLogLevel"
},
"description": "An explanation about the purpose of this instance."
}
},
"required": [
"appLogLevel"
]
},
"PackageLogLevel": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"enum": [
"namespace_runtime_info",
"service_monitor",
"mysql_monitor",
"replication_status_monitor",
"service_status_scraper",
"log_level_agent"
],
"description": "An explanation about the purpose of this instance."
},
"logLevelForPackage": {
"type": "string",
"enum": [
"CRITICAL",
"FATAL",
"ERROR",
"WARN",
"WARNING",
"INFO",
"DEBUG",
"TRACE"
],
"description": "An explanation about the purpose of this instance."
}
},
"required": [
"packageName",
"logLevelForPackage"
],
"description": "An explanation about the purpose of this instance."
},
"NfScoringConfig": {
"type": "object",
"description": "NF scoring configuration.",
"properties": {
"enableNFScoring": {
"type": "boolean",
"description": "flag used to enable and disable NF Scoring feature"
},
"tps": {
"$ref": "#/components/schemas/TpsConfig"
},
"serviceHealth": {
"$ref": "#/components/schemas/ServiceHealthConfig"
},
"signallingConnections": {
"$ref": "#/components/schemas/SignallingConnectionsConfig"
},
"replicationHealth": {
"$ref": "#/components/schemas/ReplicationHealthConfig"
},
"localitySitePreference": {
"$ref": "#/components/schemas/LocalitySitePreferenceConfig"
},
"activeAlert": {
"$ref": "#/components/schemas/ActiveAlertConfig"
},
"customCriteria": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomCriteria"
}
}
},
"required": [
"enableNFScoring",
"tps",
"serviceHealth",
"signallingConnections",
"replicationHealth",
"localitySitePreference",
"activeAlert"
],
"additionalProperties": false
},
"AppInfoConfig": {
"type": "object",
"properties": {
"logging": {
"$ref": "#/components/schemas/AppLoggingConfig"
},
"nfScoring": {
"$ref": "#/components/schemas/NfScoringConfig"
},
"dbClusterEventTracking": {
"$ref": "#/components/schemas/DbClusterEventTracking"
}
}
},
"TpsConfig": {
"type": "object",
"description": "TPS configuration.",
"required": ["enable"],
"properties": {
"enable": {
"type": "boolean"
},
"maxScore": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20
},
"maxTps": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"additionalProperties": false
},
"ServiceHealthConfig": {
"type": "object",
"description": "Service health configuration.",
"required": ["enable"],
"properties": {
"enable": {
"type": "boolean"
},
"maxScore": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 30
}
},
"additionalProperties": false
},
"SignallingConnectionsConfig": {
"type": "object",
"description": "Signalling connections configuration.",
"required": ["enable"],
"properties": {
"enable": {
"type": "boolean"
},
"maxScore": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20
},
"maxConnections": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
"additionalProperties": false
},
"ReplicationHealthConfig": {
"type": "object",
"description": "Replication health configuration.",
"required": ["enable"],
"properties": {
"enable": {
"type": "boolean"
},
"maxScore": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 30
}
},
"additionalProperties": false
},
"LocalitySitePreferenceConfig": {
"type": "object",
"description": "Locality site preference configuration.",
"required": ["enable"],
"properties": {
"enable": {
"type": "boolean"
},
"score": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 5
}
},
"additionalProperties": false
},
"ActiveAlertConfig": {
"type": "object",
"description": "Active alert configuration.",
"required": ["enable"],
"properties": {
"enable": {
"type": "boolean"
},
"criticalAlertWeightage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 2
},
"majorAlertWeightage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 1
},
"minorAlertWeightage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 0
}
},
"additionalProperties": false
},
"CustomCriteria": {
"type": "array",
"description": "list of custom criterias",
"items": {
"type": "object",
"description": "Data related to custom criteria",
"properties": {
"enable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"metricName": {
"type": "string"
},
"scoringType": {
"enum": [
"ratio",
"weightage"
],
"type": "string",
"description": "Type of nfscoring for the parameter"
},
"maxScore": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 30
},
"maxValue": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"weightage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 1
}
}
}
},
"DbClusterEventTracking": {
"type": "object",
"description": "DB cluster event tracking configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "flag used to enable and disable DB Cluster Event Tracking feature"
},
"autoTransition": {
"type": "boolean",
"description": "flag used to transition NF state from failure to functional state automatically"
}
},
"additionalProperties": false,
"required": [
"enabled",
"autoTransition"
]
},
"NrfLoggingConfig": {
"type": "object",
"description": "The attribute represents the log level Configuration for NrfClient Management Service",
"properties": {
"appLogLevel": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"WARN",
"ERROR",
"FATAL",
"OFF",
"TRACE",
"ALL"
],
"description": "Values of LogLevel"
},
"packageLogLevel": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/NrfPackageLogLevel"
},
"description": "The attribute represents the package level logging for NrfClient Management Service"
},
"additionalErrorLogging": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
],
"description": "This attribute allows the microservice to enable or disable the printing of new error fields on logs"
},
"logSubscriberInfo": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
],
"description": "This attribute allows the microservice to enable or disable the printing of subscriber ID information in the log"
}
},
"required": [
"appLogLevel",
"packageLogLevel"
]
},
"NrfPackageLogLevel": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"enum": [
"root"
],
"description": "The package Name."
},
"logLevelForPackage": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"WARN",
"ERROR",
"FATAL",
"OFF",
"TRACE",
"ALL"
],
"description": "Values of LogLevel"
}
},
"required": [
"packageName",
"logLevelForPackage"
],
"description": "The attribute is the list of Package names."
},
"NfProfile": {
"type": "object",
"description": "The attribute represents the individual nfProfile for NrfClient Management Service."
},
"GeneralOptions": {
"type": "object",
"description": "The attribute represents the General options of NrfClient Management Service.",
"properties": {
"nfProfileUpdateMode": {
"type": "string",
"enum": [
"CompleteUpdate",
"PartialUpdate"
],
"description": "The attribute represents the mode for NFUpdate of NRFClient Management Service."
},
"triggerNfRegistration": {
"type": "boolean",
"description": "This attribute controls the autonomous registration of the NF."
}
},
"required": [
"nfProfileUpdateMode"
],
"additionalProperties": false
},
"NrfRoute": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "The scheme of NrfRoute."
},
"nrfApi": {
"type": "string",
"description": "The Api for NrfRoute."
},
"priority": {
"type": "integer",
"description": "The priority for NrfRoute."
},
"weight": {
"type": "integer",
"description": "The weight for NrfRoute."
}
},
"description": "The attribute is the NRF Route."
},
"DynamicLoadAndCapacity": {
"type": "object",
"description": "Object that contains the flags for the dynamic load and capacity",
"properties": {
"nfProfileCapacity": {
"type": "boolean",
"description": "Flag to determine if NfProfileCapacity is to be taken from perf-info or from operator"
},
"nfProfileLoad": {
"type": "boolean",
"description": "Flag to determine if nfProfileLoad is to be taken from perf-info or from operator"
},
"nfServiceCapacity": {
"type": "boolean",
"description": "Flag to determine if nfServiceCapacity is to be taken from perf-info or from operator"
},
"nfServiceLoad": {
"type": "boolean",
"description": "Flag to determine if nfServiceLoad is to be taken from perf-info or from operator"
}
},
"additionalProperties": false,
"required": [
"nfProfileCapacity",
"nfProfileLoad",
"nfServiceCapacity",
"nfServiceLoad"
]
},
"NfPeerInfoSettings": {
"type": "object",
"description": "Configuration object that defines the behaviour of the SBI-NF-Peer-Info Header feature",
"properties": {
"enabledNfPeerInfoHeaderInterface": {
"type": "boolean",
"description": "Flag to enable/disable the SBI-NF-Peer-Info Header feature"
},
"includeSrcServInstId": {
"type": "boolean",
"description": "Flag to include/remove srcservinst to the SBI-NF-Peer-Info Header feature"
}
}
},
"TrafficPrioritization": {
"type": "object",
"description": "Configuration object that defines the behaviour of the trafficPrioritization feature",
"properties": {
"featureEnabled": {
"type": "boolean",
"description": "Flag to enable/disable the trafficPrioritization feature"
},
"incomingPriorityHeader": {
"type": "string",
"description": "Header name for the incoming request"
},
"outgoingPriorityHeader": {
"type": "string",
"description": "Header name for the outgoing request"
},
"nfSubscribeMessageTypes": {
"type": "array",
"description": "Message priority value for subscribe autonomous message request types, all autonomous operation associated to nrfClientSubscribeTypes",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/NfSubscribeMessageType"
}
},
"messageTypes": {
"type": "array",
"description": "Message priority value for rest of the message request types that are not nfSubscribe Message types",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/MessageType"
}
}
},
"additionalProperties": false,
"required": [
"featureEnabled",
"incomingPriorityHeader",
"outgoingPriorityHeader",
"nfSubscribeMessageTypes",
"messageTypes"
]
},
"NfSubscribeMessageType": {
"type": "object",
"properties": {
"messageType": {
"type": "string",
"enum": [
"AutonomousNfDiscovery",
"AutonomousNfSubscribe",
"AutonomousNfUnSubscribe",
"AutonomousNfSubscriptionUpdate"
],
"description": "Message type can be ondemand or autonomous"
},
"subscribeNfTypes": {
"type": "array",
"description": "List of nfTypes for the configured priority",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/SubscribeNfType"
}
}
},
"additionalProperties": false,
"required": [
"messageType",
"subscribeNfTypes"
]
},
"SubscribeNfType": {
"type": "object",
"properties": {
"nfType": {
"type": "string",
"description": "Name of the configured nfType"
},
"priority": {
"type": "string",
"pattern": "^([0-9]|1[0-9]|2[0-9]|3[01])$",
"description": "Priority value set for the specified nfType"
}
},
"required": [
"nfType",
"priority"
]
},
"MessageType": {
"type": "object",
"properties": {
"messageType": {
"type": "string",
"enum": [
"AutonomousOnDemandNFRegistration",
"AutonomousHealthCheck",
"NfDiscovery",
"NfHeartBeat",
"AutonomousNfPatch",
"NfProfileUpdate",
"NfSubscribe",
"NfSubscriptionUpdate",
"NfUnSubscribe",
"NfDeRegistration",
"AutonomousNfDeRegistration",
"NfProfileRetrieval",
"NfListRetrieval"
],
"description": "Type of non discovery message request"
},
"priority": {
"type": "string",
"pattern": "^([0-9]|1[0-9]|2[0-9]|3[01])$",
"description": "Priority value set for the specified request type"
}
},
"additionalProperties": false,
"required": [
"messageType",
"priority"
]
},
"NrfClientConfig": {
"type": "object",
"properties": {
"logging": {
"$ref": "#/components/schemas/NrfLoggingConfig"
},
"nfProfileList": {
"type": "array",
"description": "The attribute represents the list of nfProfiles for NrfClient Management Service.",
"items": {
"$ref": "#/components/schemas/NfProfile"
}
},
"generalOptions": {
"$ref": "#/components/schemas/GeneralOptions"
},
"nrfRouteList": {
"type": "array",
"description": "The attribute represents the list of NRF Routes.",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/NrfRoute"
}
},
"dynamicLoadAndCapacity": {
"$ref": "#/components/schemas/DynamicLoadAndCapacity"
},
"nfPeerInfoSettings": {
"$ref": "#/components/schemas/NfPeerInfoSettings"
},
"trafficPrioritization": {
"$ref": "#/components/schemas/TrafficPrioritization"
}
}
},
"AltRouteLoggingConfig": {
"type": "object",
"description": "An explanation about the purpose of this instance.",
"properties": {
"appLogLevel": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"WARN",
"ERROR",
"FATAL",
"OFF",
"TRACE",
"ALL"
],
"description": "An explanation about the purpose of this instance."
},
"packageLogLevel": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/AltRoutePackageLogLevel"
},
"description": "An explanation about the purpose of this instance."
},
"additionalErrorLogging": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
}
},
"required": [
"appLogLevel",
"packageLogLevel"
]
},
"AltRoutePackageLogLevel": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"enum": [
"root"
],
"description": "An explanation about the purpose of this instance."
},
"logLevelForPackage": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"WARN",
"ERROR",
"FATAL",
"OFF",
"TRACE",
"ALL"
],
"description": "An explanation about the purpose of this instance."
}
},
"required": [
"packageName",
"logLevelForPackage"
],
"description": "An explanation about the purpose of this instance."
},
"UpstreamDnsConfig": {
"type": "object",
"description": "An explanation about the purpose of this instance.",
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "string"
},
"zone": {
"type": "string"
},
"tsigKeyNamespace": {
"type": "string"
},
"tsigKeySecretName": {
"type": "string"
},
"upstreamDNSTimeout": {
"type": "integer"
},
"watchSecretTimeout": {
"type": "integer"
},
"fixedTsigKeyMonitorDelay": {
"type": "integer"
}
},
"required": [
"enabled"
]
},
"AltRouteConfig": {
"type": "object",
"properties": {
"logging": {
"$ref": "#/components/schemas/AltRouteLoggingConfig"
},
"upstreamDnsConfig": {
"$ref": "#/components/schemas/UpstreamDnsConfig"
}
}
},
"HealthCheckConfigObject": {
"type": "object",
"properties": {
"healthCheckResponseCode": {
"type": "integer",
"enum": [
200,
201,
202,
203,
204,
205,
206,
207,
208,
226
],
"description": "Parameter to configure health check response code"
},
"healthCheckRequestMethod": {
"type": "string",
"enum": [
"GET",
"OPTIONS"
],
"description": "Parameter to configure health check request method"
},
"healthCheckResourceUri": {
"type": "string",
"description": "Parameter to configure health check request method"
}
},
"required": [
"healthCheckResponseCode",
"healthCheckRequestMethod",
"healthCheckResourceUri"
]
},
"HealthCheckConfig": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag for enabling health-check-monitoring feature"
},
"healthCheckConfigObject": {
"$ref": "#/components/schemas/HealthCheckConfigObject"
}
},
"required": [
"enabled",
"healthCheckConfigObject"
],
"description": "Health check configuration",
"additionalProperties": false
},
"GWPackageLogLevel": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"enum": [
"root",
"oauth"
],
"description": "An explanation about the purpose of this instance."
},
"logLevelForPackage": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"WARN",
"ERROR",
"FATAL",
"OFF",
"TRACE",
"ALL"
],
"description": "An explanation about the purpose of this instance."
}
},
"required": [
"packageName",
"logLevelForPackage"
],
"description": "An explanation about the purpose of this instance."
},
"GWLoggingConfig": {
"type": "object",
"properties": {
"appLogLevel": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"WARN",
"ERROR",
"FATAL",
"OFF",
"TRACE",
"ALL"
],
"description": "An explanation about the purpose of this instance."
},
"packageLogLevel": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/GWPackageLogLevel"
},
"description": "An explanation about the purpose of this instance."
},
"logDiscarding": {
"$ref": "#/components/schemas/LogDiscarding"
},
"additionalErrorLogging": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"logSubscriberInfo": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
}
},
"required": [
"appLogLevel",
"packageLogLevel"
]
},
"LogDiscarding": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"featureToThresholdMapping": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/FeatureToThresholdMapping"
}
}
},
"required": [
"enabled",
"featureToThresholdMapping"
]
},
"FeatureToThresholdMapping": {
"type": "object",
"properties": {
"feature": {
"type": "string",
"enum": [
"RATE_LIMITING",
"OVERLOAD_CONTROL",
"ROUTE_LEVEL_RATE_LIMITING",
"RSS_RATE_LIMITING",
"EGRESS_RATE_LIMITING"
]
},
"thresholdFactor": {
"type": "integer"
}
},
"required": [
"feature",
"thresholdFactor"
]
},
"OAuthValidatorConfiguration": {
"type": "object",
"description": "Validator configurations for oAuth",
"required": [
"oauthValidationMode"
],
"properties": {
"keyIdList": {
"type": "array",
"uniqueItems": true,
"maxItems": 150,
"description": "Array containing KID based configuration",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"keyId": {
"type": "string",
"minLength": 1,
"maxLength": 36,
"pattern": "[a-zA-Z0-9]"
},
"kSecretName": {
"type": "string"
},
"certName": {
"type": "string"
},
"certAlgorithm": {
"type": "string"
}
},
"required": [
"keyId",
"kSecretName",
"certName",
"certAlgorithm"
]
}
]
}
},
"instanceIdList": {
"type": "array",
"uniqueItems": true,
"maxItems": 150,
"description": "Array containing Instance Id based configuration",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"instanceId": {
"type": "string"
},
"kSecretName": {
"type": "string"
},
"certName": {
"type": "string"
},
"certAlgorithm": {
"type": "string"
}
},
"required": [
"instanceId",
"kSecretName",
"certName",
"certAlgorithm"
]
}
]
}
},
"oauthValidationMode": {
"type": "string",
"enum": [
"KID_ONLY",
"INSTANCEID_ONLY",
"KID_PREFERRED"
],
"description": "Mode of validation"
}
}
},
"ErrorCodeProfiles": {
"type": "array",
"description": "An explanation about the purpose of this instance.",
"default": [],
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"description": "An explanation about the purpose of this instance.",
"required": [
"name",
"errorCode"
],
"properties": {
"name": {
"type": "string"
},
"errorCode": {
"type": "integer",
"enum": [
300,
301,
302,
303,
304,
305,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
418,
421,
422,
423,
424,
425,
426,
428,
429,
431,
444,
451,
499,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
]
},
"errorDescription": {
"type": "string",
"default": ""
},
"errorTitle": {
"type": "string",
"default": ""
},
"errorCause": {
"type": "string",
"default": ""
},
"redirectUrl": {
"type": "string",
"default": ""
},
"retryAfter": {
"type": "string"
}
}
}
]
}
},
"OCDiscardPolicies": {
"type": "array",
"description": "An explanation about the purpose of this instance.",
"default": [],
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"description": "An explanation about the purpose of this instance.",
"required": [
"name",
"scheme",
"policies"
],
"properties": {
"name": {
"type": "string"
},
"scheme": {
"type": "string",
"enum": [
"PriorityBased",
"PercentageBased"
]
},
"policies": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"level",
"value",
"errorCodeProfile",
"action"
],
"properties": {
"level": {
"type": "string"
},
"value": {
"type": "integer",
"minimum": 0
},
"errorCodeProfile": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"RejectWithErrorCode"
]
}
}
}
]
}
}
}
}
]
}
},
"OCPolicyMapping": {
"type": "object",
"description": "An explanation about the purpose of this instance.",
"required": [
"enabled",
"samplingPeriod",
"mappings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"samplingPeriod": {
"type": "integer",
"minimum": 0
},
"mappings": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"svcName",
"policyName"
],
"properties": {
"svcName": {
"type": "string"
},
"policyName": {
"type": "string"
}
}
}
]
}
}
}
},
"RouteLevelRateLimiting": {
"type": "object",
"required": [
"enabled",
"samplingPeriod",
"rateLimitPolicies"
],
"properties": {
"enabled": {
"type": "boolean"
},
"samplingPeriod": {
"type": "integer",
"minimum": 0
},
"rateLimitPolicies": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"scheme",
"value",
"action",
"errorCodeProfile"
],
"properties": {
"name": {
"type": "string"
},
"scheme": {
"type": "string",
"enum": [
"PriorityBased"
]
},
"value": {
"type": "integer",
"minimum": 0
},
"action": {
"type": "string",
"enum": [
"RejectWithErrorCode"
]
},
"errorCodeProfile": {
"type": "string"
}
}
}
]
}
}
}
},
"ServerHeaderDetails": {
"required": [
"enabled",
"configuration"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"errorCodeSeriesId": {
"type": "string"
},
"configuration": {
"required": [
"nfType"
],
"type": "object",
"properties": {
"nfType": {
"type": "string"
},
"nfInstanceId": {
"type": "string"
}
}
}
}
},
"IGWRoutesConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
},
"default": []
},
"Route": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"failureReqCountErrorCodeSeriesId": {
"type": "string"
},
"rateLimiting": {
"$ref": "#/components/schemas/RateLimiting"
},
"serverHeaderDetails": {
"$ref": "#/components/schemas/ServerHeaderDetails"
},
"uri": {
"type": "string"
},
"order": {
"type": "integer"
},
"predicates": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/Predicate"
}
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Filter"
}
},
"metadata": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"oneOf": [
{"type": "string"},
{"type": "number"},
{"type": "boolean"},
{"type": "object"}
]
}
},
"default": []
}
}
},
"RateLimiting": {
"type": "object",
"required": [
"methods"
],
"properties": {
"methods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Method"
}
}
}
},
"Method": {
"type": "object",
"required": [
"name",
"rate",
"rateLimitPolicy"
],
"properties": {
"name": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
]
},
"rate": {
"type": "integer",
"minimum": 0
},
"rateLimitPolicy": {
"type": "string"
}
}
},
"Predicate": {
"type": "object",
"required": [
"name",
"args"
],
"properties": {
"name": {
"type": "string"
},
"args": {
"type": "object",
"properties": {
"patternproperties": {
"pattern":".{1,}",
"type": "string"
}
}
}
}
},
"Filter": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"args": {
"type": "object",
"properties": {
"patternproperties": {
"pattern": ".{1,}",
"type": "string"
}
}
}
}
},
"MessageLogging": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"responseCodeSeries": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"responseSet",
"responseCodes"
],
"properties": {
"responseSet": {
"type": "string",
"enum": [
"1xx",
"2xx",
"3xx",
"4xx",
"5xx"
]
},
"responseCodes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"enum": [
-1,
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
418,
421,
422,
423,
424,
425,
426,
428,
429,
431,
444,
451,
499,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511,
599
]
}
]
}
}
}
}
]
}
},
"whiteListedHeaders": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
]
}
}
}
},
"ErrorCodeSeriesList": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"exceptionList": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"ConnectionTimeout",
"RequestTimeout",
"UnknownHostException",
"ConnectException",
"NotFoundException",
"SocketException"
]
}
]
}
},
"errorCodeSeries": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"errorSet",
"errorCodes"
],
"properties": {
"errorSet": {
"type": "string",
"enum": [
"3xx",
"4xx",
"5xx"
]
},
"errorCodes": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "integer",
"enum": [
-1,
300,
301,
302,
303,
304,
305,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
418,
421,
422,
423,
424,
425,
426,
428,
429,
431,
444,
451,
499,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
]
}
]
}
}
}
}
]
}
}
}
}
]
}
},
"TrafficRejectMode": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"errorCodeProfile": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"description": "This is to reject the incoming request based on flag with defined error code."
},
"PodProtection": {
"type": "object",
"description": "POD Protection Feature",
"additionalProperties": false,
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"monitoringInterval": {
"type": "integer",
"minimum": 0
},
"congestionControl": {
"type": "object",
"description": "Congestion Control Configurations",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"stateChangeSampleCount": {
"type": "integer",
"minimum": 0
},
"actionSamplingPeriod": {
"type": "integer",
"minimum": 0
},
"states": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"weight": {
"type": "integer",
"minimum": 0
},
"resourceThreshold": {
"type": "object",
"description": "Congestion Control Threshold",
"properties": {
"cpu": {
"type": "integer",
"minimum": 0
},
"memory": {
"type": "integer",
"minimum": 0
},
"pendingMessage": {
"type": "integer",
"minimum": 0
}
}
},
"entryAction": {
"type": "array",
"uniqueItems": true,
"description": "Entry Action for different states",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string"
},
"arguments": {
"type": "object",
"description": "POD Protection Entry Action Operations",
"properties": {
"accept": {
"type": "boolean"
},
"incrementBy": {
"type": "integer",
"minimum": 0
},
"incrementByActionSamplingPeriod": {
"type": "integer",
"minimum": 0
},
"decrementBy": {
"type": "integer",
"minimum": 0
},
"decrementByActionSamplingPeriod": {
"type": "integer",
"minimum": 0
},
"maxConcurrentStreamsPerCon": {
"type": "integer",
"minimum": 0
}
}
}
}
}
]
}
}
}
}
]
}
}
}
}
}
},
"XfccHeaderValidation": {
"type": "object",
"description": "XFCC Feature",
"additionalProperties": false,
"required": [
"validation",
"extract"
],
"properties": {
"validation": {
"type": "object",
"description": "Validation Configurations",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"peerlist": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"scheme": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
]
}
},
"matchcerts": {
"type": "integer"
},
"matchfield": {
"type": "string"
},
"dnsresolutioninterval": {
"type": "integer"
}
}
},
"extract": {
"type": "object",
"description": "Extract Configurations",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"certextractindex": {
"type": "integer"
},
"extractfield": {
"type": "string"
},
"extractindex": {
"type": "integer"
}
}
}
}
},
"ReadinessConfig": {
"type": "object",
"description": "Readiness configurations for ingress gateway",
"additionalProperties": false,
"properties": {
"serviceProfiles": {
"type": "array",
"uniqueItems": true,
"description": "Array containing details about backend services",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"url",
"onExceptionUsePreviousState",
"initialState"
],
"anyOf": [
{
"required": [
"responseCode"
]
},
{
"required": [
"responseBody"
]
}
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"responseCode": {
"type": "number"
},
"responseBody": {
"type": "string"
},
"onExceptionUsePreviousState": {
"type": "boolean"
},
"initialState": {
"type": "string",
"enum": [
"ACCEPTING_TRAFFIC",
"REFUSING_TRAFFIC"
],
"description": "Initial state of ingress gateway"
},
"requestTimeout": {
"type": "number"
}
}
}
]
}
}
}
},
"UserAgentHeaderValidation": {
"type": "object",
"description": "Configuration for User-Agent header validation",
"additionalProperties": false,
"required": [
"validationType",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"validationType": {
"type": "string",
"enum": [
"strict",
"relaxed"
]
},
"consumerNfTypes": {
"type": "array",
"uniqueItems": true,
"description": "Array containing list of consumer NF Types",
"items": {
"type": "string"
}
}
}
},
"ConfigurableErrorCodes": {
"type": "object",
"required": [
"enabled",
"errorScenarios"
],
"properties": {
"enabled": {
"type": "boolean"
},
"errorScenarios": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"exceptionType",
"errorProfileName"
],
"properties": {
"exceptionType": {
"type": "string",
"enum": [
"CONNECTION_TIMEOUT",
"REQUEST_TIMEOUT",
"UNKNOWN_HOST_EXCEPTION",
"CONNECT_EXCEPTION",
"REJECTED_EXECUTION_EXCEPTION",
"BLACKLIST_IP_EXCEPTION",
"CLOSED_CHANNEL_EXCEPTION",
"NOT_FOUND_EXCEPTION",
"INTERNAL_ERROR",
"LATE_ARRIVAL_EXCEPTION",
"USERAGENT_VALIDATION_FAILURE_EXCEPTION",
"GLOBAL_RATELIMIT",
"GRACEFUL_SHUTDOWN",
"OAUTH_TOKEN_VALIDATION_FAILURE",
"OAUTH_CERT_EXPIRED",
"OAUTH_MISMATCH_IN_KID",
"OAUTH_PRODUCER_SCOPE_NOT_PRESENT",
"OAUTH_PRODUCER_SCOPE_MISMATCH",
"OAUTH_MISMATCH_IN_NRF_INSTNACEID",
"OAUTH_PRODUCER_PLMNID_MISMATCH",
"OAUTH_AUDIENCE_NOT_PRESENT_OR_INVALID",
"OAUTH_TOKEN_INVALID",
"OAUTH_TOKEN_ABSENCE",
"XFCC_HEADER_VALIDATION_FAILURE",
"XFCC_HEADER_NOT_PRESENT_OR_EMPTY",
"XFCC_MATCHCERTCOUNT_GREATER_THAN_CERTS_IN_HEADER",
"XFCC_HEADER_INVALID",
"CCA_HEADER_VALIDATION_FAILURE",
"SOCKET_EXCEPTION"
]
},
"errorProfileName": {
"type": "string"
}
}
}
]
}
}
}
},
"ControlledShutdownErrorMapping": {
"type": "object",
"additionalProperties": false,
"required": [
"routeErrorProfileList"
],
"properties": {
"routeErrorProfileList": {
"type": "array",
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "object",
"required": [
"routeId",
"errorProfileName"
],
"additionalProperties": false,
"properties": {
"routeId": {
"type": "string"
},
"errorProfileName": {
"type": "string"
}
}
}
]
}
}
}
},
"CCAHeader": {
"type": "object",
"description": "Configuration for cca header validation",
"additionalProperties": false,
"required": [
"enabled",
"minExpiryTime",
"maxTokenAge",
"role",
"subKey",
"validationRule",
"k8SecretName",
"k8NameSpace",
"fileName"
],
"properties": {
"enabled": {
"type": "boolean"
},
"minExpiryTime": {
"type": "integer",
"minimum": 0
},
"maxTokenAge": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"role": {
"type": "string"
},
"subKey": {
"type": "string"
},
"validationRule": {
"type": "string",
"enum": [
"strict",
"relaxed"
]
},
"k8SecretName": {
"type": "string"
},
"k8NameSpace": {
"type": "string"
},
"fileName": {
"type": "string"
}
}
},
"CopyHeaderOnGatewayError": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"requestToResponse": {
"type": "object",
"properties": {
"requestHeaderNames": {
"type": "array",
"items":
{
"type": "string"
}
}
}
}
},
"required": [
"enabled"
]
},
"ApplicationParams": {
"type": "object",
"additionalProperties": false,
"properties": {
"operationalState": {
"type": "string",
"enum": [
"NORMAL",
"PARTIAL_SHUTDOWN",
"COMPLETE_SHUTDOWN"
]
}
}
},
"PodProtectionByRateLimiting": {
"type": "object",
"description": "Configuration for pod protection by rate limiting",
"additionalProperties": false,
"required": [
"enabled",
"fillRate",
"routes",
"errorCodeProfile"
],
"properties": {
"enabled": {
"type": "boolean"
},
"fillRate": {
"type": "integer",
"minimum": 1
},
"errorCodeProfile": {
"type": "string"
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"methods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"GET",
"PUT",
"POST",
"PATCH",
"DELETE",
"HEAD",
"OPTIONS",
"TRACE",
"CONNECT"
]
}
},
"path": {
"type": "string"
},
"percentage": {
"type": "number",
"minimum": 0.1,
"maximum": 100
},
"routeId": {
"type": "string"
},
"defaultPriority": {
"type": "integer",
"minimum": 0,
"maximum": 31
}
}
}
},
"deniedRequestActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"priority": {
"type": "string"
},
"congestionLevel": {
"type": "integer"
},
"action": {
"type": "string",
"enum": [
"REJECT",
"CONTINUE"
]
},
"errorCodeProfile": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"priorityHeaderName": {
"type": "string"
},
"defaultPriority": {
"type": "integer",
"minimum": 0,
"maximum": 31
}
}
},
"CongestionConfig": {
"type": "object",
"description": "Configuration for congestion level calculation",
"additionalProperties": false,
"required": [
"refreshInterval",
"levels"
],
"properties": {
"refreshInterval": {
"type": "integer",
"minimum": 200,
"maximum": 5000
},
"levels": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"name": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"CPU"
]
},
"onset": {
"type": "integer",
"minimum": 0
},
"abatement": {
"type": "integer",
"minimum": 0
}
},
"required": [
"name",
"onset"
]
}
}
},
"required": [
"value",
"name",
"resources"
]
}
}
}
},
"IGWConfig": {
"type": "object",
"properties": {
"healthCheckConfigOptions": {
"$ref": "#/components/schemas/HealthCheckConfig"
},
"logging": {
"$ref": "#/components/schemas/GWLoggingConfig"
},
"oauthvalidatorconfiguration": {
"$ref": "#/components/schemas/OAuthValidatorConfiguration"
},
"errorcodeprofiles": {
"$ref": "#/components/schemas/ErrorCodeProfiles"
},
"ocdiscardpolicies": {
"$ref": "#/components/schemas/OCDiscardPolicies"
},
"ocpolicymapping": {
"$ref": "#/components/schemas/OCPolicyMapping"
},
"routelevelratelimiting": {
"$ref": "#/components/schemas/RouteLevelRateLimiting"
},
"serverheaderdetails": {
"$ref": "#/components/schemas/ServerHeaderDetails"
},
"routesconfiguration": {
"$ref": "#/components/schemas/IGWRoutesConfiguration"
},
"messagelogging": {
"$ref": "#/components/schemas/MessageLogging"
},
"errorcodeserieslist": {
"$ref": "#/components/schemas/ErrorCodeSeriesList"
},
"trafficrejectmode": {
"$ref": "#/components/schemas/TrafficRejectMode"
},
"podprotection": {
"$ref": "#/components/schemas/PodProtection"
},
"xfccheadervalidation": {
"$ref": "#/components/schemas/XfccHeaderValidation"
},
"readinessconfig": {
"$ref": "#/components/schemas/ReadinessConfig"
},
"useragentheadervalidation": {
"$ref": "#/components/schemas/UserAgentHeaderValidation"
},
"configurableerrorcodes": {
"$ref": "#/components/schemas/ConfigurableErrorCodes"
},
"controlledshutdownerrormapping": {
"$ref": "#/components/schemas/ControlledShutdownErrorMapping"
},
"ccaheader": {
"$ref": "#/components/schemas/CCAHeader"
},
"copyHeaderOnGatewayError": {
"$ref": "#/components/schemas/CopyHeaderOnGatewayError"
},
"applicationparams": {
"$ref": "#/components/schemas/ApplicationParams"
},
"podProtectionByRateLimiting": {
"$ref": "#/components/schemas/PodProtectionByRateLimiting"
},
"congestionConfig": {
"$ref": "#/components/schemas/CongestionConfig"
}
}
}
}
}
}