From 1122b01a05d4de22564716b815935bf880703276 Mon Sep 17 00:00:00 2001 From: PatrikBuhr Date: Wed, 20 Jan 2021 12:21:52 +0100 Subject: PMS API Documentation updates Change-Id: I2a02145c48fd4b022b2e17b157760bd7ddb8128f Issue-ID: CCSDK-3077 Signed-off-by: PatrikBuhr --- a1-policy-management/api/pms-api.json | 127 +- a1-policy-management/api/pms-api.yaml | 124 +- a1-policy-management/pom.xml | 38 +- .../controllers/v1/Consts.java | 2 +- .../controllers/v2/Consts.java | 2 +- .../controllers/v2/ApplicationTest.java | 10 +- docs/offeredapis/swagger/pms-api.json | 1439 ++++++++++++++++- docs/offeredapis/swagger/pms-api.yaml | 1611 +++++++++++++++++++- 8 files changed, 3199 insertions(+), 154 deletions(-) mode change 120000 => 100644 docs/offeredapis/swagger/pms-api.json mode change 120000 => 100644 docs/offeredapis/swagger/pms-api.yaml diff --git a/a1-policy-management/api/pms-api.json b/a1-policy-management/api/pms-api.json index d1823894..fe4554bf 100644 --- a/a1-policy-management/api/pms-api.json +++ b/a1-policy-management/api/pms-api.json @@ -5,7 +5,7 @@ "summary": "Query policy type names", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyTypesUsingGET", + "operationId": "getPolicyTypesUsingGET_1", "responses": { "200": { "schema": { @@ -29,7 +29,7 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/a1-policy/v2/policy-instances": {"get": { "summary": "Query for A1 policy instances", @@ -75,7 +75,7 @@ "required": false } ], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/a1-policy/v2/status": {"get": { "summary": "Returns status and statistics of this service", @@ -91,14 +91,14 @@ "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} }, - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/services": { "get": { "summary": "Returns service information", "deprecated": false, "produces": ["*/*"], - "operationId": "getServicesUsingGET", + "operationId": "getServicesUsingGET_1", "responses": { "200": { "schema": { @@ -122,13 +122,13 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }, "delete": { "summary": "Delete a service", "deprecated": false, "produces": ["*/*"], - "operationId": "deleteServiceUsingDELETE", + "operationId": "deleteServiceUsingDELETE_1", "responses": { "200": { "schema": {"type": "string"}, @@ -153,7 +153,7 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] } }, "/a1-policy/v2/rics/ric": {"get": { @@ -161,7 +161,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Either a Near-RT RIC identity or a Mananged Element identity can be specified.
The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", - "operationId": "getRicUsingGET", + "operationId": "getRicUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/ric_info_v2"}, @@ -192,14 +192,14 @@ "required": false } ], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/a1-policy/v2/policies/{policy_id}": { "get": { "summary": "Returns a policy", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyUsingGET_1", + "operationId": "getPolicyUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_info_v2"}, @@ -219,13 +219,13 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }, "delete": { "summary": "Delete a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE_1", + "operationId": "deletePolicyUsingDELETE", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -247,14 +247,14 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] } }, "/a1-policy/v2/policy-types": {"get": { "summary": "Query policy type identities", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyTypesUsingGET_1", + "operationId": "getPolicyTypesUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policytype_id_list_v2"}, @@ -275,7 +275,7 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/a1-policy/v2/configuration": { "get": { @@ -335,7 +335,7 @@ "summary": "Returns a policy configuration", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyUsingGET", + "operationId": "getPolicyUsingGET_1", "responses": { "200": { "schema": {"type": "object"}, @@ -356,13 +356,13 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }, "delete": { "summary": "Delete a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE", + "operationId": "deletePolicyUsingDELETE_1", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -385,13 +385,13 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }, "put": { "summary": "Put a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "putPolicyUsingPUT", + "operationId": "putPolicyUsingPUT_1", "responses": { "200": {"description": "Policy updated"}, "201": {"description": "Policy created"}, @@ -457,7 +457,7 @@ "required": false } ], - "tags": ["A1 Policy Management Version 1.0"], + "tags": ["A1 Policy Management Version 1.0 (deprecated)"], "consumes": ["application/json"] } }, @@ -507,13 +507,13 @@ "required": false } ], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/a1-policy/v2/services/{service_id}/keepalive": {"put": { "summary": "Heartbeat indicates that the service is running", "deprecated": false, "produces": ["*/*"], - "operationId": "keepAliveServiceUsingPUT_1", + "operationId": "keepAliveServiceUsingPUT", "responses": { "200": { "schema": {"type": "object"}, @@ -534,7 +534,7 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"], + "tags": ["A1 Policy Management Version 2.0"], "consumes": ["application/json"] }}, "/policy_schema": {"get": { @@ -562,13 +562,13 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/rics": {"get": { "summary": "Query Near-RT RIC information", "deprecated": false, "produces": ["*/*"], - "operationId": "getRicsUsingGET_1", + "operationId": "getRicsUsingGET", "responses": { "200": { "schema": { @@ -592,13 +592,13 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/policy_status": {"get": { "summary": "Returns a policy status", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyStatusUsingGET", + "operationId": "getPolicyStatusUsingGET_1", "responses": { "200": { "schema": {"type": "object"}, @@ -619,14 +619,14 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/a1-policy/v2/rics": {"get": { "summary": "Query Near-RT RIC information", "deprecated": false, "produces": ["application/json"], "description": "The call returns all Near-RT RICs that supports a given policy type identity", - "operationId": "getRicsUsingGET", + "operationId": "getRicsUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/ric_info_list_v2"}, @@ -647,13 +647,13 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/policy_ids": {"get": { "summary": "Query policies, only policy identities returned", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyIdsUsingGET", + "operationId": "getPolicyIdsUsingGET_1", "responses": { "200": { "schema": { @@ -695,7 +695,7 @@ "required": false } ], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/policy_schemas": {"get": { "summary": "Returns policy type schema definitions", @@ -725,7 +725,7 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/a1-policy/v2/services": { "get": { @@ -733,7 +733,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Either information about a registered service with given identity or all registered services are returned.", - "operationId": "getServicesUsingGET_1", + "operationId": "getServicesUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/service_list_v2"}, @@ -754,14 +754,14 @@ "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }, "put": { "summary": "Register a service", "deprecated": false, "produces": ["*/*"], "description": "Registering a service is needed to: