diff options
author | PatrikBuhr <patrik.buhr@est.tech> | 2021-01-20 12:21:52 +0100 |
---|---|---|
committer | PatrikBuhr <patrik.buhr@est.tech> | 2021-01-21 10:44:37 +0100 |
commit | 1122b01a05d4de22564716b815935bf880703276 (patch) | |
tree | 4d72bd20a2b1058b02b8b61b6c9aae04db8f759b /a1-policy-management | |
parent | be0ae3e197f5d5032c0766a59050b03e2a4deb99 (diff) |
PMS API Documentation updates
Change-Id: I2a02145c48fd4b022b2e17b157760bd7ddb8128f
Issue-ID: CCSDK-3077
Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Diffstat (limited to 'a1-policy-management')
6 files changed, 151 insertions, 152 deletions
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.<br>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:<ul><li>Get callbacks.<\/li><li>Activate supervision of the service. If a service is inactive, its policies will be deleted.<\/li><\/ul>", - "operationId": "putServiceUsingPUT_1", + "operationId": "putServiceUsingPUT", "responses": { "200": { "schema": {"type": "object"}, @@ -786,7 +786,7 @@ "description": "registrationInfo", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"], + "tags": ["A1 Policy Management Version 2.0"], "consumes": ["application/json"] } }, @@ -794,7 +794,7 @@ "summary": "Returns the name of a RIC managing one Mananged Element", "deprecated": false, "produces": ["*/*"], - "operationId": "getRicUsingGET_1", + "operationId": "getRicUsingGET", "responses": { "200": { "schema": {"type": "string"}, @@ -815,13 +815,13 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/services/keepalive": {"put": { "summary": "Heartbeat from a service", "deprecated": false, "produces": ["*/*"], - "operationId": "keepAliveServiceUsingPUT", + "operationId": "keepAliveServiceUsingPUT_1", "responses": { "200": { "schema": {"type": "string"}, @@ -840,7 +840,7 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0"], + "tags": ["A1 Policy Management Version 1.0 (deprecated)"], "consumes": ["application/json"] }}, "/a1-policy/v2/policy-types/{policytype_id}": {"get": { @@ -867,7 +867,7 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/status": {"get": { "summary": "Returns status and statistics of this service", @@ -883,7 +883,7 @@ "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} }, - "tags": ["A1 Policy Management Version 1.0"] + "tags": ["A1 Policy Management Version 1.0 (deprecated)"] }}, "/a1-policy/v2/policies": { "get": { @@ -891,7 +891,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", - "operationId": "getPolicyIdsUsingGET_1", + "operationId": "getPolicyIdsUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_id_list_v2"}, @@ -930,13 +930,13 @@ "required": false } ], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }, "put": { "summary": "Create or update a policy", "deprecated": false, "produces": ["application/json"], - "operationId": "putPolicyUsingPUT_1", + "operationId": "putPolicyUsingPUT", "responses": { "200": {"description": "Policy updated"}, "201": {"description": "Policy created"}, @@ -958,7 +958,7 @@ "description": "policyInfo", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"], + "tags": ["A1 Policy Management Version 2.0"], "consumes": ["application/json"] } }, @@ -989,7 +989,7 @@ "summary": "Unregister a service", "deprecated": false, "produces": ["*/*"], - "operationId": "deleteServiceUsingDELETE_1", + "operationId": "deleteServiceUsingDELETE", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -1010,13 +1010,13 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }}, "/service": {"put": { "summary": "Register a service", "deprecated": false, "produces": ["*/*"], - "operationId": "putServiceUsingPUT", + "operationId": "putServiceUsingPUT_1", "responses": { "200": { "schema": {"type": "string"}, @@ -1041,14 +1041,14 @@ "description": "registrationInfo", "required": true }], - "tags": ["A1 Policy Management Version 1.0"], + "tags": ["A1 Policy Management Version 1.0 (deprecated)"], "consumes": ["application/json"] }}, "/a1-policy/v2/policies/{policy_id}/status": {"get": { "summary": "Returns a policy status", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyStatusUsingGET_1", + "operationId": "getPolicyStatusUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_status_info_v2"}, @@ -1068,7 +1068,7 @@ "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0 (in progress)"] + "tags": ["A1 Policy Management Version 2.0"] }} }, "definitions": { @@ -1090,11 +1090,6 @@ } } }, - "void": { - "description": "Void/empty", - "type": "object", - "title": "void" - }, "status_info_v2": { "type": "object", "title": "status_info_v2", @@ -1133,10 +1128,6 @@ } } }, - "Mono«ResponseEntity«object»»": { - "type": "object", - "title": "Mono«ResponseEntity«object»»" - }, "ric_info_v2": { "description": "Information for a Near-RT RIC", "type": "object", @@ -1412,10 +1403,6 @@ "enum": ["AVAILABLE"] } } - }, - "Mono«ResponseEntity«string»»": { - "type": "object", - "title": "Mono«ResponseEntity«string»»" } }, "swagger": "2.0", @@ -1432,11 +1419,11 @@ }, "tags": [ { - "name": "A1 Policy Management Version 1.0", + "name": "A1 Policy Management Version 1.0 (deprecated)", "description": "Policy Controller" }, { - "name": "A1 Policy Management Version 2.0 (in progress)", + "name": "A1 Policy Management Version 2.0", "description": "Policy Controller" }, { diff --git a/a1-policy-management/api/pms-api.yaml b/a1-policy-management/api/pms-api.yaml index 11aad23d..eff705d0 100644 --- a/a1-policy-management/api/pms-api.yaml +++ b/a1-policy-management/api/pms-api.yaml @@ -16,9 +16,9 @@ info: servers: - url: / tags: -- name: A1 Policy Management Version 1.0 +- name: A1 Policy Management Version 1.0 (deprecated) description: Policy Controller -- name: A1 Policy Management Version 2.0 (in progress) +- name: A1 Policy Management Version 2.0 description: Policy Controller - name: Component Configuration description: Configuration Controller @@ -28,9 +28,9 @@ paths: /policy_types: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Query policy type names - operationId: getPolicyTypesUsingGET + operationId: getPolicyTypesUsingGET_1 parameters: - name: ric in: query @@ -63,7 +63,7 @@ paths: /a1-policy/v2/policy-instances: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Query for A1 policy instances description: Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions @@ -111,7 +111,7 @@ paths: /a1-policy/v2/status: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Returns status and statistics of this service operationId: getStatusUsingGET responses: @@ -134,9 +134,9 @@ paths: /services: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns service information - operationId: getServicesUsingGET + operationId: getServicesUsingGET_1 parameters: - name: name in: query @@ -168,9 +168,9 @@ paths: deprecated: false delete: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Delete a service - operationId: deleteServiceUsingDELETE + operationId: deleteServiceUsingDELETE_1 parameters: - name: name in: query @@ -208,12 +208,12 @@ paths: /a1-policy/v2/rics/ric: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Returns info for one Near-RT RIC description: Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>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 parameters: - name: managed_element_id in: query @@ -251,9 +251,9 @@ paths: /a1-policy/v2/policies/{policy_id}: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Returns a policy - operationId: getPolicyUsingGET_1 + operationId: getPolicyUsingGET parameters: - name: policy_id in: path @@ -283,9 +283,9 @@ paths: deprecated: false delete: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Delete a policy - operationId: deletePolicyUsingDELETE_1 + operationId: deletePolicyUsingDELETE parameters: - name: policy_id in: path @@ -322,9 +322,9 @@ paths: /a1-policy/v2/policy-types: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Query policy type identities - operationId: getPolicyTypesUsingGET_1 + operationId: getPolicyTypesUsingGET parameters: - name: ric_id in: query @@ -425,9 +425,9 @@ paths: /policy: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns a policy configuration - operationId: getPolicyUsingGET + operationId: getPolicyUsingGET_1 parameters: - name: id in: query @@ -458,9 +458,9 @@ paths: deprecated: false put: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Put a policy - operationId: putPolicyUsingPUT + operationId: putPolicyUsingPUT_1 parameters: - name: id in: query @@ -534,9 +534,9 @@ paths: deprecated: false delete: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Delete a policy - operationId: deletePolicyUsingDELETE + operationId: deletePolicyUsingDELETE_1 parameters: - name: id in: query @@ -574,7 +574,7 @@ paths: /policies: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Query policies operationId: getPoliciesUsingGET parameters: @@ -621,9 +621,9 @@ paths: /a1-policy/v2/services/{service_id}/keepalive: put: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Heartbeat indicates that the service is running - operationId: keepAliveServiceUsingPUT_1 + operationId: keepAliveServiceUsingPUT parameters: - name: service_id in: path @@ -657,7 +657,7 @@ paths: /policy_schema: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns one policy type schema definition operationId: getPolicySchemaUsingGET parameters: @@ -691,9 +691,9 @@ paths: /rics: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Query Near-RT RIC information - operationId: getRicsUsingGET_1 + operationId: getRicsUsingGET parameters: - name: policyType in: query @@ -726,9 +726,9 @@ paths: /policy_status: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns a policy status - operationId: getPolicyStatusUsingGET + operationId: getPolicyStatusUsingGET_1 parameters: - name: id in: query @@ -760,11 +760,11 @@ paths: /a1-policy/v2/rics: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Query Near-RT RIC information description: The call returns all Near-RT RICs that supports a given policy type identity - operationId: getRicsUsingGET + operationId: getRicsUsingGET_1 parameters: - name: policytype_id in: query @@ -796,9 +796,9 @@ paths: /policy_ids: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Query policies, only policy identities returned - operationId: getPolicyIdsUsingGET + operationId: getPolicyIdsUsingGET_1 parameters: - name: ric in: query @@ -843,7 +843,7 @@ paths: /policy_schemas: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns policy type schema definitions operationId: getPolicySchemasUsingGET parameters: @@ -879,11 +879,11 @@ paths: /a1-policy/v2/services: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Returns service information description: Either information about a registered service with given identity or all registered services are returned. - operationId: getServicesUsingGET_1 + operationId: getServicesUsingGET parameters: - name: service_id in: query @@ -913,12 +913,12 @@ paths: deprecated: false put: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Register a service description: Registering a service is needed to:<ul><li>Get callbacks.</li><li>Activate supervision of the service. If a service is inactive, its policies will be deleted.</li></ul> - operationId: putServiceUsingPUT_1 + operationId: putServiceUsingPUT requestBody: description: registrationInfo content: @@ -958,9 +958,9 @@ paths: /ric: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns the name of a RIC managing one Mananged Element - operationId: getRicUsingGET_1 + operationId: getRicUsingGET parameters: - name: managedElementId in: query @@ -992,9 +992,9 @@ paths: /services/keepalive: put: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Heartbeat from a service - operationId: keepAliveServiceUsingPUT + operationId: keepAliveServiceUsingPUT_1 parameters: - name: name in: query @@ -1026,7 +1026,7 @@ paths: /a1-policy/v2/policy-types/{policytype_id}: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Returns a policy type definition operationId: getPolicyTypeUsingGET parameters: @@ -1059,7 +1059,7 @@ paths: /status: get: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Returns status and statistics of this service operationId: getStatusUsingGET_1 responses: @@ -1082,12 +1082,12 @@ paths: /a1-policy/v2/policies: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Query policy identities description: Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned. - operationId: getPolicyIdsUsingGET_1 + operationId: getPolicyIdsUsingGET parameters: - name: policytype_id in: query @@ -1129,9 +1129,9 @@ paths: deprecated: false put: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Create or update a policy - operationId: putPolicyUsingPUT_1 + operationId: putPolicyUsingPUT requestBody: description: policyInfo content: @@ -1199,9 +1199,9 @@ paths: /a1-policy/v2/services/{service_id}: delete: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Unregister a service - operationId: deleteServiceUsingDELETE_1 + operationId: deleteServiceUsingDELETE parameters: - name: service_id in: path @@ -1235,9 +1235,9 @@ paths: /service: put: tags: - - A1 Policy Management Version 1.0 + - A1 Policy Management Version 1.0 (deprecated) summary: Register a service - operationId: putServiceUsingPUT + operationId: putServiceUsingPUT_1 requestBody: description: registrationInfo content: @@ -1277,9 +1277,9 @@ paths: /a1-policy/v2/policies/{policy_id}/status: get: tags: - - A1 Policy Management Version 2.0 (in progress) + - A1 Policy Management Version 2.0 summary: Returns a policy status - operationId: getPolicyStatusUsingGET_1 + operationId: getPolicyStatusUsingGET parameters: - name: policy_id in: path @@ -1325,10 +1325,6 @@ components: format: int32 example: 503 description: Problem as defined in https://tools.ietf.org/html/rfc7807 - void: - title: void - type: object - description: Void/empty status_info_v2: title: status_info_v2 type: object @@ -1359,9 +1355,6 @@ components: ric: type: string description: identity of the target Near-RT RIC - Mono«ResponseEntity«object»»: - title: Mono«ResponseEntity«object»» - type: object ric_info_v2: title: ric_info_v2 type: object @@ -1615,6 +1608,3 @@ components: enum: - AVAILABLE description: Information transferred as in Service callbacks (callback_url) - Mono«ResponseEntity«string»»: - title: Mono«ResponseEntity«string»» - type: object diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml index f218b52d..40f28be0 100644 --- a/a1-policy-management/pom.xml +++ b/a1-policy-management/pom.xml @@ -19,27 +19,23 @@ ~ ============LICENSE_END======================================================= ~ --> - <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <parent> <groupId>org.onap.ccsdk.parent</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.0</version> <relativePath/> </parent> - <groupId>org.onap.ccsdk.oran</groupId> <artifactId>a1-policy-management-service</artifactId> <version>1.1.1-SNAPSHOT</version> - <name>ccsdk-oran :: ${project.artifactId}</name> - <properties> <java.version.source>11</java.version.source> <java.version.target>11</java.version.target> - <springfox.version>2.9.2</springfox.version><!-- Do not change to version 3.0.0! Will break the generated json. --> + <springfox.version>2.9.2</springfox.version> + <!-- Do not change to version 3.0.0! Will break the generated json. --> <immutable.version>2.8.8</immutable.version> <sdk.version>1.1.6</sdk.version> <json.version>20200518</json.version> @@ -47,13 +43,13 @@ <spotless-maven-plugin.version>2.5.0</spotless-maven-plugin.version> <commons-io.version>2.5</commons-io.version> <docker-maven-plugin>0.30.0</docker-maven-plugin> - <surefire-maven-plugin.version>3.0.0-M5</surefire-maven-plugin.version><!-- Version must be higher than version 2.19.1 that is defined in the parent pom for JUnit 5 tests to be run. Do not remove! --> + <surefire-maven-plugin.version>3.0.0-M5</surefire-maven-plugin.version> + <!-- Version must be higher than version 2.19.1 that is defined in the parent pom for JUnit 5 tests to be run. Do not remove! --> <jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version> <swagger-codegen-maven-plugin.version>3.0.11</swagger-codegen-maven-plugin.version> <exec.skip>true</exec.skip> <ccsdk.project.version>${project.version}</ccsdk.project.version> </properties> - <dependencies> <dependency> <groupId>org.springframework.boot</groupId> @@ -223,7 +219,6 @@ <scope>test</scope> </dependency> </dependencies> - <build> <plugins> <plugin> @@ -344,6 +339,29 @@ </executions> </plugin> <plugin> + <artifactId>maven-resources-plugin</artifactId> + <executions> + <execution> + <id>copy-resource-one</id> + <phase>install</phase> + <goals> + <goal>copy-resources</goal> + </goals> + <configuration> + <outputDirectory>${project.basedir}/../docs/offeredapis/swagger</outputDirectory> + <resources> + <resource> + <directory>${project.basedir}/api</directory> + <includes> + <include>pms-api.*</include> + </includes> + </resource> + </resources> + </configuration> + </execution> + </executions> + </plugin> + <plugin> <groupId>io.fabric8</groupId> <artifactId>docker-maven-plugin</artifactId> <version>${docker-maven-plugin}</version> @@ -404,4 +422,4 @@ </plugin> </plugins> </build> -</project> +</project>
\ No newline at end of file diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v1/Consts.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v1/Consts.java index c54394e0..69868d2d 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v1/Consts.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v1/Consts.java @@ -22,7 +22,7 @@ package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1; public class Consts { - public static final String V1_API_NAME = "A1 Policy Management Version 1.0"; + public static final String V1_API_NAME = "A1 Policy Management Version 1.0 (deprecated)"; private Consts() {} } diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/Consts.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/Consts.java index d791ff26..d365ad9a 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/Consts.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/Consts.java @@ -29,7 +29,7 @@ public class Consts { public static final String MANAGED_ELEMENT_ID_PARAM = "managed_element_id"; public static final String V2_API_ROOT = "a1-policy/v2"; - public static final String V2_API_NAME = "A1 Policy Management Version 2.0 (in progress)"; + public static final String V2_API_NAME = "A1 Policy Management Version 2.0"; public static final String V2_CONFIG_API_NAME = "Component Configuration"; private Consts() {} diff --git a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ApplicationTest.java b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ApplicationTest.java index 5edee150..14843eb2 100644 --- a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ApplicationTest.java +++ b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ApplicationTest.java @@ -98,7 +98,7 @@ import reactor.util.annotation.Nullable; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @TestPropertySource(properties = { // "server.ssl.key-store=./config/keystore.jks", // - "app.webclient.trust-store=./config/truststore.jks"}) + "app.webclient.trust-store=./config/truststore.jks" }) class ApplicationTest { private static final Logger logger = LoggerFactory.getLogger(ApplicationTest.class); @@ -219,6 +219,10 @@ class ApplicationTest { assertThat(resp.getStatusCode()).isEqualTo(HttpStatus.OK); JSONObject jsonObj = new JSONObject(resp.getBody()); jsonObj.remove("host"); + assertThat(jsonObj.getJSONObject("definitions").remove("Mono«ResponseEntity«object»»")).isNotNull(); + assertThat(jsonObj.getJSONObject("definitions").remove("void")).isNotNull(); + assertThat(jsonObj.getJSONObject("definitions").remove("Mono«ResponseEntity«string»»")).isNotNull(); + String indented = (jsonObj).toString(4); String docDir = "api/"; Files.createDirectories(Paths.get(docDir)); @@ -769,8 +773,8 @@ class ApplicationTest { for (int i = 0; i < 10; ++i) { AsyncRestClient restClient = restClient(); - ConcurrencyTestRunnable test = - new ConcurrencyTestRunnable(restClient, supervision, a1ClientFactory, rics, policyTypes); + ConcurrencyTestRunnable test = new ConcurrencyTestRunnable(restClient, supervision, a1ClientFactory, rics, + policyTypes); Thread thread = new Thread(test, "TestThread_" + i); thread.start(); threads.add(thread); |