The V1 of the policy management API is removed from the code.
Issue-ID: CCSDK-3559
Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Change-Id: I0b5cde71770fca3826ad18025094d1c8423f4cf3
"type": "string"
}}
},
- "policy_info_v1": {
- "type": "object",
- "properties": {
- "service": {
- "description": "the name of the service owning the policy",
- "type": "string"
- },
- "json": {
- "description": "the configuration of the policy",
- "type": "object"
- },
- "id": {
- "description": "identity of the policy",
- "type": "string"
- },
- "lastModified": {
- "description": "timestamp, last modification time",
- "type": "string"
- },
- "type": {
- "description": "name of the policy type",
- "type": "string"
- },
- "ric": {
- "description": "identity of the target Near-RT RIC",
- "type": "string"
- }
- }
- },
- "service_registration_info_v1": {
- "type": "object",
- "properties": {
- "keepAliveIntervalSeconds": {
- "format": "int64",
- "description": "keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intevals must invoke a 'keepAlive' REST call. When a service does not invoke this call within the given time, it is considered unavailble. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.",
- "type": "integer"
- },
- "callbackUrl": {
- "description": "callback for notifying of RIC synchronization",
- "type": "string"
- },
- "serviceName": {"type": "string"}
- }
- },
"ric_info_v2": {
"description": "Information for a Near-RT RIC",
"type": "object",
"items": {"$ref": "#/components/schemas/policy_info_v2"}
}}
},
- "ric_info_v1": {
- "type": "object",
- "properties": {
- "managedElementIds": {
- "description": "O1 identities for managed entities",
- "type": "array",
- "items": {
- "description": "O1 identities for managed entities",
- "type": "string"
- }
- },
- "policyTypes": {
- "description": "supported policy types",
- "type": "array",
- "items": {
- "description": "supported policy types",
- "type": "string"
- }
- },
- "state": {
- "description": "state info",
- "type": "string"
- },
- "ricName": {
- "description": "identity of the Near-RT RIC",
- "type": "string"
- }
- }
- },
- "service_status_v1": {
- "type": "object",
- "properties": {
- "keepAliveIntervalSeconds": {
- "format": "int64",
- "description": "policy keep alive timeout",
- "type": "integer"
- },
- "timeSinceLastActivitySeconds": {
- "format": "int64",
- "description": "time since last invocation by the service",
- "type": "integer"
- },
- "callbackUrl": {
- "description": "callback for notifying of RIC synchronization",
- "type": "string"
- },
- "serviceName": {
- "description": "identity of the service",
- "type": "string"
- }
- }
- },
"policy_status_info_v2": {
"description": "Status for one A1-P Policy",
"type": "object",
}},
"openapi": "3.0.1",
"paths": {
- "/policy_types": {"get": {
- "summary": "Query policy type identities",
- "operationId": "getPolicyTypes",
- "responses": {
- "200": {
- "description": "Policy type identities",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"type": "string"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get types for.",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/policy-instances": {"get": {
"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 are returned.",
}},
"/a1-policy/v2/status": {"get": {
"summary": "Returns status and statistics of this service",
- "operationId": "getStatus_1",
+ "operationId": "getStatus",
"responses": {"200": {
"description": "Service is living",
"content": {"application/json": {"schema": {"$ref": "#/components/schemas/status_info_v2"}}}
}},
"tags": ["Actuator"]
}},
- "/services": {
- "get": {
- "summary": "Returns service information",
- "operationId": "getServices",
- "responses": {
- "200": {
- "description": "OK",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"$ref": "#/components/schemas/service_status_v1"}
- }}}
- },
- "404": {
- "description": "Service is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "name",
- "description": "The name of the service",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- },
- "delete": {
- "summary": "Unregister a service",
- "operationId": "deleteService",
- "responses": {
- "204": {
- "description": "Service unregistered",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "404": {
- "description": "Service not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "name",
- "description": "The name of the service",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }
- },
"/a1-policy/v2/rics/ric": {"get": {
"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": "getRic_1",
+ "operationId": "getRic",
"responses": {
"200": {
"description": "Near-RT RIC is found",
}},
"/a1-policy/v2/policy-types": {"get": {
"summary": "Query policy type identities",
- "operationId": "getPolicyTypes_1",
+ "operationId": "getPolicyTypes",
"responses": {
"200": {
"description": "Policy type IDs",
"/a1-policy/v2/policies/{policy_id}": {
"get": {
"summary": "Returns a policy",
- "operationId": "getPolicy_1",
+ "operationId": "getPolicy",
"responses": {
"200": {
"description": "Policy found",
},
"delete": {
"summary": "Delete a policy",
- "operationId": "deletePolicy_1",
+ "operationId": "deletePolicy",
"responses": {
"200": {
"description": "Not used",
"tags": ["Management of configuration"]
}
},
- "/policy": {
- "get": {
- "summary": "Returns a policy configuration",
- "operationId": "getPolicy",
- "responses": {
- "200": {
- "description": "Policy found",
- "content": {"*/*": {"schema": {"type": "object"}}}
- },
- "404": {
- "description": "Policy is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy instance.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- },
- "delete": {
- "summary": "Delete a policy",
- "operationId": "deletePolicy",
- "responses": {
- "200": {
- "description": "Not used",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "423": {
- "description": "Near-RT RIC is not operational",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "204": {
- "description": "Policy deleted",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "404": {
- "description": "Policy is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy instance.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- },
- "put": {
- "summary": "Put a policy",
- "requestBody": {
- "content": {"application/json": {"schema": {"type": "object"}}},
- "required": true
- },
- "operationId": "putPolicy",
- "responses": {
- "200": {
- "description": "Policy updated",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "201": {
- "description": "Policy created",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "423": {
- "description": "Near-RT RIC is not operational",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "404": {
- "description": "Near-RT RIC or policy type is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [
- {
- "schema": {
- "default": "",
- "type": "string"
- },
- "in": "query",
- "name": "type",
- "description": "The name of the policy type.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy instance.",
- "required": true
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC where the policy will be created.",
- "required": true
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "service",
- "description": "The name of the service creating the policy.",
- "required": true
- },
- {
- "schema": {
- "default": false,
- "type": "boolean"
- },
- "in": "query",
- "name": "transient",
- "description": "If the policy is transient or not (boolean defaulted to false). A policy is transient if it will be forgotten when the service needs to reconnect to the Near-RT RIC.",
- "required": false
- }
- ],
- "tags": ["A1 Policy Management V1.0"]
- }
- },
"/actuator": {"get": {
"summary": "Actuator root web endpoint",
"operationId": "links_1",
}},
"tags": ["Actuator"]
}},
- "/policies": {"get": {
- "summary": "Query policies",
- "operationId": "getPolicies",
- "responses": {
- "200": {
- "description": "Policies",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"$ref": "#/components/schemas/policy_info_v1"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC or type not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "type",
- "description": "The name of the policy type to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "service",
- "description": "The name of the service to get policies for.",
- "required": false
- }
- ],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/actuator/loggers/{name}": {
"post": {
"summary": "Actuator web endpoint 'loggers-name'",
"/a1-policy/v2/services/{service_id}/keepalive": {"put": {
"summary": "Heartbeat indicates that the service is running",
"description": "A registerred service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that teh service will be deregisterred and all its policies are removed.",
- "operationId": "keepAliveService_1",
+ "operationId": "keepAliveService",
"responses": {
"200": {
"description": "Service supervision timer refreshed, OK",
}],
"tags": ["Service Registry and Supervision"]
}},
- "/rics": {"get": {
- "summary": "Query Near-RT RIC information",
- "operationId": "getRics",
- "responses": {
- "200": {
- "description": "OK",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"$ref": "#/components/schemas/ric_info_v1"}
- }}}
- },
- "404": {
- "description": "Policy type is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "policyType",
- "description": "The name of the policy type",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
- "/policy_schema": {"get": {
- "summary": "Returns one policy type schema definition",
- "operationId": "getPolicySchema",
- "responses": {
- "200": {
- "description": "Policy schema",
- "content": {"*/*": {"schema": {"type": "object"}}}
- },
- "404": {
- "description": "The policy type is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy type to get the definition for.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/actuator/metrics": {"get": {
"summary": "Actuator web endpoint 'metrics'",
"operationId": "metrics_2",
}},
"tags": ["Actuator"]
}},
- "/policy_status": {"get": {
- "summary": "Returns a policy status",
- "operationId": "getPolicyStatus",
- "responses": {
- "200": {
- "description": "Policy status",
- "content": {"*/*": {"schema": {"type": "object"}}}
- },
- "404": {
- "description": "Policy is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/rics": {"get": {
"summary": "Query Near-RT RIC information",
"description": "The call returns all Near-RT RICs that supports a given policy type identity",
- "operationId": "getRics_1",
+ "operationId": "getRics",
"responses": {
"200": {
"description": "OK",
}],
"tags": ["NearRT-RIC Repository"]
}},
- "/policy_schemas": {"get": {
- "summary": "Returns policy type schema definitions",
- "operationId": "getPolicySchemas",
- "responses": {
- "200": {
- "description": "Policy schemas",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"type": "object"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get the definitions for.",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
- "/policy_ids": {"get": {
- "summary": "Query policies, only policy identities returned",
- "operationId": "getPolicyIds",
- "responses": {
- "200": {
- "description": "Policy identitiess",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"type": "string"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC or type not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "type",
- "description": "The name of the policy type to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "service",
- "description": "The name of the service to get policies for.",
- "required": false
- }
- ],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/services": {
"get": {
"summary": "Returns service information",
"description": "Either information about a registered service with given identity or all registered services are returned.",
- "operationId": "getServices_1",
+ "operationId": "getServices",
"responses": {
"200": {
"description": "OK",
"required": true
},
"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": "putService_1",
+ "operationId": "putService",
"responses": {
"200": {
"description": "Service updated",
}},
"tags": ["Actuator"]
}},
- "/ric": {"get": {
- "summary": "Returns the name of a RIC managing one Mananged Element",
- "operationId": "getRic",
- "responses": {
- "200": {
- "description": "Near-RT RIC is found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "404": {
- "description": "Near-RT RIC is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "managedElementId",
- "description": "The identity of the Managed Element",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
- "/services/keepalive": {"put": {
- "summary": "Heartbeat from a service",
- "operationId": "keepAliveService",
- "responses": {
- "200": {
- "description": "Service supervision timer refreshed, OK",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "404": {
- "description": "The service is not found, needs re-registration",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "name",
- "description": "The name of the service",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/status": {"get": {
"summary": "Returns status and statistics of this service",
- "operationId": "getStatus",
+ "operationId": "getStatusV1",
"responses": {"200": {
"description": "Service is living",
"content": {"*/*": {"schema": {"type": "string"}}}
}},
- "tags": ["A1 Policy Management V1.0"]
+ "tags": ["Health Check"]
}},
"/a1-policy/v2/policy-types/{policytype_id}": {"get": {
"summary": "Returns a policy type definition",
"get": {
"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": "getPolicyIds_1",
+ "operationId": "getPolicyIds",
"responses": {
"200": {
"description": "Policy identities",
"content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}},
"required": true
},
- "operationId": "putPolicy_1",
+ "operationId": "putPolicy",
"responses": {
"200": {
"description": "Policy updated",
}},
"tags": ["Callbacks"]
}},
- "/service": {"put": {
- "summary": "Register a service",
- "requestBody": {
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_registration_info_v1"}}},
- "required": true
- },
- "operationId": "putService",
- "responses": {
- "200": {
- "description": "Service updated",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "201": {
- "description": "Service created",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "400": {
- "description": "The ServiceRegistrationInfo is not accepted",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/services/{service_id}": {"delete": {
"summary": "Unregister a service",
- "operationId": "deleteService_1",
+ "operationId": "deleteService",
"responses": {
"200": {
"description": "Not used",
}},
"/a1-policy/v2/policies/{policy_id}/status": {"get": {
"summary": "Returns a policy status",
- "operationId": "getPolicyStatus_1",
+ "operationId": "getPolicyStatus",
"responses": {
"200": {
"description": "Policy status",
},
"info": {
"license": {
- "name": "Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.",
+ "name": "Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"description": "<h2>General<\/h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. <br/>The main tasks of the service are:<\/p><ul><li>A1 Policy creation, modification and deletion.<\/li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs<\/li><li>Maintaining a view of supported Near-RT RIC policy types<\/li><li>Supervision of using services (R-APPs). When a service is unavailble, its policies are removed.<\/li><\/ul><h2>APIs provided by the service<\/h2><h3>A1 Policy Management<\/h3><p>This is an API for management of A1 Policies.<\/p><ul><li>A1 Policy retrieval, creation, modification and deletion.<\/li><li>Retrieval of supported A1 Policy types for a Near-RT RIC<\/li><li>Retrieval of status for existing A1 policies<\/li><\/ul><h3>Management of configuration<\/h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.<\/p><h3>Callbacks<\/h3><p>These are endpoints that are invoked by this service. The callbacks are registerred in this service at service registration.<\/p><h3>NearRT-RIC Repository<\/h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.<\/p><h3>Health Check<\/h3><p>API used for supervision of the PMS component.<\/p><h3>Service Registry and Supervision<\/h3><p>API used for registerring services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registerred service and will automatically remove policies for unavailable services.<\/p>",
"tags": [
{"name": "Service Registry and Supervision"},
{"name": "A1 Policy Management"},
- {"name": "A1 Policy Management V1.0"},
{"name": "NearRT-RIC Repository"},
{"name": "Callbacks"},
{"name": "Health Check"},
- {
- "name": "A1 Policy Management V1.0",
- "description": "(deprecated primitves)"
- },
{"name": "Management of configuration"},
{
"name": "Actuator",
Each A1 policy is owned by a service. PMS can supervise each registerred service
and will automatically remove policies for unavailable services.</p>
license:
- name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.
+ name: Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.
url: http://www.apache.org/licenses/LICENSE-2.0
version: 1.1.0
servers:
tags:
- name: Service Registry and Supervision
- name: A1 Policy Management
-- name: A1 Policy Management V1.0
- name: NearRT-RIC Repository
- name: Callbacks
- name: Health Check
-- name: A1 Policy Management V1.0
- description: (deprecated primitves)
- name: Management of configuration
- name: Actuator
description: Monitor and interact
description: Spring Boot Actuator Web API Documentation
url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
paths:
- /policy_types:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query policy type identities
- operationId: getPolicyTypes
- parameters:
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get types for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy type identities
- content:
- '*/*':
- schema:
- type: array
- items:
- type: string
- 404:
- description: Near-RT RIC is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
/a1-policy/v2/policy-instances:
get:
tags:
tags:
- Health Check
summary: Returns status and statistics of this service
- operationId: getStatus_1
+ operationId: getStatus
responses:
200:
description: Service is living
'*/*':
schema:
type: object
- /services:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns service information
- operationId: getServices
- parameters:
- - name: name
- in: query
- description: The name of the service
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/service_status_v1'
- 404:
- description: Service is not found
- content:
- '*/*':
- schema:
- type: string
- delete:
- tags:
- - A1 Policy Management V1.0
- summary: Unregister a service
- operationId: deleteService
- parameters:
- - name: name
- in: query
- description: The name of the service
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 204:
- description: Service unregistered
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 404:
- description: Service not found
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/rics/ric:
get:
tags:
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: getRic_1
+ operationId: getRic
parameters:
- name: managed_element_id
in: query
tags:
- A1 Policy Management
summary: Query policy type identities
- operationId: getPolicyTypes_1
+ operationId: getPolicyTypes
parameters:
- name: ric_id
in: query
tags:
- A1 Policy Management
summary: Returns a policy
- operationId: getPolicy_1
+ operationId: getPolicy
parameters:
- name: policy_id
in: path
tags:
- A1 Policy Management
summary: Delete a policy
- operationId: deletePolicy_1
+ operationId: deletePolicy
parameters:
- name: policy_id
in: path
'*/*':
schema:
$ref: '#/components/schemas/error_information'
- /policy:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns a policy configuration
- operationId: getPolicy
- parameters:
- - name: id
- in: query
- description: The identity of the policy instance.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy found
- content:
- '*/*':
- schema:
- type: object
- 404:
- description: Policy is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- put:
- tags:
- - A1 Policy Management V1.0
- summary: Put a policy
- operationId: putPolicy
- parameters:
- - name: type
- in: query
- description: The name of the policy type.
- required: false
- style: form
- explode: true
- schema:
- type: string
- default: ""
- - name: id
- in: query
- description: The identity of the policy instance.
- required: true
- style: form
- explode: true
- schema:
- type: string
- - name: ric
- in: query
- description: The name of the Near-RT RIC where the policy will be created.
- required: true
- style: form
- explode: true
- schema:
- type: string
- - name: service
- in: query
- description: The name of the service creating the policy.
- required: true
- style: form
- explode: true
- schema:
- type: string
- - name: transient
- in: query
- description: If the policy is transient or not (boolean defaulted to false).
- A policy is transient if it will be forgotten when the service needs to
- reconnect to the Near-RT RIC.
- required: false
- style: form
- explode: true
- schema:
- type: boolean
- default: false
- requestBody:
- content:
- application/json:
- schema:
- type: object
- required: true
- responses:
- 200:
- description: Policy updated
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 201:
- description: Policy created
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 423:
- description: Near-RT RIC is not operational
- content:
- '*/*':
- schema:
- type: string
- 404:
- description: Near-RT RIC or policy type is not found
- content:
- '*/*':
- schema:
- type: string
- delete:
- tags:
- - A1 Policy Management V1.0
- summary: Delete a policy
- operationId: deletePolicy
- parameters:
- - name: id
- in: query
- description: The identity of the policy instance.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Not used
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 423:
- description: Near-RT RIC is not operational
- content:
- '*/*':
- schema:
- type: string
- 204:
- description: Policy deleted
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 404:
- description: Policy is not found
- content:
- '*/*':
- schema:
- type: string
/actuator:
get:
tags:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
- /policies:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query policies
- operationId: getPolicies
- parameters:
- - name: type
- in: query
- description: The name of the policy type to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: service
- in: query
- description: The name of the service to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policies
- content:
- '*/*':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/policy_info_v1'
- 404:
- description: Near-RT RIC or type not found
- content:
- '*/*':
- schema:
- type: string
/actuator/loggers/{name}:
get:
tags:
description: A registerred service must call this in regular intervals to indicate
that it is in operation. Absence of this call will lead to that teh service
will be deregisterred and all its policies are removed.
- operationId: keepAliveService_1
+ operationId: keepAliveService
parameters:
- name: service_id
in: path
'*/*':
schema:
$ref: '#/components/schemas/error_information'
- /rics:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query Near-RT RIC information
- operationId: getRics
- parameters:
- - name: policyType
- in: query
- description: The name of the policy type
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ric_info_v1'
- 404:
- description: Policy type is not found
- content:
- '*/*':
- schema:
- type: string
- /policy_schema:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns one policy type schema definition
- operationId: getPolicySchema
- parameters:
- - name: id
- in: query
- description: The identity of the policy type to get the definition for.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy schema
- content:
- '*/*':
- schema:
- type: object
- 404:
- description: The policy type is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
/actuator/metrics:
get:
tags:
'*/*':
schema:
type: object
- /policy_status:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns a policy status
- operationId: getPolicyStatus
- parameters:
- - name: id
- in: query
- description: The identity of the policy.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy status
- content:
- '*/*':
- schema:
- type: object
- 404:
- description: Policy is not found
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/rics:
get:
tags:
summary: Query Near-RT RIC information
description: The call returns all Near-RT RICs that supports a given policy
type identity
- operationId: getRics_1
+ operationId: getRics
parameters:
- name: policytype_id
in: query
application/json:
schema:
$ref: '#/components/schemas/error_information'
- /policy_schemas:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns policy type schema definitions
- operationId: getPolicySchemas
- parameters:
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get the definitions for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy schemas
- content:
- '*/*':
- schema:
- type: array
- items:
- type: object
- 404:
- description: Near-RT RIC is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- /policy_ids:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query policies, only policy identities returned
- operationId: getPolicyIds
- parameters:
- - name: type
- in: query
- description: The name of the policy type to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: service
- in: query
- description: The name of the service to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy identitiess
- content:
- '*/*':
- schema:
- type: array
- items:
- type: string
- 404:
- description: Near-RT RIC or type not found
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/services:
get:
tags:
summary: Returns service information
description: Either information about a registered service with given identity
or all registered services are returned.
- operationId: getServices_1
+ operationId: getServices
parameters:
- name: service_id
in: query
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: putService_1
+ operationId: putService
requestBody:
content:
application/json:
'*/*':
schema:
type: object
- /ric:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns the name of a RIC managing one Mananged Element
- operationId: getRic
- parameters:
- - name: managedElementId
- in: query
- description: The identity of the Managed Element
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Near-RT RIC is found
- content:
- '*/*':
- schema:
- type: string
- 404:
- description: Near-RT RIC is not found
- content:
- '*/*':
- schema:
- type: string
- /services/keepalive:
- put:
- tags:
- - A1 Policy Management V1.0
- summary: Heartbeat from a service
- operationId: keepAliveService
- parameters:
- - name: name
- in: query
- description: The name of the service
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Service supervision timer refreshed, OK
- content:
- '*/*':
- schema:
- type: string
- 404:
- description: The service is not found, needs re-registration
- content:
- '*/*':
- schema:
- type: string
/status:
get:
tags:
- - A1 Policy Management V1.0
+ - Health Check
summary: Returns status and statistics of this service
- operationId: getStatus
+ operationId: getStatusV1
responses:
200:
description: Service is living
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: getPolicyIds_1
+ operationId: getPolicyIds
parameters:
- name: policytype_id
in: query
tags:
- A1 Policy Management
summary: Create or update a policy
- operationId: putPolicy_1
+ operationId: putPolicy
requestBody:
content:
application/json:
application/json:
schema:
$ref: '#/components/schemas/void'
- /service:
- put:
- tags:
- - A1 Policy Management V1.0
- summary: Register a service
- operationId: putService
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/service_registration_info_v1'
- required: true
- responses:
- 200:
- description: Service updated
- content:
- '*/*':
- schema:
- type: string
- 201:
- description: Service created
- content:
- '*/*':
- schema:
- type: string
- 400:
- description: The ServiceRegistrationInfo is not accepted
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/services/{service_id}:
delete:
tags:
- Service Registry and Supervision
summary: Unregister a service
- operationId: deleteService_1
+ operationId: deleteService
parameters:
- name: service_id
in: path
tags:
- A1 Policy Management
summary: Returns a policy status
- operationId: getPolicyStatus_1
+ operationId: getPolicyStatus
parameters:
- name: policy_id
in: path
status:
type: string
description: status text
- policy_info_v1:
- type: object
- properties:
- service:
- type: string
- description: the name of the service owning the policy
- json:
- type: object
- description: the configuration of the policy
- id:
- type: string
- description: identity of the policy
- lastModified:
- type: string
- description: timestamp, last modification time
- type:
- type: string
- description: name of the policy type
- ric:
- type: string
- description: identity of the target Near-RT RIC
- service_registration_info_v1:
- type: object
- properties:
- keepAliveIntervalSeconds:
- type: integer
- description: keep alive interval for the service. This is a heartbeat supervision
- of the service, which in regular intevals must invoke a 'keepAlive' REST
- call. When a service does not invoke this call within the given time,
- it is considered unavailble. An unavailable service will be automatically
- deregistered and its policies will be deleted. Value 0 means no timeout
- supervision.
- format: int64
- callbackUrl:
- type: string
- description: callback for notifying of RIC synchronization
- serviceName:
- type: string
ric_info_v2:
type: object
properties:
items:
$ref: '#/components/schemas/policy_info_v2'
description: List of policy information
- ric_info_v1:
- type: object
- properties:
- managedElementIds:
- type: array
- description: O1 identities for managed entities
- items:
- type: string
- description: O1 identities for managed entities
- policyTypes:
- type: array
- description: supported policy types
- items:
- type: string
- description: supported policy types
- state:
- type: string
- description: state info
- ricName:
- type: string
- description: identity of the Near-RT RIC
- service_status_v1:
- type: object
- properties:
- keepAliveIntervalSeconds:
- type: integer
- description: policy keep alive timeout
- format: int64
- timeSinceLastActivitySeconds:
- type: integer
- description: time since last invocation by the service
- format: int64
- callbackUrl:
- type: string
- description: callback for notifying of RIC synchronization
- serviceName:
- type: string
- description: identity of the service
policy_status_info_v2:
type: object
properties:
*/
@OpenAPIDefinition( //
tags = { //
- @Tag(//
- name = org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1.Consts.V1_API_NAME, //
- description = org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1.Consts.V1_API_DESCRIPTION //
- ), //
@Tag(//
name = ConfigurationController.API_NAME, //
description = ConfigurationController.API_DESCRIPTION //
info = @Info(title = SwaggerConfig.API_TITLE, //
version = SwaggerConfig.VERSION, //
description = SwaggerConfig.DESCRIPTION, //
- license = @License(name = "Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.", //
+ license = @License(
+ name = "Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.", //
url = "http://www.apache.org/licenses/LICENSE-2.0")) //
)
public class SwaggerConfig {
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-public class Consts {
-
- public static final String V1_API_NAME = "A1 Policy Management V1.0";
- public static final String V1_API_DESCRIPTION = "(deprecated primitves)";
-
- private Consts() {}
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.ArraySchema;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.Schema;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
-import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import io.swagger.v3.oas.annotations.tags.Tag;
-
-import java.lang.invoke.MethodHandles;
-import java.time.Instant;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-
-import lombok.Getter;
-
-import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
-import org.onap.ccsdk.oran.a1policymanagementservice.controllers.VoidResponse;
-import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.ErrorResponse;
-import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Service;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
-import org.springframework.web.reactive.function.client.WebClientResponseException;
-import reactor.core.publisher.Mono;
-
-@RestController
-@Tag(name = Consts.V1_API_NAME)
-public class PolicyController {
-
- public static class RejectionException extends Exception {
- private static final long serialVersionUID = 1L;
- @Getter
- private final HttpStatus status;
-
- public RejectionException(String message, HttpStatus status) {
- super(message);
- this.status = status;
- }
- }
-
- @Autowired
- private Rics rics;
- @Autowired
- private PolicyTypes policyTypes;
- @Autowired
- private Policies policies;
- @Autowired
- private A1ClientFactory a1ClientFactory;
- @Autowired
- private Services services;
-
- private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private static Gson gson = new GsonBuilder().create();
-
- @GetMapping("/policy_schemas") //
- @Operation(summary = "Returns policy type schema definitions") //
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policy schemas", //
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = Object.class)))), //
- @ApiResponse(responseCode = "404", //
- description = "Near-RT RIC is not found", //
- content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
- })
- public ResponseEntity<String> getPolicySchemas( //
- @Parameter(name = "ric", required = false,
- description = "The name of the Near-RT RIC to get the definitions for.") //
- @RequestParam(name = "ric", required = false) String ricName) throws EntityNotFoundException {
- if (ricName == null) {
- Collection<PolicyType> types = this.policyTypes.getAll();
- return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
- } else {
- Collection<PolicyType> types = rics.getRic(ricName).getSupportedPolicyTypes();
- return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
- }
- }
-
- @GetMapping("/policy_schema")
- @Operation(summary = "Returns one policy type schema definition")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policy schema", //
- content = @Content(schema = @Schema(implementation = Object.class))),
- @ApiResponse(responseCode = "404", //
- description = "The policy type is not found", //
- content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class)))//
- })
- public ResponseEntity<String> getPolicySchema( //
- @Parameter(name = "id", required = true,
- description = "The identity of the policy type to get the definition for.") //
- @RequestParam(name = "id", required = true) String id) throws EntityNotFoundException {
- PolicyType type = policyTypes.getType(id);
- return new ResponseEntity<>(type.getSchema(), HttpStatus.OK);
- }
-
- @GetMapping("/policy_types")
- @Operation(summary = "Query policy type identities")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policy type identities", //
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))), //
- @ApiResponse(responseCode = "404", //
- description = "Near-RT RIC is not found", //
- content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class)))//
- })
- public ResponseEntity<String> getPolicyTypes( //
- @Parameter(name = "ric", required = false, description = "The name of the Near-RT RIC to get types for.") //
- @RequestParam(name = "ric", required = false) String ricName) throws EntityNotFoundException {
- if (ricName == null) {
- Collection<PolicyType> types = this.policyTypes.getAll();
- return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK);
- } else {
- Collection<PolicyType> types = rics.getRic(ricName).getSupportedPolicyTypes();
- return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK);
- }
- }
-
- @GetMapping("/policy")
- @Operation(summary = "Returns a policy configuration") //
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policy found", //
- content = @Content(schema = @Schema(implementation = Object.class))), //
- @ApiResponse(responseCode = "404", //
- description = "Policy is not found", //
- content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))//
- )} //
- )
- public ResponseEntity<String> getPolicy( //
- @Parameter(name = "id", required = true, description = "The identity of the policy instance.") //
- @RequestParam(name = "id", required = true) String id) throws EntityNotFoundException {
- Policy p = policies.getPolicy(id);
- return new ResponseEntity<>(p.getJson(), HttpStatus.OK);
- }
-
- @DeleteMapping("/policy")
- @Operation(summary = "Delete a policy")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Not used", //
- content = @Content(schema = @Schema(implementation = VoidResponse.class))),
- @ApiResponse(responseCode = "204", //
- description = "Policy deleted", //
- content = @Content(schema = @Schema(implementation = VoidResponse.class))),
- @ApiResponse(responseCode = "404", //
- description = "Policy is not found", //
- content = @Content(schema = @Schema(implementation = String.class))),
- @ApiResponse(responseCode = "423", //
- description = "Near-RT RIC is not operational", //
- content = @Content(schema = @Schema(implementation = String.class)))})
- public Mono<ResponseEntity<Object>> deletePolicy( //
- @Parameter(name = "id", required = true, description = "The identity of the policy instance.") //
- @RequestParam(name = "id", required = true) String id) throws EntityNotFoundException {
- Policy policy = policies.getPolicy(id);
- keepServiceAlive(policy.getOwnerServiceId());
- Ric ric = policy.getRic();
- return ric.getLock().lock(LockType.SHARED) //
- .flatMap(notUsed -> assertRicStateIdle(ric)) //
- .flatMap(notUsed -> a1ClientFactory.createA1Client(policy.getRic())) //
- .doOnNext(notUsed -> policies.remove(policy)) //
- .flatMap(client -> client.deletePolicy(policy)) //
- .doOnNext(notUsed -> ric.getLock().unlockBlocking()) //
- .doOnError(notUsed -> ric.getLock().unlockBlocking()) //
- .map(notUsed -> new ResponseEntity<>(HttpStatus.NO_CONTENT)) //
- .onErrorResume(this::handleException);
- }
-
- @PutMapping(path = "/policy")
- @Operation(summary = "Put a policy")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "201", //
- description = "Policy created", //
- content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
- @ApiResponse(responseCode = "200", //
- description = "Policy updated", //
- content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
- @ApiResponse(responseCode = "423", //
- description = "Near-RT RIC is not operational", //
- content = @Content(schema = @Schema(implementation = String.class))), //
- @ApiResponse(responseCode = "404", //
- description = "Near-RT RIC or policy type is not found", //
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
- public Mono<ResponseEntity<Object>> putPolicy( //
- @Parameter(name = "type", required = false, description = "The name of the policy type.") //
- @RequestParam(name = "type", required = false, defaultValue = "") String typeName, //
- @Parameter(name = "id", required = true, description = "The identity of the policy instance.") //
- @RequestParam(name = "id", required = true) String instanceId, //
- @Parameter(name = "ric", required = true,
- description = "The name of the Near-RT RIC where the policy will be " + //
- "created.") //
- @RequestParam(name = "ric", required = true) String ricName, //
- @Parameter(name = "service", required = true, description = "The name of the service creating the policy.") //
- @RequestParam(name = "service", required = true) String service, //
- @Parameter(name = "transient", required = false,
- description = "If the policy is transient or not (boolean " + //
- "defaulted to false). A policy is transient if it will be forgotten when the service needs to "
- + //
- "reconnect to the Near-RT RIC.") //
- @RequestParam(name = "transient", required = false, defaultValue = "false") boolean isTransient, //
- @RequestBody Object jsonBody) {
-
- String jsonString = gson.toJson(jsonBody);
- Ric ric = rics.get(ricName);
- PolicyType type = policyTypes.get(typeName);
- keepServiceAlive(service);
- if (ric == null || type == null) {
- return Mono.just(new ResponseEntity<>(HttpStatus.NOT_FOUND));
- }
- Policy policy = Policy.builder() //
- .id(instanceId) //
- .json(jsonString) //
- .type(type) //
- .ric(ric) //
- .ownerServiceId(service) //
- .lastModified(Instant.now()) //
- .isTransient(isTransient) //
- .statusNotificationUri("") //
- .build();
-
- final boolean isCreate = this.policies.get(policy.getId()) == null;
-
- return ric.getLock().lock(LockType.SHARED) //
- .flatMap(notUsed -> assertRicStateIdle(ric)) //
- .flatMap(notUsed -> checkSupportedType(ric, type)) //
- .flatMap(notUsed -> validateModifiedPolicy(policy)) //
- .flatMap(notUsed -> a1ClientFactory.createA1Client(ric)) //
- .flatMap(client -> client.putPolicy(policy)) //
- .doOnNext(notUsed -> policies.put(policy)) //
- .doOnNext(notUsed -> ric.getLock().unlockBlocking()) //
- .doOnError(trowable -> ric.getLock().unlockBlocking()) //
- .map(notUsed -> new ResponseEntity<>(isCreate ? HttpStatus.CREATED : HttpStatus.OK)) //
- .onErrorResume(this::handleException);
- }
-
- @SuppressWarnings({"unchecked"})
- private <T> Mono<ResponseEntity<T>> createResponseEntity(String message, HttpStatus status) {
- ResponseEntity<T> re = new ResponseEntity<>((T) message, status);
- return Mono.just(re);
- }
-
- private <T> Mono<ResponseEntity<T>> handleException(Throwable throwable) {
- if (throwable instanceof WebClientResponseException) {
- WebClientResponseException e = (WebClientResponseException) throwable;
- return createResponseEntity(e.getResponseBodyAsString(), e.getStatusCode());
- } else if (throwable instanceof RejectionException) {
- RejectionException e = (RejectionException) throwable;
- return createResponseEntity(e.getMessage(), e.getStatus());
- } else {
- return createResponseEntity(throwable.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
- }
- }
-
- private Mono<Object> validateModifiedPolicy(Policy policy) {
- // Check that ric is not updated
- Policy current = this.policies.get(policy.getId());
- if (current != null && !current.getRic().id().equals(policy.getRic().id())) {
- RejectionException e = new RejectionException("Policy cannot change RIC, policyId: " + current.getId() + //
- ", RIC name: " + current.getRic().id() + //
- ", new name: " + policy.getRic().id(), HttpStatus.CONFLICT);
- logger.debug("Request rejected, {}", e.getMessage());
- return Mono.error(e);
- }
- return Mono.just("OK");
- }
-
- private Mono<Object> checkSupportedType(Ric ric, PolicyType type) {
- if (!ric.isSupportingType(type.getId())) {
- logger.debug("Request rejected, type not supported, RIC: {}", ric);
- RejectionException e = new RejectionException(
- "Type: " + type.getId() + " not supported by RIC: " + ric.id(), HttpStatus.NOT_FOUND);
- return Mono.error(e);
- }
- return Mono.just("OK");
- }
-
- private Mono<Object> assertRicStateIdle(Ric ric) {
- if (ric.getState() == Ric.RicState.AVAILABLE) {
- return Mono.just("OK");
- } else {
- logger.debug("Request rejected RIC not IDLE, ric: {}", ric);
- RejectionException e = new RejectionException(
- "Ric is not operational, RIC name: " + ric.id() + ", state: " + ric.getState(), HttpStatus.LOCKED);
- return Mono.error(e);
- }
- }
-
- @GetMapping("/policies")
- @Operation(summary = "Query policies")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policies", //
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = PolicyInfo.class)))), //
- @ApiResponse(responseCode = "404", //
- description = "Near-RT RIC or type not found", //
- content = @Content(schema = @Schema(implementation = String.class)))})
- public ResponseEntity<String> getPolicies( //
- @Parameter(name = "type", required = false,
- description = "The name of the policy type to get policies for.") //
- @RequestParam(name = "type", required = false) String type, //
- @Parameter(name = "ric", required = false, description = "The name of the Near-RT RIC to get policies for.") //
- @RequestParam(name = "ric", required = false) String ric, //
- @Parameter(name = "service", required = false, description = "The name of the service to get policies for.") //
- @RequestParam(name = "service", required = false) String service) //
- {
- if ((type != null && this.policyTypes.get(type) == null)) {
- return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND);
- }
- if ((ric != null && this.rics.get(ric) == null)) {
- return new ResponseEntity<>("Near-RT RIC not found", HttpStatus.NOT_FOUND);
- }
-
- String filteredPolicies = policiesToJson(policies.filterPolicies(type, ric, service, null));
- return new ResponseEntity<>(filteredPolicies, HttpStatus.OK);
- }
-
- @GetMapping("/policy_ids")
- @Operation(summary = "Query policies, only policy identities returned")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policy identitiess", //
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))),
- @ApiResponse(responseCode = "404", //
- description = "Near-RT RIC or type not found", //
- content = @Content(schema = @Schema(implementation = String.class)))})
- public ResponseEntity<String> getPolicyIds( //
- @Parameter(name = "type", required = false,
- description = "The name of the policy type to get policies for.") //
- @RequestParam(name = "type", required = false) String type, //
- @Parameter(name = "ric", required = false, description = "The name of the Near-RT RIC to get policies for.") //
- @RequestParam(name = "ric", required = false) String ric, //
- @Parameter(name = "service", required = false, description = "The name of the service to get policies for.") //
- @RequestParam(name = "service", required = false) String service) //
- {
- if ((type != null && this.policyTypes.get(type) == null)) {
- return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND);
- }
- if ((ric != null && this.rics.get(ric) == null)) {
- return new ResponseEntity<>("Near-RT RIC not found", HttpStatus.NOT_FOUND);
- }
-
- String policyIdsJson = toPolicyIdsJson(policies.filterPolicies(type, ric, service, null));
- return new ResponseEntity<>(policyIdsJson, HttpStatus.OK);
- }
-
- @GetMapping("/policy_status")
- @Operation(summary = "Returns a policy status") //
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Policy status", //
- content = @Content(schema = @Schema(implementation = Object.class))), //
- @ApiResponse(responseCode = "404", //
- description = "Policy is not found", //
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
- public Mono<ResponseEntity<String>> getPolicyStatus( //
- @Parameter(name = "id", required = true, description = "The identity of the policy.") @RequestParam(
- name = "id", //
- required = true) String id)
- throws EntityNotFoundException {
- Policy policy = policies.getPolicy(id);
-
- return a1ClientFactory.createA1Client(policy.getRic()) //
- .flatMap(client -> client.getPolicyStatus(policy)) //
- .map(status -> new ResponseEntity<>(status, HttpStatus.OK)) //
- .onErrorResume(this::handleException);
- }
-
- private void keepServiceAlive(String name) {
- Service s = this.services.get(name);
- if (s != null) {
- s.keepAlive();
- }
- }
-
- private String policiesToJson(Collection<Policy> policies) {
- List<PolicyInfo> v = new ArrayList<>(policies.size());
- for (Policy p : policies) {
- PolicyInfo policyInfo = new PolicyInfo();
- policyInfo.id = p.getId();
- policyInfo.json = fromJson(p.getJson());
- policyInfo.ric = p.getRic().id();
- policyInfo.type = p.getType().getId();
- policyInfo.service = p.getOwnerServiceId();
- policyInfo.lastModified = p.getLastModified().toString();
- if (!policyInfo.validate()) {
- logger.error("BUG, all fields must be set");
- }
- v.add(policyInfo);
- }
- return gson.toJson(v);
- }
-
- private Object fromJson(String jsonStr) {
- return gson.fromJson(jsonStr, Object.class);
- }
-
- private String toPolicyTypeSchemasJson(Collection<PolicyType> types) {
- StringBuilder result = new StringBuilder();
- result.append("[");
- boolean first = true;
- for (PolicyType t : types) {
- if (!first) {
- result.append(",");
- }
- first = false;
- result.append(t.getSchema());
- }
- result.append("]");
- return result.toString();
- }
-
- private String toPolicyTypeIdsJson(Collection<PolicyType> types) {
- List<String> v = new ArrayList<>(types.size());
- for (PolicyType t : types) {
- v.add(t.getId());
- }
- return gson.toJson(v);
- }
-
- private String toPolicyIdsJson(Collection<Policy> policies) {
- List<String> v = new ArrayList<>(policies.size());
- for (Policy p : policies) {
- v.add(p.getId());
- }
- return gson.toJson(v);
- }
-
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-
-import org.immutables.gson.Gson;
-
-@Gson.TypeAdapters
-@Schema(name = "policy_info_v1")
-public class PolicyInfo {
-
- @Schema(description = "identity of the policy")
- public String id;
-
- @Schema(description = "name of the policy type")
- public String type;
-
- @Schema(description = "identity of the target Near-RT RIC")
- public String ric;
-
- @Schema(description = "the configuration of the policy")
- public Object json;
-
- @Schema(description = "the name of the service owning the policy")
- public String service;
-
- @Schema(description = "timestamp, last modification time")
- public String lastModified;
-
- PolicyInfo() {}
-
- public boolean validate() {
- return id != null && type != null && ric != null && json != null && service != null && lastModified != null;
- }
-
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-
-import java.util.Collection;
-
-import org.immutables.gson.Gson;
-
-@Gson.TypeAdapters
-@Schema(name = "ric_info_v1")
-class RicInfo {
- @Schema(description = "identity of the Near-RT RIC")
- public final String ricName;
-
- @Schema(description = "O1 identities for managed entities")
- public final Collection<String> managedElementIds;
-
- @Schema(description = "supported policy types")
- public final Collection<String> policyTypes;
-
- @Schema(description = "state info")
- public final String state;
-
- RicInfo(String name, Collection<String> managedElementIds, Collection<String> policyTypes, String state) {
- this.ricName = name;
- this.managedElementIds = managedElementIds;
- this.policyTypes = policyTypes;
- this.state = state;
- }
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.ArraySchema;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.Schema;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
-import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import io.swagger.v3.oas.annotations.tags.Tag;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
-
-@RestController
-@Tag(name = Consts.V1_API_NAME)
-public class RicRepositoryController {
-
- @Autowired
- private Rics rics;
-
- @Autowired
- PolicyTypes types;
-
- private static Gson gson = new GsonBuilder() //
- .create(); //
-
- /**
- * Example: http://localhost:8081/rics?managedElementId=kista_1
- *
- * @throws EntityNotFoundException
- */
- @GetMapping("/ric")
- @Operation(summary = "Returns the name of a RIC managing one Mananged Element")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Near-RT RIC is found", //
- content = @Content(schema = @Schema(implementation = String.class))), //
- @ApiResponse(responseCode = "404", //
- description = "Near-RT RIC is not found", //
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
-
- public ResponseEntity<String> getRic( //
- @Parameter(name = "managedElementId", required = true, description = "The identity of the Managed Element") //
- @RequestParam(name = "managedElementId", required = true) String managedElementId)
- throws EntityNotFoundException {
- Ric ric = this.rics.lookupRicForManagedElement(managedElementId);
- return new ResponseEntity<>(ric.id(), HttpStatus.OK);
- }
-
- /**
- * @return a Json array of all RIC data Example: http://localhost:8081/ric
- */
- @GetMapping("/rics")
- @Operation(summary = "Query Near-RT RIC information")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "OK", //
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = RicInfo.class)))), //
- @ApiResponse(responseCode = "404", //
- description = "Policy type is not found", //
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
- public ResponseEntity<String> getRics( //
- @Parameter(name = "policyType", required = false, description = "The name of the policy type") //
- @RequestParam(name = "policyType", required = false) String supportingPolicyType) {
- if ((supportingPolicyType != null) && (this.types.get(supportingPolicyType) == null)) {
- return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND);
- }
-
- List<RicInfo> result = new ArrayList<>();
- for (Ric ric : rics.getRics()) {
- if (supportingPolicyType == null || ric.isSupportingType(supportingPolicyType)) {
- result.add(new RicInfo(ric.id(), ric.getManagedElementIds(), ric.getSupportedPolicyTypeNames(),
- ric.getState().toString()));
- }
- }
-
- return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
- }
-
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.ArraySchema;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.Schema;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
-import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import io.swagger.v3.oas.annotations.tags.Tag;
-
-import java.net.MalformedURLException;
-import java.net.URL;
-import java.time.Duration;
-import java.util.ArrayList;
-import java.util.Collection;
-
-import org.onap.ccsdk.oran.a1policymanagementservice.controllers.VoidResponse;
-import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Service;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
-
-@RestController
-@Tag(name = Consts.V1_API_NAME)
-public class ServiceController {
-
- private final Services services;
- private final Policies policies;
-
- private static Gson gson = new GsonBuilder().create();
-
- @Autowired
- ServiceController(Services services, Policies policies) {
- this.services = services;
- this.policies = policies;
- }
-
- @GetMapping("/services")
- @Operation(summary = "Returns service information")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "OK", //
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = ServiceStatus.class)))), //
- @ApiResponse(responseCode = "404", //
- description = "Service is not found", //
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
-
- public ResponseEntity<String> getServices(//
- @Parameter(name = "name", required = false, description = "The name of the service") //
- @RequestParam(name = "name", required = false) String name) {
- if (name != null && this.services.get(name) == null) {
- return new ResponseEntity<>("Service not found", HttpStatus.NOT_FOUND);
- }
-
- Collection<ServiceStatus> servicesStatus = new ArrayList<>();
- for (Service s : this.services.getAll()) {
- if (name == null || name.equals(s.getName())) {
- servicesStatus.add(toServiceStatus(s));
- }
- }
-
- String res = gson.toJson(servicesStatus);
- return new ResponseEntity<>(res, HttpStatus.OK);
- }
-
- private ServiceStatus toServiceStatus(Service s) {
- return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds(),
- s.getCallbackUrl());
- }
-
- private void validateRegistrationInfo(ServiceRegistrationInfo registrationInfo)
- throws ServiceException, MalformedURLException {
- if (registrationInfo.serviceName.isEmpty()) {
- throw new ServiceException("Missing mandatory parameter 'serviceName'");
- }
- if (registrationInfo.keepAliveIntervalSeconds < 0) {
- throw new ServiceException("Keepalive interval should be greater or equal to 0");
- }
- if (!registrationInfo.callbackUrl.isEmpty()) {
- new URL(registrationInfo.callbackUrl);
- }
- }
-
- @Operation(summary = "Register a service")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", //
- description = "Service updated", //
- content = @Content(schema = @Schema(implementation = String.class))), //
- @ApiResponse(responseCode = "201", //
- description = "Service created", //
- content = @Content(schema = @Schema(implementation = String.class))), //
- @ApiResponse(responseCode = "400", //
- description = "The ServiceRegistrationInfo is not accepted", //
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
- @PutMapping("/service")
- public ResponseEntity<String> putService(//
- @RequestBody ServiceRegistrationInfo registrationInfo) {
- try {
- validateRegistrationInfo(registrationInfo);
- final boolean isCreate = this.services.get(registrationInfo.serviceName) == null;
- this.services.put(toService(registrationInfo));
- return new ResponseEntity<>("OK", isCreate ? HttpStatus.CREATED : HttpStatus.OK);
- } catch (Exception e) {
- return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
- }
- }
-
- @Operation(summary = "Unregister a service")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "204", description = "Service unregistered", //
- content = @Content(schema = @Schema(implementation = VoidResponse.class))),
- @ApiResponse(responseCode = "404", description = "Service not found", //
- content = @Content(schema = @Schema(implementation = String.class)))})
- @DeleteMapping("/services")
- public ResponseEntity<String> deleteService(//
- @Parameter(name = "name", required = true, description = "The name of the service") //
- @RequestParam(name = "name", required = true) String serviceName) {
- try {
- Service service = removeService(serviceName);
- // Remove the policies from the repo and let the consistency monitoring
- // do the rest.
- removePolicies(service);
- return new ResponseEntity<>("OK", HttpStatus.NO_CONTENT);
- } catch (Exception e) {
- return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
- }
- }
-
- @Operation(summary = "Heartbeat from a service")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", description = "Service supervision timer refreshed, OK"),
- @ApiResponse(responseCode = "404", description = "The service is not found, needs re-registration")
-
- })
-
- @PutMapping("/services/keepalive")
- public ResponseEntity<String> keepAliveService(//
- @Parameter(name = "name", required = true, description = "The name of the service") //
- @RequestParam(name = "name", required = true) String serviceName) {
- try {
- services.getService(serviceName).keepAlive();
- return new ResponseEntity<>("OK", HttpStatus.OK);
- } catch (ServiceException e) {
- return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
- }
- }
-
- private Service removeService(String name) throws ServiceException {
- Service service = this.services.getService(name); // Just to verify that it exists
- this.services.remove(service.getName());
- return service;
- }
-
- private void removePolicies(Service service) {
- Collection<Policy> policyList = this.policies.getForService(service.getName());
- for (Policy policy : policyList) {
- this.policies.remove(policy);
- }
- }
-
- private Service toService(ServiceRegistrationInfo s) {
- return new Service(s.serviceName, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl);
- }
-
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import com.google.gson.annotations.SerializedName;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-
-import org.immutables.gson.Gson;
-
-@Gson.TypeAdapters
-@Schema(name = "service_registration_info_v1")
-public class ServiceRegistrationInfo {
-
- @SerializedName("serviceName")
- public String serviceName = "";
-
- @Schema(description = "keep alive interval for the service. This is a heartbeat supervision of the service, "
- + "which in regular intevals must invoke a 'keepAlive' REST call. "
- + "When a service does not invoke this call within the given time, it is considered unavailble. "
- + "An unavailable service will be automatically deregistered and its policies will be deleted. "
- + "Value 0 means no timeout supervision.")
- @SerializedName("keepAliveIntervalSeconds")
- public long keepAliveIntervalSeconds = 0;
-
- @Schema(description = "callback for notifying of RIC synchronization")
- @SerializedName("callbackUrl")
- public String callbackUrl = "";
-
- public ServiceRegistrationInfo() {}
-
- public ServiceRegistrationInfo(String name, long keepAliveIntervalSeconds, String callbackUrl) {
- this.serviceName = name;
- this.keepAliveIntervalSeconds = keepAliveIntervalSeconds;
- this.callbackUrl = callbackUrl;
- }
-
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-
-import org.immutables.gson.Gson;
-
-@Gson.TypeAdapters
-@Schema(name = "service_status_v1")
-public class ServiceStatus {
-
- @Schema(description = "identity of the service")
- public final String serviceName;
-
- @Schema(description = "policy keep alive timeout")
- public final long keepAliveIntervalSeconds;
-
- @Schema(description = "time since last invocation by the service")
- public final long timeSinceLastActivitySeconds;
-
- @Schema(description = "callback for notifying of RIC synchronization")
- public String callbackUrl;
-
- ServiceStatus(String name, long keepAliveIntervalSeconds, long timeSincePingSeconds, String callbackUrl) {
- this.serviceName = name;
- this.keepAliveIntervalSeconds = keepAliveIntervalSeconds;
- this.timeSinceLastActivitySeconds = timeSincePingSeconds;
- this.callbackUrl = callbackUrl;
- }
-
-}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.Schema;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
-import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import io.swagger.v3.oas.annotations.tags.Tag;
-
-import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RestController;
-import reactor.core.publisher.Mono;
-
-@RestController
-@Tag(name = Consts.V1_API_NAME)
-public class StatusController {
-
- @GetMapping("/status")
- @Operation(summary = "Returns status and statistics of this service")
- @ApiResponses(value = { //
- @ApiResponse(responseCode = "200", description = "Service is living",
- content = @Content(schema = @Schema(implementation = String.class))) //
- })
-
- public Mono<ResponseEntity<String>> getStatus() {
- return Mono.just(new ResponseEntity<>("hunky dory", HttpStatus.OK));
- }
-
-}
return Mono.just(new ResponseEntity<>(info, HttpStatus.OK));
}
+ @GetMapping("/status")
+ @Operation(summary = "Returns status and statistics of this service")
+ @ApiResponses(value = { //
+ @ApiResponse(responseCode = "200", description = "Service is living",
+ content = @Content(schema = @Schema(implementation = String.class))) //
+ })
+
+ public Mono<ResponseEntity<String>> getStatusV1() {
+ return Mono.just(new ResponseEntity<>("hunky dory", HttpStatus.OK));
+ }
+
}
+++ /dev/null
-/*-
- * ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ========================LICENSE_END===================================
- */
-
-package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.awaitility.Awaitility.await;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.Mockito.doReturn;
-
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-import com.google.gson.JsonArray;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonParser;
-
-import java.nio.charset.StandardCharsets;
-import java.time.Duration;
-import java.time.Instant;
-import java.util.ArrayList;
-import java.util.List;
-
-import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
-import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
-import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClient;
-import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableRicConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableWebClientConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.WebClientConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
-import org.onap.ccsdk.oran.a1policymanagementservice.tasks.RicSupervision;
-import org.onap.ccsdk.oran.a1policymanagementservice.tasks.ServiceSupervision;
-import org.onap.ccsdk.oran.a1policymanagementservice.utils.MockA1Client;
-import org.onap.ccsdk.oran.a1policymanagementservice.utils.MockA1ClientFactory;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
-import org.springframework.boot.test.context.TestConfiguration;
-import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
-import org.springframework.boot.web.server.LocalServerPort;
-import org.springframework.boot.web.servlet.server.ServletWebServerFactory;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.annotation.Bean;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
-import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
-import org.springframework.web.reactive.function.client.WebClientResponseException;
-
-import reactor.core.publisher.Mono;
-import reactor.test.StepVerifier;
-import reactor.util.annotation.Nullable;
-
-@ExtendWith(SpringExtension.class)
-@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
-@TestPropertySource(properties = { //
- "server.ssl.key-store=./config/keystore.jks", //
- "app.webclient.trust-store=./config/truststore.jks", //
- "app.vardata-directory=./target"})
-class ApplicationTest {
- private static final Logger logger = LoggerFactory.getLogger(ApplicationTest.class);
-
- @Autowired
- ApplicationContext context;
-
- @Autowired
- private Rics rics;
-
- @Autowired
- private Policies policies;
-
- @Autowired
- private PolicyTypes policyTypes;
-
- @Autowired
- MockA1ClientFactory a1ClientFactory;
-
- @Autowired
- RicSupervision supervision;
-
- @Autowired
- ApplicationConfig applicationConfig;
-
- @Autowired
- Services services;
-
- private static Gson gson = new GsonBuilder().create();
-
- public static class MockApplicationConfig extends ApplicationConfig {
- @Override
- public String getLocalConfigurationFilePath() {
- return ""; // No config file loaded for the test
- }
-
- }
-
- /**
- * Overrides the BeanFactory.
- */
- @TestConfiguration
- static class TestBeanFactory {
-
- @Bean
- public ApplicationConfig getApplicationConfig() {
- return new MockApplicationConfig();
- }
-
- @Bean
- MockA1ClientFactory getA1ClientFactory(@Autowired ApplicationConfig appConfig, @Autowired PolicyTypes types) {
- return new MockA1ClientFactory(appConfig, types);
- }
-
- @Bean
- public ServiceSupervision getServiceSupervision(@Autowired Services services,
- @Autowired A1ClientFactory a1ClientFactory, @Autowired Policies policies) {
- Duration checkInterval = Duration.ofMillis(1);
- return new ServiceSupervision(services, policies, a1ClientFactory, checkInterval);
- }
-
- @Bean
- public ServletWebServerFactory servletContainer() {
- return new TomcatServletWebServerFactory();
- }
-
- }
-
- @LocalServerPort
- private int port;
-
- @AfterEach
- void reset() {
- rics.clear();
- policies.clear();
- policyTypes.clear();
- services.clear();
- a1ClientFactory.reset();
- }
-
- @AfterEach
- void verifyNoRicLocks() {
- for (Ric ric : this.rics.getRics()) {
- ric.getLock().lockBlocking(LockType.EXCLUSIVE);
- ric.getLock().unlockBlocking();
- assertThat(ric.getLock().getLockCounter()).isZero();
- assertThat(ric.getState()).isEqualTo(Ric.RicState.AVAILABLE);
- }
- }
-
- @Test
- void testGetRics() throws Exception {
- addRic("ric1");
- this.addPolicyType("type1", "ric1");
- String url = "/rics?policyType=type1";
- String rsp = restClient().get(url).block();
- assertThat(rsp).contains("ric1");
-
- // nameless type for ORAN A1 1.1
- addRic("ric2");
- this.addPolicyType("", "ric2");
- url = "/rics?policyType=";
-
- rsp = restClient().get(url).block();
- assertThat(rsp).contains("ric2") //
- .doesNotContain("ric1") //
- .contains("AVAILABLE");
-
- // All RICs
- rsp = restClient().get("/rics").block();
- assertThat(rsp).contains("ric2") //
- .contains("ric1");
-
- // Non existing policy type
- url = "/rics?policyType=XXXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testSynchronization() throws Exception {
- // Two polictypes will be put in the NearRT RICs
- PolicyTypes nearRtRicPolicyTypes = new PolicyTypes(this.applicationConfig);
- nearRtRicPolicyTypes.put(createPolicyType("typeName"));
- nearRtRicPolicyTypes.put(createPolicyType("typeName2"));
- this.a1ClientFactory.setPolicyTypes(nearRtRicPolicyTypes);
-
- // One type and one instance added to the Policy Management Service's storage
- final String ric1Name = "ric1";
- Ric ric1 = addRic(ric1Name);
- Policy policy2 = addPolicy("policyId2", "typeName", "service", ric1Name);
- Ric ric2 = addRic("ric2");
-
- getA1Client(ric1Name).putPolicy(policy2); // put it in the RIC
- policies.remove(policy2); // Remove it from the repo -> should be deleted in the RIC
-
- String policyId = "policyId";
- Policy policy = addPolicy(policyId, "typeName", "service", ric1Name); // This should be created in the RIC
- supervision.checkAllRics(); // The created policy should be put in the RIC
-
- // Wait until synch is completed
- await().untilAsserted(() -> RicState.SYNCHRONIZING.equals(rics.getRic(ric1Name).getState()));
- await().untilAsserted(() -> RicState.AVAILABLE.equals(rics.getRic(ric1Name).getState()));
- await().untilAsserted(() -> RicState.AVAILABLE.equals(rics.getRic("ric2").getState()));
-
- Policies ricPolicies = getA1Client(ric1Name).getPolicies();
- assertThat(ricPolicies.size()).isEqualTo(1);
- Policy ricPolicy = ricPolicies.get(policyId);
- assertThat(ricPolicy.getJson()).isEqualTo(policy.getJson());
-
- // Both types should be in the Policy Management Service's storage after the
- // synch
- assertThat(ric1.getSupportedPolicyTypes()).hasSize(2);
- assertThat(ric2.getSupportedPolicyTypes()).hasSize(2);
- }
-
- @Test
- void testGetRicForManagedElement_thenReturnCorrectRic() throws Exception {
- String ricName = "ric1";
- String managedElementId = "kista_1";
- addRic(ricName, managedElementId);
-
- String url = "/ric?managedElementId=" + managedElementId;
- String rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo(ricName);
-
- // test GET RIC for ManagedElement that does not exist
- url = "/ric?managedElementId=" + "junk";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- private String putPolicyUrl(String serviceName, String ricName, String policyTypeName, String policyInstanceId,
- boolean isTransient) {
- String url;
- if (policyTypeName.isEmpty()) {
- url = "/policy?id=" + policyInstanceId + "&ric=" + ricName + "&service=" + serviceName;
- } else {
- url = "/policy?id=" + policyInstanceId + "&ric=" + ricName + "&service=" + serviceName + "&type="
- + policyTypeName;
- }
- if (isTransient) {
- url += "&transient=true";
- }
- return url;
- }
-
- private String putPolicyUrl(String serviceName, String ricName, String policyTypeName, String policyInstanceId) {
- return putPolicyUrl(serviceName, ricName, policyTypeName, policyInstanceId, false);
- }
-
- @Test
- void testPutPolicy() throws Exception {
- String serviceName = "service1";
- String ricName = "ric1";
- String policyTypeName = "type1";
- String policyInstanceId = "instance1";
-
- putService(serviceName);
- addPolicyType(policyTypeName, ricName);
-
- // PUT a transient policy
- String url = putPolicyUrl(serviceName, ricName, policyTypeName, policyInstanceId, true);
- final String policyBody = jsonString();
- this.rics.getRic(ricName).setState(Ric.RicState.AVAILABLE);
-
- restClient().put(url, policyBody).block();
-
- Policy policy = policies.getPolicy(policyInstanceId);
- assertThat(policy).isNotNull();
- assertThat(policy.getId()).isEqualTo(policyInstanceId);
- assertThat(policy.getOwnerServiceId()).isEqualTo(serviceName);
- assertThat(policy.getRic().id()).isEqualTo("ric1");
- assertThat(policy.isTransient()).isTrue();
-
- // Put a non transient policy
- url = putPolicyUrl(serviceName, ricName, policyTypeName, policyInstanceId);
- restClient().put(url, policyBody).block();
- policy = policies.getPolicy(policyInstanceId);
- assertThat(policy.isTransient()).isFalse();
-
- url = "/policies";
- String rsp = restClient().get(url).block();
- assertThat(rsp).as("Response contains policy instance ID.").contains(policyInstanceId);
-
- url = "/policy?id=" + policyInstanceId;
- rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo(policyBody);
-
- // Test of error codes
- url = putPolicyUrl(serviceName, ricName + "XX", policyTypeName, policyInstanceId);
- testErrorCode(restClient().put(url, policyBody), HttpStatus.NOT_FOUND);
-
- url = putPolicyUrl(serviceName, ricName, policyTypeName + "XX", policyInstanceId);
- addPolicyType(policyTypeName + "XX", "otherRic");
- testErrorCode(restClient().put(url, policyBody), HttpStatus.NOT_FOUND);
-
- url = putPolicyUrl(serviceName, ricName, policyTypeName, policyInstanceId);
- this.rics.getRic(ricName).setState(Ric.RicState.SYNCHRONIZING);
- testErrorCode(restClient().put(url, policyBody), HttpStatus.LOCKED);
- this.rics.getRic(ricName).setState(Ric.RicState.AVAILABLE);
- }
-
- @Test
- /**
- * Test that HttpStatus and body from failing REST call to A1 is passed on to
- * the caller.
- *
- * @throws ServiceException
- */
- void testErrorFromRic() throws ServiceException {
- putService("service1");
- addPolicyType("type1", "ric1");
-
- String url = putPolicyUrl("service1", "ric1", "type1", "id1");
- MockA1Client a1Client = a1ClientFactory.getOrCreateA1Client("ric1");
- HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;
- String responseBody = "Refused";
- byte[] responseBodyBytes = responseBody.getBytes(StandardCharsets.UTF_8);
-
- WebClientResponseException a1Exception = new WebClientResponseException(httpStatus.value(), "statusText", null,
- responseBodyBytes, StandardCharsets.UTF_8, null);
- doReturn(Mono.error(a1Exception)).when(a1Client).putPolicy(any());
-
- // PUT Policy
- testErrorCode(restClient().put(url, "{}"), httpStatus, responseBody);
-
- // DELETE POLICY
- this.addPolicy("instance1", "type1", "service1", "ric1");
- doReturn(Mono.error(a1Exception)).when(a1Client).deletePolicy(any());
- testErrorCode(restClient().delete("/policy?id=instance1"), httpStatus, responseBody);
-
- // GET STATUS
- this.addPolicy("instance1", "type1", "service1", "ric1");
- doReturn(Mono.error(a1Exception)).when(a1Client).getPolicyStatus(any());
- testErrorCode(restClient().get("/policy_status?id=instance1"), httpStatus, responseBody);
-
- // Check that empty response body is OK
- a1Exception = new WebClientResponseException(httpStatus.value(), "", null, null, null, null);
- doReturn(Mono.error(a1Exception)).when(a1Client).getPolicyStatus(any());
- testErrorCode(restClient().get("/policy_status?id=instance1"), httpStatus);
- }
-
- @Test
- void testPutTypelessPolicy() throws Exception {
- putService("service1");
- addPolicyType("", "ric1");
- String url = putPolicyUrl("service1", "ric1", "", "id1");
- restClient().put(url, jsonString()).block();
-
- String rsp = restClient().get("/policies").block();
- List<PolicyInfo> info = parseList(rsp, PolicyInfo.class);
- assertThat(info).hasSize(1);
- PolicyInfo policyInfo = info.get(0);
- assertThat(policyInfo.id).isEqualTo("id1");
- assertThat(policyInfo.type).isEmpty();
- }
-
- @Test
- void testRefuseToUpdatePolicy() throws Exception {
- // Test that only the json can be changed for a already created policy
- // In this case service is attempted to be changed
- this.addRic("ric1");
- this.addRic("ricXXX");
- this.addPolicy("instance1", "type1", "service1", "ric1");
- this.addPolicy("instance2", "type1", "service1", "ricXXX");
-
- // Try change ric1 -> ricXXX
- String urlWrongRic = putPolicyUrl("service1", "ricXXX", "type1", "instance1");
- testErrorCode(restClient().put(urlWrongRic, jsonString()), HttpStatus.CONFLICT);
- }
-
- @Test
- void testGetPolicy() throws Exception {
- String url = "/policy?id=id";
- Policy policy = addPolicy("id", "typeName", "service1", "ric1");
- {
- String rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo(policy.getJson());
- }
- {
- policies.remove(policy);
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
- }
-
- @Test
- void testDeletePolicy() throws Exception {
- addPolicy("id", "typeName", "service1", "ric1");
- assertThat(policies.size()).isEqualTo(1);
-
- String url = "/policy?id=id";
- ResponseEntity<String> entity = restClient().deleteForEntity(url).block();
-
- assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.NO_CONTENT);
- assertThat(policies.size()).isZero();
-
- // Delete a non existing policy
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testGetPolicySchemas() throws Exception {
- addPolicyType("type1", "ric1");
- addPolicyType("type2", "ric2");
-
- String url = "/policy_schemas";
- String rsp = this.restClient().get(url).block();
- assertThat(rsp).contains("type1") //
- .contains("{\"title\":\"type2\"}");
-
- List<String> info = parseSchemas(rsp);
- assertThat(info).hasSize(2);
-
- url = "/policy_schemas?ric=ric1";
- rsp = restClient().get(url).block();
- assertThat(rsp).contains("type1");
- info = parseSchemas(rsp);
- assertThat(info).hasSize(1);
-
- // Get schema for non existing RIC
- url = "/policy_schemas?ric=ric1XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testGetPolicySchema() throws Exception {
- addPolicyType("type1", "ric1");
- addPolicyType("type2", "ric2");
-
- String url = "/policy_schema?id=type1";
- String rsp = restClient().get(url).block();
- logger.info(rsp);
- assertThat(rsp).contains("type1") //
- .contains("title");
-
- // Get non existing schema
- url = "/policy_schema?id=type1XX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testGetPolicyTypes() throws Exception {
- addPolicyType("type1", "ric1");
- addPolicyType("type2", "ric2");
-
- String url = "/policy_types";
- String rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo("[\"type2\",\"type1\"]");
-
- url = "/policy_types?ric=ric1";
- rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo("[\"type1\"]");
-
- // Get policy types for non existing RIC
- url = "/policy_types?ric=ric1XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testGetPolicies() throws Exception {
- addPolicy("id1", "type1", "service1");
-
- String url = "/policies";
- String rsp = restClient().get(url).block();
- logger.info(rsp);
- List<PolicyInfo> info = parseList(rsp, PolicyInfo.class);
- assertThat(info).hasSize(1);
- PolicyInfo policyInfo = info.get(0);
- assert (policyInfo.validate());
- assertThat(policyInfo.id).isEqualTo("id1");
- assertThat(policyInfo.type).isEqualTo("type1");
- assertThat(policyInfo.service).isEqualTo("service1");
- }
-
- @Test
- void testGetPoliciesFilter() throws Exception {
- addPolicy("id1", "type1", "service1");
- addPolicy("id2", "type1", "service2");
- addPolicy("id3", "type2", "service1");
-
- String url = "/policies?type=type1";
- String rsp = restClient().get(url).block();
- logger.info(rsp);
- assertThat(rsp).contains("id1") //
- .contains("id2") //
- .doesNotContain("id3");
-
- url = "/policies?type=type1&service=service2";
- rsp = restClient().get(url).block();
- logger.info(rsp);
- assertThat(rsp).doesNotContain("id1") //
- .contains("id2") //
- .doesNotContain("id3");
-
- // Test get policies for non existing type
- url = "/policies?type=type1XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
-
- // Test get policies for non existing RIC
- url = "/policies?ric=XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testGetPolicyIdsFilter() throws Exception {
- addPolicy("id1", "type1", "service1", "ric1");
- addPolicy("id2", "type1", "service2", "ric1");
- addPolicy("id3", "type2", "service1", "ric1");
-
- String url = "/policy_ids?type=type1";
- String rsp = restClient().get(url).block();
- logger.info(rsp);
- assertThat(rsp).contains("id1") //
- .contains("id2") //
- .doesNotContain("id3");
-
- url = "/policy_ids?type=type1&service=service1&ric=ric1";
- rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo("[\"id1\"]");
-
- // Test get policy ids for non existing type
- url = "/policy_ids?type=type1XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
-
- // Test get policy ids for non existing RIC
- url = "/policy_ids?ric=XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testPutAndGetService() throws Exception {
- // PUT
- String serviceName = "name";
- putService(serviceName, 0, HttpStatus.CREATED);
- putService(serviceName, 0, HttpStatus.OK);
-
- // GET one service
- String url = "/services?name=name";
- String rsp = restClient().get(url).block();
- List<ServiceStatus> info = parseList(rsp, ServiceStatus.class);
- assertThat(info).hasSize(1);
- ServiceStatus status = info.iterator().next();
- assertThat(status.keepAliveIntervalSeconds).isZero();
- assertThat(status.serviceName).isEqualTo(serviceName);
-
- // GET (all)
- url = "/services";
- rsp = restClient().get(url).block();
- assertThat(rsp).as("Response contains service name").contains(serviceName);
- logger.info(rsp);
-
- // Keep alive
- url = "/services/keepalive?name=name";
- ResponseEntity<String> entity = restClient().putForEntity(url).block();
- assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
-
- // DELETE service
- assertThat(services.size()).isEqualTo(1);
- url = "/services?name=name";
- restClient().delete(url).block();
- assertThat(services.size()).isZero();
-
- // Keep alive, no registered service
- testErrorCode(restClient().put("/services/keepalive?name=name", ""), HttpStatus.NOT_FOUND);
-
- // PUT servive with bad payload
- testErrorCode(restClient().put("/service", "crap"), HttpStatus.BAD_REQUEST);
- testErrorCode(restClient().put("/service", "{}"), HttpStatus.BAD_REQUEST);
- testErrorCode(restClient().put("/service", createServiceJson(serviceName, -123)), HttpStatus.BAD_REQUEST);
- testErrorCode(restClient().put("/service", createServiceJson(serviceName, 0, "missing.portandprotocol.com")),
- HttpStatus.BAD_REQUEST);
-
- // GET non existing service
- testErrorCode(restClient().get("/services?name=XXX"), HttpStatus.NOT_FOUND);
- }
-
- @Test
- void testServiceSupervision() throws Exception {
- putService("service1", 1, HttpStatus.CREATED);
- addPolicyType("type1", "ric1");
-
- String url = putPolicyUrl("service1", "ric1", "type1", "instance1");
- final String policyBody = jsonString();
- restClient().put(url, policyBody).block();
-
- assertThat(policies.size()).isEqualTo(1);
- assertThat(services.size()).isEqualTo(1);
-
- // Timeout after ~1 second
- await().untilAsserted(() -> assertThat(policies.size()).isZero());
- assertThat(services.size()).isZero();
- }
-
- @Test
- void testGetPolicyStatus() throws Exception {
- addPolicy("id", "typeName", "service1", "ric1");
- assertThat(policies.size()).isEqualTo(1);
-
- String url = "/policy_status?id=id";
- String rsp = restClient().get(url).block();
- assertThat(rsp).isEqualTo("OK");
-
- // GET non existing policy status
- url = "/policy_status?id=XXX";
- testErrorCode(restClient().get(url), HttpStatus.NOT_FOUND);
- }
-
- private Policy addPolicy(String id, String typeName, String service, String ric) throws ServiceException {
- addRic(ric);
- Policy policy = Policy.builder() //
- .id(id) //
- .json(jsonString()) //
- .ownerServiceId(service) //
- .ric(rics.getRic(ric)) //
- .type(addPolicyType(typeName, ric)) //
- .lastModified(Instant.now()) //
- .isTransient(false) //
- .statusNotificationUri("/policy_status?id=XXX") //
- .build();
- policies.put(policy);
- return policy;
- }
-
- private Policy addPolicy(String id, String typeName, String service) throws ServiceException {
- return addPolicy(id, typeName, service, "ric");
- }
-
- private String createServiceJson(String name, long keepAliveIntervalSeconds) {
- return createServiceJson(name, keepAliveIntervalSeconds, "https://examples.javacodegeeks.com/core-java/");
- }
-
- private String createServiceJson(String name, long keepAliveIntervalSeconds, String url) {
- ServiceRegistrationInfo service = new ServiceRegistrationInfo(name, keepAliveIntervalSeconds, url);
-
- String json = gson.toJson(service);
- return json;
- }
-
- private void putService(String name) {
- putService(name, 0, null);
- }
-
- private void putService(String name, long keepAliveIntervalSeconds, @Nullable HttpStatus expectedStatus) {
- String url = "/service";
- String body = createServiceJson(name, keepAliveIntervalSeconds);
- ResponseEntity<String> resp = restClient().putForEntity(url, body).block();
- if (expectedStatus != null) {
- assertEquals(expectedStatus, resp.getStatusCode(), "");
- }
- }
-
- private String baseUrl() {
- return "https://localhost:" + port;
- }
-
- private String jsonString() {
- return "{\"servingCellNrcgi\":\"1\"}";
- }
-
- private AsyncRestClient restClient(boolean useTrustValidation) {
- WebClientConfig config = this.applicationConfig.getWebClientConfig();
- config = ImmutableWebClientConfig.builder() //
- .keyStoreType(config.keyStoreType()) //
- .keyStorePassword(config.keyStorePassword()) //
- .keyStore(config.keyStore()) //
- .keyPassword(config.keyPassword()) //
- .isTrustStoreUsed(useTrustValidation) //
- .trustStore(config.trustStore()) //
- .trustStorePassword(config.trustStorePassword()) //
- .httpProxyConfig(config.httpProxyConfig()) //
- .build();
-
- AsyncRestClientFactory f = new AsyncRestClientFactory(config);
- return f.createRestClientNoHttpProxy(baseUrl());
- }
-
- private AsyncRestClient restClient() {
- return restClient(false);
- }
-
- private void testErrorCode(Mono<?> request, HttpStatus expStatus) {
- testErrorCode(request, expStatus, "");
- }
-
- private void testErrorCode(Mono<?> request, HttpStatus expStatus, String responseContains) {
- StepVerifier.create(request) //
- .expectSubscription() //
- .expectErrorMatches(t -> checkWebClientError(t, expStatus, responseContains)) //
- .verify();
- }
-
- private boolean checkWebClientError(Throwable throwable, HttpStatus expStatus, String responseContains) {
- assertTrue(throwable instanceof WebClientResponseException);
- WebClientResponseException responseException = (WebClientResponseException) throwable;
- assertThat(responseException.getStatusCode()).isEqualTo(expStatus);
- assertThat(responseException.getResponseBodyAsString()).contains(responseContains);
- return true;
- }
-
- private MockA1Client getA1Client(String ricName) throws ServiceException {
- return a1ClientFactory.getOrCreateA1Client(ricName);
- }
-
- private PolicyType createPolicyType(String policyTypeName) {
- return PolicyType.builder() //
- .id(policyTypeName) //
- .schema("{\"title\":\"" + policyTypeName + "\"}") //
- .build();
- }
-
- private PolicyType addPolicyType(String policyTypeName, String ricName) {
- PolicyType type = createPolicyType(policyTypeName);
- policyTypes.put(type);
- addRic(ricName).addSupportedPolicyType(type);
- return type;
- }
-
- private Ric addRic(String ricName) {
- return addRic(ricName, null);
- }
-
- private Ric addRic(String ricName, String managedElement) {
- if (rics.get(ricName) != null) {
- return rics.get(ricName);
- }
- List<String> mes = new ArrayList<>();
- if (managedElement != null) {
- mes.add(managedElement);
- }
- RicConfig conf = ImmutableRicConfig.builder() //
- .ricId(ricName) //
- .baseUrl(ricName) //
- .managedElementIds(mes) //
- .controllerName("") //
- .build();
- Ric ric = new Ric(conf);
- ric.setState(Ric.RicState.AVAILABLE);
- this.rics.put(ric);
- return ric;
- }
-
- private static <T> List<T> parseList(String jsonString, Class<T> clazz) {
- List<T> result = new ArrayList<>();
- JsonArray jsonArr = JsonParser.parseString(jsonString).getAsJsonArray();
- for (JsonElement jsonElement : jsonArr) {
- T json = gson.fromJson(jsonElement.toString(), clazz);
- result.add(json);
- }
- return result;
- }
-
- private static List<String> parseSchemas(String jsonString) {
- JsonArray arrayOfSchema = JsonParser.parseString(jsonString).getAsJsonArray();
- List<String> result = new ArrayList<>();
- for (JsonElement schemaObject : arrayOfSchema) {
- result.add(schemaObject.toString());
- }
- return result;
- }
-}
assertThat(info.status).hasToString("{}");
}
+ @Test
+ void testGetServiceStatus() throws Exception {
+ String url = "/status";
+ String rsp = restClient().get(url).block();
+ assertThat(rsp).contains("hunky dory");
+
+ rsp = restClient(baseUrl(), false).get(url).block(); // V1 status is used by a readinessProbe
+ assertThat(rsp).isEqualTo("hunky dory");
+ }
+
@Test
void testServiceNotification() throws ServiceException {
putService("junkService");
"type": "string"
}}
},
- "policy_info_v1": {
- "type": "object",
- "properties": {
- "service": {
- "description": "the name of the service owning the policy",
- "type": "string"
- },
- "json": {
- "description": "the configuration of the policy",
- "type": "object"
- },
- "id": {
- "description": "identity of the policy",
- "type": "string"
- },
- "lastModified": {
- "description": "timestamp, last modification time",
- "type": "string"
- },
- "type": {
- "description": "name of the policy type",
- "type": "string"
- },
- "ric": {
- "description": "identity of the target Near-RT RIC",
- "type": "string"
- }
- }
- },
- "service_registration_info_v1": {
- "type": "object",
- "properties": {
- "keepAliveIntervalSeconds": {
- "format": "int64",
- "description": "keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intevals must invoke a 'keepAlive' REST call. When a service does not invoke this call within the given time, it is considered unavailble. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.",
- "type": "integer"
- },
- "callbackUrl": {
- "description": "callback for notifying of RIC synchronization",
- "type": "string"
- },
- "serviceName": {"type": "string"}
- }
- },
"ric_info_v2": {
"description": "Information for a Near-RT RIC",
"type": "object",
"items": {"$ref": "#/components/schemas/policy_info_v2"}
}}
},
- "ric_info_v1": {
- "type": "object",
- "properties": {
- "managedElementIds": {
- "description": "O1 identities for managed entities",
- "type": "array",
- "items": {
- "description": "O1 identities for managed entities",
- "type": "string"
- }
- },
- "policyTypes": {
- "description": "supported policy types",
- "type": "array",
- "items": {
- "description": "supported policy types",
- "type": "string"
- }
- },
- "state": {
- "description": "state info",
- "type": "string"
- },
- "ricName": {
- "description": "identity of the Near-RT RIC",
- "type": "string"
- }
- }
- },
- "service_status_v1": {
- "type": "object",
- "properties": {
- "keepAliveIntervalSeconds": {
- "format": "int64",
- "description": "policy keep alive timeout",
- "type": "integer"
- },
- "timeSinceLastActivitySeconds": {
- "format": "int64",
- "description": "time since last invocation by the service",
- "type": "integer"
- },
- "callbackUrl": {
- "description": "callback for notifying of RIC synchronization",
- "type": "string"
- },
- "serviceName": {
- "description": "identity of the service",
- "type": "string"
- }
- }
- },
"policy_status_info_v2": {
"description": "Status for one A1-P Policy",
"type": "object",
}},
"openapi": "3.0.1",
"paths": {
- "/policy_types": {"get": {
- "summary": "Query policy type identities",
- "operationId": "getPolicyTypes",
- "responses": {
- "200": {
- "description": "Policy type identities",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"type": "string"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get types for.",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/policy-instances": {"get": {
"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 are returned.",
}},
"/a1-policy/v2/status": {"get": {
"summary": "Returns status and statistics of this service",
- "operationId": "getStatus_1",
+ "operationId": "getStatus",
"responses": {"200": {
"description": "Service is living",
"content": {"application/json": {"schema": {"$ref": "#/components/schemas/status_info_v2"}}}
}},
"/actuator/threaddump": {"get": {
"summary": "Actuator web endpoint 'threaddump'",
- "operationId": "handle_2_1_3",
+ "operationId": "threaddump_4",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
}},
"tags": ["Actuator"]
}},
- "/services": {
- "get": {
- "summary": "Returns service information",
- "operationId": "getServices",
- "responses": {
- "200": {
- "description": "OK",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"$ref": "#/components/schemas/service_status_v1"}
- }}}
- },
- "404": {
- "description": "Service is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "name",
- "description": "The name of the service",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- },
- "delete": {
- "summary": "Unregister a service",
- "operationId": "deleteService",
- "responses": {
- "204": {
- "description": "Service unregistered",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "404": {
- "description": "Service not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "name",
- "description": "The name of the service",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }
- },
"/a1-policy/v2/rics/ric": {"get": {
"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": "getRic_1",
+ "operationId": "getRic",
"responses": {
"200": {
"description": "Near-RT RIC is found",
}},
"/actuator/loggers": {"get": {
"summary": "Actuator web endpoint 'loggers'",
- "operationId": "handle_6",
+ "operationId": "loggers_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
}},
"/actuator/health/**": {"get": {
"summary": "Actuator web endpoint 'health-path'",
- "operationId": "handle_12",
+ "operationId": "health-path_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
}},
"/a1-policy/v2/policy-types": {"get": {
"summary": "Query policy type identities",
- "operationId": "getPolicyTypes_1",
+ "operationId": "getPolicyTypes",
"responses": {
"200": {
"description": "Policy type IDs",
"/a1-policy/v2/policies/{policy_id}": {
"get": {
"summary": "Returns a policy",
- "operationId": "getPolicy_1",
+ "operationId": "getPolicy",
"responses": {
"200": {
"description": "Policy found",
},
"delete": {
"summary": "Delete a policy",
- "operationId": "deletePolicy_1",
+ "operationId": "deletePolicy",
"responses": {
"200": {
"description": "Not used",
},
"/actuator/metrics/{requiredMetricName}": {"get": {
"summary": "Actuator web endpoint 'metrics-requiredMetricName'",
- "operationId": "handle_5",
+ "operationId": "metrics-requiredMetricName_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
"tags": ["Management of configuration"]
}
},
- "/policy": {
- "get": {
- "summary": "Returns a policy configuration",
- "operationId": "getPolicy",
- "responses": {
- "200": {
- "description": "Policy found",
- "content": {"*/*": {"schema": {"type": "object"}}}
- },
- "404": {
- "description": "Policy is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy instance.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- },
- "delete": {
- "summary": "Delete a policy",
- "operationId": "deletePolicy",
- "responses": {
- "200": {
- "description": "Not used",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "423": {
- "description": "Near-RT RIC is not operational",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "204": {
- "description": "Policy deleted",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "404": {
- "description": "Policy is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy instance.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- },
- "put": {
- "summary": "Put a policy",
- "requestBody": {
- "content": {"application/json": {"schema": {"type": "object"}}},
- "required": true
- },
- "operationId": "putPolicy",
- "responses": {
- "200": {
- "description": "Policy updated",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "201": {
- "description": "Policy created",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
- },
- "423": {
- "description": "Near-RT RIC is not operational",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "404": {
- "description": "Near-RT RIC or policy type is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [
- {
- "schema": {
- "default": "",
- "type": "string"
- },
- "in": "query",
- "name": "type",
- "description": "The name of the policy type.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy instance.",
- "required": true
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC where the policy will be created.",
- "required": true
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "service",
- "description": "The name of the service creating the policy.",
- "required": true
- },
- {
- "schema": {
- "default": false,
- "type": "boolean"
- },
- "in": "query",
- "name": "transient",
- "description": "If the policy is transient or not (boolean defaulted to false). A policy is transient if it will be forgotten when the service needs to reconnect to the Near-RT RIC.",
- "required": false
- }
- ],
- "tags": ["A1 Policy Management V1.0"]
- }
- },
"/actuator": {"get": {
"summary": "Actuator root web endpoint",
"operationId": "links_1",
}},
"tags": ["Actuator"]
}},
- "/policies": {"get": {
- "summary": "Query policies",
- "operationId": "getPolicies",
- "responses": {
- "200": {
- "description": "Policies",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"$ref": "#/components/schemas/policy_info_v1"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC or type not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "type",
- "description": "The name of the policy type to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "service",
- "description": "The name of the service to get policies for.",
- "required": false
- }
- ],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/actuator/loggers/{name}": {
"post": {
"summary": "Actuator web endpoint 'loggers-name'",
- "operationId": "handle_0",
+ "operationId": "loggers-name_3",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
},
"get": {
"summary": "Actuator web endpoint 'loggers-name'",
- "operationId": "handle_7",
+ "operationId": "loggers-name_4",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
"/a1-policy/v2/services/{service_id}/keepalive": {"put": {
"summary": "Heartbeat indicates that the service is running",
"description": "A registerred service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that teh service will be deregisterred and all its policies are removed.",
- "operationId": "keepAliveService_1",
+ "operationId": "keepAliveService",
"responses": {
"200": {
"description": "Service supervision timer refreshed, OK",
}],
"tags": ["Service Registry and Supervision"]
}},
- "/rics": {"get": {
- "summary": "Query Near-RT RIC information",
- "operationId": "getRics",
- "responses": {
- "200": {
- "description": "OK",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"$ref": "#/components/schemas/ric_info_v1"}
- }}}
- },
- "404": {
- "description": "Policy type is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "policyType",
- "description": "The name of the policy type",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
- "/policy_schema": {"get": {
- "summary": "Returns one policy type schema definition",
- "operationId": "getPolicySchema",
- "responses": {
- "200": {
- "description": "Policy schema",
- "content": {"*/*": {"schema": {"type": "object"}}}
- },
- "404": {
- "description": "The policy type is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy type to get the definition for.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/actuator/metrics": {"get": {
"summary": "Actuator web endpoint 'metrics'",
- "operationId": "handle_4",
+ "operationId": "metrics_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
}},
"tags": ["Actuator"]
}},
- "/policy_status": {"get": {
- "summary": "Returns a policy status",
- "operationId": "getPolicyStatus",
- "responses": {
- "200": {
- "description": "Policy status",
- "content": {"*/*": {"schema": {"type": "object"}}}
- },
- "404": {
- "description": "Policy is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "id",
- "description": "The identity of the policy.",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/rics": {"get": {
"summary": "Query Near-RT RIC information",
"description": "The call returns all Near-RT RICs that supports a given policy type identity",
- "operationId": "getRics_1",
+ "operationId": "getRics",
"responses": {
"200": {
"description": "OK",
}],
"tags": ["NearRT-RIC Repository"]
}},
- "/policy_schemas": {"get": {
- "summary": "Returns policy type schema definitions",
- "operationId": "getPolicySchemas",
- "responses": {
- "200": {
- "description": "Policy schemas",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"type": "object"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get the definitions for.",
- "required": false
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
- "/policy_ids": {"get": {
- "summary": "Query policies, only policy identities returned",
- "operationId": "getPolicyIds",
- "responses": {
- "200": {
- "description": "Policy identitiess",
- "content": {"*/*": {"schema": {
- "type": "array",
- "items": {"type": "string"}
- }}}
- },
- "404": {
- "description": "Near-RT RIC or type not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "type",
- "description": "The name of the policy type to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric",
- "description": "The name of the Near-RT RIC to get policies for.",
- "required": false
- },
- {
- "schema": {"type": "string"},
- "in": "query",
- "name": "service",
- "description": "The name of the service to get policies for.",
- "required": false
- }
- ],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/services": {
"get": {
"summary": "Returns service information",
"description": "Either information about a registered service with given identity or all registered services are returned.",
- "operationId": "getServices_1",
+ "operationId": "getServices",
"responses": {
"200": {
"description": "OK",
"required": true
},
"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": "putService_1",
+ "operationId": "putService",
"responses": {
"200": {
"description": "Service updated",
},
"/actuator/info": {"get": {
"summary": "Actuator web endpoint 'info'",
- "operationId": "handle_9",
+ "operationId": "info_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
}},
"tags": ["Actuator"]
}},
- "/ric": {"get": {
- "summary": "Returns the name of a RIC managing one Mananged Element",
- "operationId": "getRic",
- "responses": {
- "200": {
- "description": "Near-RT RIC is found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "404": {
- "description": "Near-RT RIC is not found",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "managedElementId",
- "description": "The identity of the Managed Element",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
- "/services/keepalive": {"put": {
- "summary": "Heartbeat from a service",
- "operationId": "keepAliveService",
- "responses": {
- "200": {
- "description": "Service supervision timer refreshed, OK",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "404": {
- "description": "The service is not found, needs re-registration",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "name",
- "description": "The name of the service",
- "required": true
- }],
- "tags": ["A1 Policy Management V1.0"]
- }},
"/status": {"get": {
"summary": "Returns status and statistics of this service",
- "operationId": "getStatus",
+ "operationId": "getStatusV1",
"responses": {"200": {
"description": "Service is living",
"content": {"*/*": {"schema": {"type": "string"}}}
}},
- "tags": ["A1 Policy Management V1.0"]
+ "tags": ["Health Check"]
}},
"/a1-policy/v2/policy-types/{policytype_id}": {"get": {
"summary": "Returns a policy type definition",
}},
"/actuator/logfile": {"get": {
"summary": "Actuator web endpoint 'logfile'",
- "operationId": "handle_8",
+ "operationId": "logfile_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
}},
"/actuator/health": {"get": {
"summary": "Actuator web endpoint 'health'",
- "operationId": "handle_11",
+ "operationId": "health_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
"get": {
"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": "getPolicyIds_1",
+ "operationId": "getPolicyIds",
"responses": {
"200": {
"description": "Policy identities",
"content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}},
"required": true
},
- "operationId": "putPolicy_1",
+ "operationId": "putPolicy",
"responses": {
"200": {
"description": "Policy updated",
}},
"tags": ["Callbacks"]
}},
- "/service": {"put": {
- "summary": "Register a service",
- "requestBody": {
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_registration_info_v1"}}},
- "required": true
- },
- "operationId": "putService",
- "responses": {
- "200": {
- "description": "Service updated",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "201": {
- "description": "Service created",
- "content": {"*/*": {"schema": {"type": "string"}}}
- },
- "400": {
- "description": "The ServiceRegistrationInfo is not accepted",
- "content": {"*/*": {"schema": {"type": "string"}}}
- }
- },
- "tags": ["A1 Policy Management V1.0"]
- }},
"/a1-policy/v2/services/{service_id}": {"delete": {
"summary": "Unregister a service",
- "operationId": "deleteService_1",
+ "operationId": "deleteService",
"responses": {
"200": {
"description": "Not used",
}},
"/a1-policy/v2/policies/{policy_id}/status": {"get": {
"summary": "Returns a policy status",
- "operationId": "getPolicyStatus_1",
+ "operationId": "getPolicyStatus",
"responses": {
"200": {
"description": "Policy status",
}},
"/actuator/heapdump": {"get": {
"summary": "Actuator web endpoint 'heapdump'",
- "operationId": "handle_10",
+ "operationId": "heapdump_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
},
"info": {
"license": {
- "name": "Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.",
+ "name": "Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"description": "<h2>General<\/h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. <br/>The main tasks of the service are:<\/p><ul><li>A1 Policy creation, modification and deletion.<\/li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs<\/li><li>Maintaining a view of supported Near-RT RIC policy types<\/li><li>Supervision of using services (R-APPs). When a service is unavailble, its policies are removed.<\/li><\/ul><h2>APIs provided by the service<\/h2><h3>A1 Policy Management<\/h3><p>This is an API for management of A1 Policies.<\/p><ul><li>A1 Policy retrieval, creation, modification and deletion.<\/li><li>Retrieval of supported A1 Policy types for a Near-RT RIC<\/li><li>Retrieval of status for existing A1 policies<\/li><\/ul><h3>Management of configuration<\/h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.<\/p><h3>Callbacks<\/h3><p>These are endpoints that are invoked by this service. The callbacks are registerred in this service at service registration.<\/p><h3>NearRT-RIC Repository<\/h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.<\/p><h3>Health Check<\/h3><p>API used for supervision of the PMS component.<\/p><h3>Service Registry and Supervision<\/h3><p>API used for registerring services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registerred service and will automatically remove policies for unavailable services.<\/p>",
"version": "1.1.0"
},
"tags": [
- {
- "name": "A1 Policy Management V1.0",
- "description": "(deprecated primitves)"
- },
- {"name": "Management of configuration"},
+ {"name": "Service Registry and Supervision"},
{"name": "A1 Policy Management"},
{"name": "NearRT-RIC Repository"},
- {"name": "Service Registry and Supervision"},
- {"name": "Health Check"},
{"name": "Callbacks"},
+ {"name": "Health Check"},
+ {"name": "Management of configuration"},
{
"name": "Actuator",
"description": "Monitor and interact",
Each A1 policy is owned by a service. PMS can supervise each registerred service
and will automatically remove policies for unavailable services.</p>
license:
- name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.
+ name: Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.
url: http://www.apache.org/licenses/LICENSE-2.0
version: 1.1.0
servers:
- url: /
tags:
-- name: A1 Policy Management V1.0
- description: (deprecated primitves)
-- name: Management of configuration
+- name: Service Registry and Supervision
- name: A1 Policy Management
- name: NearRT-RIC Repository
-- name: Service Registry and Supervision
-- name: Health Check
- name: Callbacks
+- name: Health Check
+- name: Management of configuration
- name: Actuator
description: Monitor and interact
externalDocs:
description: Spring Boot Actuator Web API Documentation
url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
paths:
- /policy_types:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query policy type identities
- operationId: getPolicyTypes
- parameters:
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get types for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy type identities
- content:
- '*/*':
- schema:
- type: array
- items:
- type: string
- 404:
- description: Near-RT RIC is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
/a1-policy/v2/policy-instances:
get:
tags:
tags:
- Health Check
summary: Returns status and statistics of this service
- operationId: getStatus_1
+ operationId: getStatus
responses:
200:
description: Service is living
tags:
- Actuator
summary: Actuator web endpoint 'threaddump'
- operationId: handle_2_1_3
+ operationId: threaddump_4
responses:
200:
description: OK
'*/*':
schema:
type: object
- /services:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns service information
- operationId: getServices
- parameters:
- - name: name
- in: query
- description: The name of the service
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/service_status_v1'
- 404:
- description: Service is not found
- content:
- '*/*':
- schema:
- type: string
- delete:
- tags:
- - A1 Policy Management V1.0
- summary: Unregister a service
- operationId: deleteService
- parameters:
- - name: name
- in: query
- description: The name of the service
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 204:
- description: Service unregistered
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 404:
- description: Service not found
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/rics/ric:
get:
tags:
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: getRic_1
+ operationId: getRic
parameters:
- name: managed_element_id
in: query
tags:
- Actuator
summary: Actuator web endpoint 'loggers'
- operationId: handle_6
+ operationId: loggers_2
responses:
200:
description: OK
tags:
- Actuator
summary: Actuator web endpoint 'health-path'
- operationId: handle_12
+ operationId: health-path_2
responses:
200:
description: OK
tags:
- A1 Policy Management
summary: Query policy type identities
- operationId: getPolicyTypes_1
+ operationId: getPolicyTypes
parameters:
- name: ric_id
in: query
tags:
- A1 Policy Management
summary: Returns a policy
- operationId: getPolicy_1
+ operationId: getPolicy
parameters:
- name: policy_id
in: path
tags:
- A1 Policy Management
summary: Delete a policy
- operationId: deletePolicy_1
+ operationId: deletePolicy
parameters:
- name: policy_id
in: path
tags:
- Actuator
summary: Actuator web endpoint 'metrics-requiredMetricName'
- operationId: handle_5
+ operationId: metrics-requiredMetricName_2
parameters:
- name: requiredMetricName
in: path
'*/*':
schema:
$ref: '#/components/schemas/error_information'
- /policy:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns a policy configuration
- operationId: getPolicy
- parameters:
- - name: id
- in: query
- description: The identity of the policy instance.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy found
- content:
- '*/*':
- schema:
- type: object
- 404:
- description: Policy is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- put:
- tags:
- - A1 Policy Management V1.0
- summary: Put a policy
- operationId: putPolicy
- parameters:
- - name: type
- in: query
- description: The name of the policy type.
- required: false
- style: form
- explode: true
- schema:
- type: string
- default: ""
- - name: id
- in: query
- description: The identity of the policy instance.
- required: true
- style: form
- explode: true
- schema:
- type: string
- - name: ric
- in: query
- description: The name of the Near-RT RIC where the policy will be created.
- required: true
- style: form
- explode: true
- schema:
- type: string
- - name: service
- in: query
- description: The name of the service creating the policy.
- required: true
- style: form
- explode: true
- schema:
- type: string
- - name: transient
- in: query
- description: If the policy is transient or not (boolean defaulted to false).
- A policy is transient if it will be forgotten when the service needs to
- reconnect to the Near-RT RIC.
- required: false
- style: form
- explode: true
- schema:
- type: boolean
- default: false
- requestBody:
- content:
- application/json:
- schema:
- type: object
- required: true
- responses:
- 200:
- description: Policy updated
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 201:
- description: Policy created
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 423:
- description: Near-RT RIC is not operational
- content:
- '*/*':
- schema:
- type: string
- 404:
- description: Near-RT RIC or policy type is not found
- content:
- '*/*':
- schema:
- type: string
- delete:
- tags:
- - A1 Policy Management V1.0
- summary: Delete a policy
- operationId: deletePolicy
- parameters:
- - name: id
- in: query
- description: The identity of the policy instance.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Not used
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 423:
- description: Near-RT RIC is not operational
- content:
- '*/*':
- schema:
- type: string
- 204:
- description: Policy deleted
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- 404:
- description: Policy is not found
- content:
- '*/*':
- schema:
- type: string
/actuator:
get:
tags:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
- /policies:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query policies
- operationId: getPolicies
- parameters:
- - name: type
- in: query
- description: The name of the policy type to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: service
- in: query
- description: The name of the service to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policies
- content:
- '*/*':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/policy_info_v1'
- 404:
- description: Near-RT RIC or type not found
- content:
- '*/*':
- schema:
- type: string
/actuator/loggers/{name}:
get:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: handle_7
+ operationId: loggers-name_4
parameters:
- name: name
in: path
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: handle_0
+ operationId: loggers-name_3
parameters:
- name: name
in: path
description: A registerred service must call this in regular intervals to indicate
that it is in operation. Absence of this call will lead to that teh service
will be deregisterred and all its policies are removed.
- operationId: keepAliveService_1
+ operationId: keepAliveService
parameters:
- name: service_id
in: path
'*/*':
schema:
$ref: '#/components/schemas/error_information'
- /rics:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query Near-RT RIC information
- operationId: getRics
- parameters:
- - name: policyType
- in: query
- description: The name of the policy type
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ric_info_v1'
- 404:
- description: Policy type is not found
- content:
- '*/*':
- schema:
- type: string
- /policy_schema:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns one policy type schema definition
- operationId: getPolicySchema
- parameters:
- - name: id
- in: query
- description: The identity of the policy type to get the definition for.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy schema
- content:
- '*/*':
- schema:
- type: object
- 404:
- description: The policy type is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
/actuator/metrics:
get:
tags:
- Actuator
summary: Actuator web endpoint 'metrics'
- operationId: handle_4
+ operationId: metrics_2
responses:
200:
description: OK
'*/*':
schema:
type: object
- /policy_status:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns a policy status
- operationId: getPolicyStatus
- parameters:
- - name: id
- in: query
- description: The identity of the policy.
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy status
- content:
- '*/*':
- schema:
- type: object
- 404:
- description: Policy is not found
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/rics:
get:
tags:
summary: Query Near-RT RIC information
description: The call returns all Near-RT RICs that supports a given policy
type identity
- operationId: getRics_1
+ operationId: getRics
parameters:
- name: policytype_id
in: query
application/json:
schema:
$ref: '#/components/schemas/error_information'
- /policy_schemas:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns policy type schema definitions
- operationId: getPolicySchemas
- parameters:
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get the definitions for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy schemas
- content:
- '*/*':
- schema:
- type: array
- items:
- type: object
- 404:
- description: Near-RT RIC is not found
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- /policy_ids:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Query policies, only policy identities returned
- operationId: getPolicyIds
- parameters:
- - name: type
- in: query
- description: The name of the policy type to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: ric
- in: query
- description: The name of the Near-RT RIC to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: service
- in: query
- description: The name of the service to get policies for.
- required: false
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Policy identitiess
- content:
- '*/*':
- schema:
- type: array
- items:
- type: string
- 404:
- description: Near-RT RIC or type not found
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/services:
get:
tags:
summary: Returns service information
description: Either information about a registered service with given identity
or all registered services are returned.
- operationId: getServices_1
+ operationId: getServices
parameters:
- name: service_id
in: query
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: putService_1
+ operationId: putService
requestBody:
content:
application/json:
tags:
- Actuator
summary: Actuator web endpoint 'info'
- operationId: handle_9
+ operationId: info_2
responses:
200:
description: OK
'*/*':
schema:
type: object
- /ric:
- get:
- tags:
- - A1 Policy Management V1.0
- summary: Returns the name of a RIC managing one Mananged Element
- operationId: getRic
- parameters:
- - name: managedElementId
- in: query
- description: The identity of the Managed Element
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Near-RT RIC is found
- content:
- '*/*':
- schema:
- type: string
- 404:
- description: Near-RT RIC is not found
- content:
- '*/*':
- schema:
- type: string
- /services/keepalive:
- put:
- tags:
- - A1 Policy Management V1.0
- summary: Heartbeat from a service
- operationId: keepAliveService
- parameters:
- - name: name
- in: query
- description: The name of the service
- required: true
- style: form
- explode: true
- schema:
- type: string
- responses:
- 200:
- description: Service supervision timer refreshed, OK
- content:
- '*/*':
- schema:
- type: string
- 404:
- description: The service is not found, needs re-registration
- content:
- '*/*':
- schema:
- type: string
/status:
get:
tags:
- - A1 Policy Management V1.0
+ - Health Check
summary: Returns status and statistics of this service
- operationId: getStatus
+ operationId: getStatusV1
responses:
200:
description: Service is living
tags:
- Actuator
summary: Actuator web endpoint 'logfile'
- operationId: handle_8
+ operationId: logfile_2
responses:
200:
description: OK
tags:
- Actuator
summary: Actuator web endpoint 'health'
- operationId: handle_11
+ operationId: health_2
responses:
200:
description: OK
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: getPolicyIds_1
+ operationId: getPolicyIds
parameters:
- name: policytype_id
in: query
tags:
- A1 Policy Management
summary: Create or update a policy
- operationId: putPolicy_1
+ operationId: putPolicy
requestBody:
content:
application/json:
application/json:
schema:
$ref: '#/components/schemas/void'
- /service:
- put:
- tags:
- - A1 Policy Management V1.0
- summary: Register a service
- operationId: putService
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/service_registration_info_v1'
- required: true
- responses:
- 200:
- description: Service updated
- content:
- '*/*':
- schema:
- type: string
- 201:
- description: Service created
- content:
- '*/*':
- schema:
- type: string
- 400:
- description: The ServiceRegistrationInfo is not accepted
- content:
- '*/*':
- schema:
- type: string
/a1-policy/v2/services/{service_id}:
delete:
tags:
- Service Registry and Supervision
summary: Unregister a service
- operationId: deleteService_1
+ operationId: deleteService
parameters:
- name: service_id
in: path
tags:
- A1 Policy Management
summary: Returns a policy status
- operationId: getPolicyStatus_1
+ operationId: getPolicyStatus
parameters:
- name: policy_id
in: path
tags:
- Actuator
summary: Actuator web endpoint 'heapdump'
- operationId: handle_10
+ operationId: heapdump_2
responses:
200:
description: OK
status:
type: string
description: status text
- policy_info_v1:
- type: object
- properties:
- service:
- type: string
- description: the name of the service owning the policy
- json:
- type: object
- description: the configuration of the policy
- id:
- type: string
- description: identity of the policy
- lastModified:
- type: string
- description: timestamp, last modification time
- type:
- type: string
- description: name of the policy type
- ric:
- type: string
- description: identity of the target Near-RT RIC
- service_registration_info_v1:
- type: object
- properties:
- keepAliveIntervalSeconds:
- type: integer
- description: keep alive interval for the service. This is a heartbeat supervision
- of the service, which in regular intevals must invoke a 'keepAlive' REST
- call. When a service does not invoke this call within the given time,
- it is considered unavailble. An unavailable service will be automatically
- deregistered and its policies will be deleted. Value 0 means no timeout
- supervision.
- format: int64
- callbackUrl:
- type: string
- description: callback for notifying of RIC synchronization
- serviceName:
- type: string
ric_info_v2:
type: object
properties:
items:
$ref: '#/components/schemas/policy_info_v2'
description: List of policy information
- ric_info_v1:
- type: object
- properties:
- managedElementIds:
- type: array
- description: O1 identities for managed entities
- items:
- type: string
- description: O1 identities for managed entities
- policyTypes:
- type: array
- description: supported policy types
- items:
- type: string
- description: supported policy types
- state:
- type: string
- description: state info
- ricName:
- type: string
- description: identity of the Near-RT RIC
- service_status_v1:
- type: object
- properties:
- keepAliveIntervalSeconds:
- type: integer
- description: policy keep alive timeout
- format: int64
- timeSinceLastActivitySeconds:
- type: integer
- description: time since last invocation by the service
- format: int64
- callbackUrl:
- type: string
- description: callback for notifying of RIC synchronization
- serviceName:
- type: string
- description: identity of the service
policy_status_info_v2:
type: object
properties:
Code Review / ccsdk / oran.git / commitdiff