From 60f10651e91a33e2980d190160e6371cb3ba3515 Mon Sep 17 00:00:00 2001 From: "raviteja.karumuri" Date: Wed, 17 Jan 2024 16:13:17 +0000 Subject: Updating API doc files for Montreal Branch * Enabling overwrite in copy resources maven configuration * Updated pms-api yaml and json files in docs/offered apis directory Issue-ID: CCSDK-3983 Signed-off-by: Raviteja Karumuri Change-Id: I9859eacae325eb3481afb3ba3bd95c96e8f7c36e --- a1-policy-management/pom.xml | 6 +- .../openapitoolgen/offeredapis/pms-api/index.html | 3506 ++++++++------------ docs/offeredapis/swagger/pms-api.json | 2713 +++++++++------ docs/offeredapis/swagger/pms-api.yaml | 878 ++--- 4 files changed, 3625 insertions(+), 3478 deletions(-) diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml index 8308f0a0..bd85f164 100644 --- a/a1-policy-management/pom.xml +++ b/a1-policy-management/pom.xml @@ -4,6 +4,7 @@ ~ ONAP : ccsdk oran ~ ================================================================================ ~ Copyright (C) 2020-2023 Nordix Foundation. All rights reserved. + ~ Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. ~ ================================================================================ ~ Licensed under the Apache License, Version 2.0 (the "License"); ~ you may not use this file except in compliance with the License. @@ -360,7 +361,8 @@ ONAP CCSDK A1 Policy Management Service https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP Copyright (C) 2020-2023 Nordix Foundation. Licensed - under the Apache License. + under the Apache License, and + Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. http://www.apache.org/licenses/LICENSE-2.0 @@ -408,7 +410,7 @@ ${project.basedir}/../docs/offeredapis/swagger - true + true ${project.basedir}/api diff --git a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html index c4aa60e7..e0cbb20b 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html @@ -855,7 +855,10 @@ ul.nav-tabs { "description" : "If true, the access is granted" } }, - "description" : "Result of authorization" + "description" : "Result of authorization", + "example" : { + "result" : true + } }; defs["error_information"] = { "type" : "object", @@ -915,7 +918,7 @@ ul.nav-tabs { }, "description" : "Authorization request for A1 policy requests" }; - defs["policy_id_list_v2"] = { + defs["policy_id_list"] = { "type" : "object", "properties" : { "policy_ids" : { @@ -927,23 +930,13 @@ ul.nav-tabs { } } }, - "description" : "A list of policy identities" -}; - defs["policy_info_list_v2"] = { - "type" : "object", - "properties" : { - "policies" : { - "type" : "array", - "description" : "List of policy information", - "items" : { - "$ref" : "#/components/schemas/policy_info_v2" - } - } - }, - "description" : "List of policy information" + "description" : "A list of policy identities", + "example" : { + "policy_ids" : [ "policy_ids", "policy_ids" ] + } }; - defs["policy_info_v2"] = { - "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ], + defs["policy_info"] = { + "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id", "service_id" ], "type" : "object", "properties" : { "ric_id" : { @@ -957,6 +950,7 @@ ul.nav-tabs { "transient" : { "type" : "boolean", "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", + "nullable" : false, "example" : false, "default" : false }, @@ -979,7 +973,20 @@ ul.nav-tabs { }, "description" : "Information for one A1-P Policy" }; - defs["policy_status_info_v2"] = { + defs["policy_info_list"] = { + "type" : "object", + "properties" : { + "policies" : { + "type" : "array", + "description" : "List of policy information", + "items" : { + "$ref" : "#/components/schemas/policy_info" + } + } + }, + "description" : "List of policy information" +}; + defs["policy_status_info"] = { "type" : "object", "properties" : { "last_modified" : { @@ -993,21 +1000,7 @@ ul.nav-tabs { }, "description" : "Status for one A1-P Policy" }; - defs["policytype_id_list_v2"] = { - "type" : "object", - "properties" : { - "policytype_ids" : { - "type" : "array", - "description" : "Policy type identities", - "items" : { - "type" : "string", - "description" : "Policy type identities" - } - } - }, - "description" : "Information about policy types" -}; - defs["policytype_v2"] = { + defs["policy_type_definition"] = { "type" : "object", "properties" : { "policy_schema" : { @@ -1015,22 +1008,23 @@ ul.nav-tabs { "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema" } }, - "description" : "Policy type" + "description" : "Contains policy type schema definition" }; - defs["ric_info_list_v2"] = { + defs["policy_type_id_list"] = { "type" : "object", "properties" : { - "rics" : { + "policytype_ids" : { "type" : "array", - "description" : "List of Near-RT RIC information", + "description" : "Policy type identities", "items" : { - "$ref" : "#/components/schemas/ric_info_v2" + "type" : "string", + "description" : "Policy type identities" } } }, - "description" : "List of Near-RT RIC information" + "description" : "Information about policy types" }; - defs["ric_info_v2"] = { + defs["ric_info"] = { "type" : "object", "properties" : { "ric_id" : { @@ -1060,6 +1054,19 @@ ul.nav-tabs { } }, "description" : "Information for a Near-RT RIC" +}; + defs["ric_info_list"] = { + "type" : "object", + "properties" : { + "rics" : { + "type" : "array", + "description" : "List of Near-RT RIC information", + "items" : { + "$ref" : "#/components/schemas/ric_info" + } + } + }, + "description" : "List of Near-RT RIC information" }; defs["service_callback_info_v2"] = { "required" : [ "event_type", "ric_id" ], @@ -1077,20 +1084,7 @@ ul.nav-tabs { }, "description" : "Information transferred as in Service callbacks (callback_url)" }; - defs["service_list_v2"] = { - "type" : "object", - "properties" : { - "service_list" : { - "type" : "array", - "description" : "List of service information", - "items" : { - "$ref" : "#/components/schemas/service_status_v2" - } - } - }, - "description" : "List of service information" -}; - defs["service_registration_info_v2"] = { + defs["service_registration_info"] = { "required" : [ "service_id" ], "type" : "object", "properties" : { @@ -1110,7 +1104,7 @@ ul.nav-tabs { }, "description" : "Information for one service" }; - defs["service_status_v2"] = { + defs["service_status"] = { "type" : "object", "properties" : { "callback_url" : { @@ -1131,10 +1125,21 @@ ul.nav-tabs { "description" : "time since last invocation by the service", "format" : "int64" } - }, - "description" : "List of service information" + } +}; + defs["service_status_list"] = { + "type" : "object", + "properties" : { + "service_list" : { + "type" : "array", + "description" : "List of service information", + "items" : { + "$ref" : "#/components/schemas/service_status" + } + } + } }; - defs["status_info_v2"] = { + defs["status_info"] = { "type" : "object", "properties" : { "status" : { @@ -1177,8 +1182,8 @@ ul.nav-tabs {
  • getPolicyStatus
    • -
  • - getPolicyType +
  • + getPolicyTypeDefinition
  • getPolicyTypes @@ -1230,6 +1235,13 @@ ul.nav-tabs {
  • performAccessControl
    • +
  • API Methods - Configuration
    • +
  • + getConfiguration +
    • +
  • + putConfiguration +
  • API Methods - HealthCheck
  • getStatus @@ -1237,13 +1249,6 @@ ul.nav-tabs {
  • getStatusV1
    • -
  • API Methods - ManagementOfConfiguration
    • -
  • - getConfiguration -
    • -
  • - putConfiguration -
  • API Methods - NearRTRICRepository
  • getRic @@ -1251,10 +1256,6 @@ ul.nav-tabs {
  • getRics
    • -
  • API Methods - ServiceCallbacks
    • -
  • - serviceCallback -
  • API Methods - ServiceRegistryAndSupervision
  • deleteService @@ -1591,22 +1592,18 @@ pub fn main() {
    -