diff options
Diffstat (limited to 'docs/offeredapis')
| -rw-r--r-- | docs/offeredapis/swagger/pms-api.json | 90 | ||||
| -rw-r--r-- | docs/offeredapis/swagger/pms-api.yaml | 2037 |
2 files changed, 1313 insertions, 814 deletions
diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index f600470e..5d3a7a67 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -1,33 +1,11 @@ { - "swagger": "2.0", "basePath": "/", - "info": { - "x-audience": "external-partner", - "x-api-id": "60f9a0e7-343f-43bf-9194-d8d65688d465", - "contact": { - "name": "Ericsson Software Technology", - "email": "nonrtric@est.tech" - }, - "description": "The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. \nIt provides support for:<ul><li>A1 Policy creation and modification.<\/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> <li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs <\/li><\/ul>", - "title": "A1 Policy management service", - "version": "1.1.0" - }, - "tags": [ - { - "name": "A1 Policy Management Version 1.0", - "description": "Policy Controller" - }, - { - "name": "A1 Policy Management Version 2.0 (in progress)", - "description": "Policy Controller" - } - ], "paths": { "/policy_types": {"get": { "summary": "Query policy type names", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyTypesUsingGET", + "operationId": "getPolicyTypesUsingGET_1", "responses": { "200": { "schema": { @@ -58,7 +36,7 @@ "summary": "Returns a policy configuration", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyUsingGET_1", + "operationId": "getPolicyUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/json_object"}, @@ -85,7 +63,7 @@ "summary": "Delete a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE_1", + "operationId": "deletePolicyUsingDELETE", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -114,7 +92,7 @@ "summary": "Create or update a policy", "deprecated": false, "produces": ["application/json"], - "operationId": "putPolicyUsingPUT_1", + "operationId": "putPolicyUsingPUT", "responses": { "200": {"description": "Policy updated"}, "201": {"description": "Policy created"}, @@ -204,7 +182,7 @@ "summary": "Query policies, only policy identities returned", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyIdsUsingGET", + "operationId": "getPolicyIdsUsingGET_1", "responses": { "200": { "schema": { @@ -252,7 +230,7 @@ "summary": "Returns policy type schema definitions", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicySchemasUsingGET", + "operationId": "getPolicySchemasUsingGET_1", "responses": { "200": { "schema": { @@ -282,7 +260,7 @@ "summary": "Query policy type identities", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyTypesUsingGET_1", + "operationId": "getPolicyTypesUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_type_id_list_v2"}, @@ -463,7 +441,7 @@ "summary": "Returns the name of a RIC managing one Mananged Element", "deprecated": false, "produces": ["*/*"], - "operationId": "getRicUsingGET_1", + "operationId": "getRicUsingGET", "responses": { "200": { "schema": {"type": "string"}, @@ -487,7 +465,7 @@ "tags": ["A1 Policy Management Version 1.0"] }}, "/services/keepalive": {"put": { - "summary": "Heartbeat from a serice", + "summary": "Heartbeat from a service", "deprecated": false, "produces": ["*/*"], "operationId": "keepAliveServiceUsingPUT_1", @@ -545,7 +523,7 @@ "summary": "Returns policy type schema definitions", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicySchemasUsingGET_1", + "operationId": "getPolicySchemasUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_schema_list_v2"}, @@ -583,7 +561,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", - "operationId": "getRicUsingGET", + "operationId": "getRicUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/ric_info_v2"}, @@ -621,7 +599,7 @@ "summary": "Returns a policy configuration", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyUsingGET", + "operationId": "getPolicyUsingGET_1", "responses": { "200": { "schema": {"type": "object"}, @@ -645,7 +623,7 @@ "summary": "Delete a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE", + "operationId": "deletePolicyUsingDELETE_1", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -674,7 +652,7 @@ "summary": "Put a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "putPolicyUsingPUT", + "operationId": "putPolicyUsingPUT_1", "responses": { "200": {"description": "Policy updated"}, "201": {"description": "Policy created"}, @@ -765,7 +743,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", - "operationId": "getPolicyIdsUsingGET_1", + "operationId": "getPolicyIdsUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_id_list_v2"}, @@ -810,7 +788,7 @@ "summary": "Query policies", "deprecated": false, "produces": ["*/*"], - "operationId": "getPoliciesUsingGET", + "operationId": "getPoliciesUsingGET_1", "responses": { "200": { "schema": { @@ -858,7 +836,7 @@ "summary": "Returns a policy status", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyStatusUsingGET_1", + "operationId": "getPolicyStatusUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/json_object"}, @@ -912,7 +890,7 @@ "summary": "Query Near-RT RIC information", "deprecated": false, "produces": ["*/*"], - "operationId": "getRicsUsingGET_1", + "operationId": "getRicsUsingGET", "responses": { "200": { "schema": { @@ -975,7 +953,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", - "operationId": "getPoliciesUsingGET_1", + "operationId": "getPoliciesUsingGET", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_info_list_v2"}, @@ -1020,7 +998,7 @@ "summary": "Returns a policy status", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyStatusUsingGET", + "operationId": "getPolicyStatusUsingGET_1", "responses": { "200": { "schema": {"type": "object"}, @@ -1048,7 +1026,7 @@ "deprecated": false, "produces": ["application/json"], "description": "The call returns all Near-RT RICs that supports a given policy type identity", - "operationId": "getRicsUsingGET", + "operationId": "getRicsUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/ric_info_list_v2"}, @@ -1072,7 +1050,7 @@ "tags": ["A1 Policy Management Version 2.0 (in progress)"] }} }, - "host": "localhost:41579", + "host": "localhost:41437", "definitions": { "error_information": { "description": "Problem as defined in https://tools.ietf.org/html/rfc7807", @@ -1379,5 +1357,27 @@ "type": "object", "title": "Mono«ResponseEntity«string»»" } - } + }, + "swagger": "2.0", + "info": { + "x-audience": "external-partner", + "x-api-id": "60f9a0e7-343f-43bf-9194-d8d65688d465", + "contact": { + "name": "Ericsson Software Technology", + "email": "nonrtric@est.tech" + }, + "description": "The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. \nIt provides support for:<ul><li>A1 Policy creation and modification.<\/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> <li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs <\/li><\/ul>", + "title": "A1 Policy management service", + "version": "1.1.0" + }, + "tags": [ + { + "name": "A1 Policy Management Version 1.0", + "description": "Policy Controller" + }, + { + "name": "A1 Policy Management Version 2.0 (in progress)", + "description": "Policy Controller" + } + ] }
\ No newline at end of file diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml index ac10f4b6..245e52c2 100644 --- a/docs/offeredapis/swagger/pms-api.yaml +++ b/docs/offeredapis/swagger/pms-api.yaml @@ -1,842 +1,1341 @@ -openapi: 3.0.1 -info: - title: A1 Policy management service - description: 'The O-RAN Non-RT RIC PolicyAgent provides a REST API for management of policices. It provides support for: -Supervision of clients (R-APPs) to eliminate stray policies in case of failure -Consistency monitoring of the SMO view of policies and the actual situation in the RICs -Consistency monitoring of RIC capabilities (policy types) -Policy configuration. This includes: -One REST API towards all RICs in the network -Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc. -Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC - of A1 policices.' - version: "1.0" -servers: -- url: https://localhost:8433/ -- url: http://localhost:8081/ -tags: -- name: A1 Policy Management - description: Policy Controller -- name: Health check - description: Status Controller -- name: RIC Repository - description: Ric Repository Controller -- name: Service registry and supervision - description: Service Controller +basePath: / paths: - /policies: + /policy_types: get: - tags: - - A1 Policy Management - summary: Query policies - operationId: getPoliciesUsingGET - parameters: - - name: ric - in: query - description: The name of the Near-RT RIC to get policies for. - allowEmptyValue: false - schema: - type: string - example: 'ric1' - - name: service - in: query - description: The name of the service to get policies for. - allowEmptyValue: false - schema: - type: string - example: 'controlpanel' - - name: type - in: query - description: The name of the policy type to get policies for. - allowEmptyValue: false - schema: - type: string - example: '1' - responses: - 200: - description: Policies - content: - text/plain;charset=ISO-8859-1: - schema: - type: array - items: - $ref: '#/components/schemas/PolicyInfo' - examples: - OSC: - $ref: '#/components/examples/Policies-OSC' - STD: - $ref: '#/components/examples/Policies-STD' - 404: - description: RIC or type not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: RIC not found + summary: Query policy type names deprecated: false - /policy: - get: + produces: + - '*/*' + operationId: getPolicyTypesUsingGET_1 + responses: + '200': + schema: + type: array + items: + type: string + description: Policy type names + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Near-RT RIC is not found + parameters: + - in: query + allowEmptyValue: false + name: ric + description: The name of the Near-RT RIC to get types for. + type: string + required: false tags: - - A1 Policy Management + - A1 Policy Management Version 1.0 + /v2/policy: + get: summary: Returns a policy configuration + deprecated: false + produces: + - application/json operationId: getPolicyUsingGET - parameters: - - name: id - in: query - description: The identity of the policy instance. - required: true - allowEmptyValue: false - schema: - type: string - example: 'e26d76e1-b43f-427e-a3c2-b7c4e05a6431' responses: - 200: + '200': + schema: + $ref: '#/definitions/json_object' description: Policy found - content: - text/plain;charset=ISO-8859-1: - schema: - type: object - examples: - OSC: - $ref: '#/components/examples/Policy-OSC' - STD: - $ref: '#/components/examples/Policy-STD' - 404: + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' description: Policy is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'Could not find policy: e26d76e1-b43f-427e-a3c2-b7c4e05a6431' - deprecated: false - put: - tags: - - A1 Policy Management - summary: Put a policy - operationId: putPolicyUsingPUT parameters: - - name: id - in: query - description: The identity of the policy instance. - required: true - allowEmptyValue: false - schema: - type: string - example: '73428e58-1670-4972-8498-e7e8f1003631' - - name: ric - in: query - description: The name of the Near-RT RIC where the policy will be created. - required: true - allowEmptyValue: false - schema: - type: string - example: 'ric1' - - name: service - in: query - description: The name of the service creating the policy. - required: true - allowEmptyValue: false - schema: - type: string - example: 'Service1' - - 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. - allowEmptyValue: false - schema: - type: boolean - default: false - example: false - - name: type - in: query - description: The name of the policy type. The policy type is mandatory for OSC A1 version and should not be provided for STD A1 version. - allowEmptyValue: false - schema: - type: string - example: 'STD_PolicyModelUnconstrained_0.2.0' - requestBody: - description: jsonBody - content: - application/json: - schema: - type: object - example: - scope: - qosId: "3" - ueId: "1" - statement: - priorityLevel: 1 - required: true - responses: - 200: - description: Policy updated - 201: - description: Policy created - 404: - description: RIC or policy type is not found - 423: - description: RIC is not operational - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'Ric is not operational, RIC name:ric1, state:UNAVAILABLE' - delete: + - in: query + allowEmptyValue: false + name: policy_id + description: The identity of the policy instance. + type: string + required: true tags: - - A1 Policy Management + - A1 Policy Management Version 2.0 (in progress) + delete: summary: Delete a policy + deprecated: false + produces: + - '*/*' operationId: deletePolicyUsingDELETE - parameters: - - name: id - in: query - description: The identity of the policy instance. - required: true - allowEmptyValue: false - schema: - type: string - example: '73428e58-1670-4972-8498-e7e8f1003631' responses: - 200: - description: OK - 204: + '200': + description: Not used + '204': description: Policy deleted - 404: + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' description: Policy is not found - 423: - description: RIC is not operational - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'Ric is not operational, RIC name:ric1,state:UNAVAILABLE' - deprecated: false - /policy_ids: - get: - tags: - - A1 Policy Management - summary: Query policies, only IDs returned - operationId: getPolicyIdsUsingGET + '423': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC is not operational parameters: - - name: ric - in: query - description: The name of the Near-RT RIC to get policies for. - allowEmptyValue: false - schema: - type: string - example: 'ric1' - - name: service - in: query - description: The name of the service to get policies for. - allowEmptyValue: false - schema: - type: string - example: 'Service1' - - name: type - in: query - description: The name of the policy type to get policies for. - allowEmptyValue: false - schema: - type: string - example: '1' - responses: - 200: - description: Policy ids - content: - text/plain;charset=ISO-8859-1: - schema: - type: array - items: - type: string - examples: - OSC: - value: - - 73428e58-1670-4972-8498-e7e8f1003631 - - 73428e58-1670-4972-8498-e7e8f100363e - STD: - value: - - 73428e58-1670-4972-8498-e7e8f1003632 - - 73428e58-1670-4972-8498-e7e8f1003634 - 404: - description: RIC or type not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: RIC not found - deprecated: false - /policy_schema: - get: + - in: query + allowEmptyValue: false + name: policy_id + description: The identity of the policy instance. + type: string + required: true tags: - - A1 Policy Management - summary: Returns one policy type schema definition. Applicable only for OSC Version. - operationId: getPolicySchemaUsingGET + - A1 Policy Management Version 2.0 (in progress) + put: + summary: Create or update a policy + deprecated: false + produces: + - application/json + operationId: putPolicyUsingPUT + responses: + '200': + description: Policy updated + '201': + description: Policy created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC or policy type is not found + '423': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC is not operational parameters: - - name: id - in: query - description: The identity of the policy type to get the definition for. - required: true - allowEmptyValue: false - schema: - type: string - example: '11' + - schema: + type: object + in: body + name: jsonBody + description: jsonBody + required: true + - in: query + allowEmptyValue: false + name: policy_id + description: The identity of the policy instance. + type: string + required: true + - in: query + allowEmptyValue: false + name: policytype_id + description: The identity of the policy type. + type: string + required: false + - in: query + allowEmptyValue: false + name: ric_id + description: The identity of the Near-RT RIC where the policy will be created. + type: string + required: true + - in: query + allowEmptyValue: false + name: service_id + description: The identity of the service creating the policy. + type: string + required: true + - default: false + in: query + allowEmptyValue: false + name: transient + x-example: false + description: If the policy is transient or not (boolean defaulted to false). A policy is transient if it will not be recreated in the Near-RT RIC when it has been lost (for instance due to a restart) + type: boolean + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) + consumes: + - application/json + /v2/status: + get: + summary: Returns status and statistics of this service + deprecated: false + produces: + - application/json + operationId: getStatusUsingGET_1 responses: - 200: - description: Policy schema - content: - text/plain;charset=ISO-8859-1: - schema: - type: object - examples: - OSC: - value: - $schema: http://json-schema.org/draft-07/schema# - description: QoS policy type - title: "1" - type: object - properties: - scope: - additionalProperties: false - type: object - properties: - qosId: - type: string - ueId: - type: string - required: - - ueId - - qosId - statement: - additionalProperties: false - type: object - properties: - priorityLevel: - type: number - required: - - priorityLevel - 404: - description: Type not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'org.oransc.policyagent.exceptions.ServiceException: Could - not find type: 11' + '200': + schema: + $ref: '#/definitions/status_info_v2' + description: Service is living + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + tags: + - A1 Policy Management Version 2.0 (in progress) + /policy_ids: + get: + summary: 'Query policies, only policy identities returned' deprecated: false + produces: + - '*/*' + operationId: getPolicyIdsUsingGET_1 + responses: + '200': + schema: + type: array + items: + type: string + description: Policy identitiess + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Near-RT RIC or type not found + parameters: + - in: query + allowEmptyValue: false + name: ric + description: The name of the Near-RT RIC to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: service + description: The name of the service to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: type + description: The name of the policy type to get policies for. + type: string + required: false + tags: + - A1 Policy Management Version 1.0 /policy_schemas: get: - tags: - - A1 Policy Management summary: Returns policy type schema definitions - operationId: getPolicySchemasUsingGET - parameters: - - name: ric - in: query - description: The name of the Near-RT RIC to get the definitions for. - allowEmptyValue: false - schema: - type: string - example: ric1 + deprecated: false + produces: + - '*/*' + operationId: getPolicySchemasUsingGET_1 responses: - 200: + '200': + schema: + type: array + items: + type: object description: Policy schemas - content: - text/plain;charset=ISO-8859-1: - schema: - type: array - items: - type: object - properties: {} - examples: - OSC: - value: - - $schema: http://json-schema.org/draft-07/schema# - description: QoS policy type - title: "1" - type: object - properties: - scope: - additionalProperties: false - type: object - properties: - qosId: - type: string - ueId: - type: string - required: - - ueId - - qosId - statement: - additionalProperties: false - type: object - properties: - priorityLevel: - type: number - required: - - priorityLevel - 404: - description: RIC is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'org.oransc.policyagent.exceptions.ServiceException: Could - not find ric: ric1' - deprecated: false - /policy_status: - get: - tags: - - A1 Policy Management - summary: Returns a policy status - operationId: getPolicyStatusUsingGET + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Near-RT RIC is not found parameters: - - name: id - in: query - description: The identity of the policy. - required: true - allowEmptyValue: false - schema: - type: string - example: 73428e58-1670-4972-8498-e7e8f100363q - responses: - 200: - description: Policy status - content: - text/plain;charset=ISO-8859-1: - schema: - type: object - examples: - OSC: - value: - instance_status: NOT IN EFFECT - has_been_deleted: "false" - created_at: 07/20/2020, 17:15:39 - STD: - value: - enforceStatus: UNDEFINED - 404: - description: Policy is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'Could not find policy: 73428e58-1670-4972-8498-e7e8f100363q' - deprecated: false - /policy_types: - get: + - in: query + allowEmptyValue: false + name: ric + description: The name of the Near-RT RIC to get the definitions for. + type: string + required: false tags: - - A1 Policy Management - summary: Query policy type names + - A1 Policy Management Version 1.0 + /v2/policy-types: + get: + summary: Query policy type identities + deprecated: false + produces: + - application/json operationId: getPolicyTypesUsingGET + responses: + '200': + schema: + $ref: '#/definitions/policy_type_id_list_v2' + description: Policy type IDs + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC is not found parameters: - - name: ric - in: query - description: The name of the Near-RT RIC to get types for. - allowEmptyValue: false - schema: + - in: query + allowEmptyValue: false + name: ric_id + description: The identity of the Near-RT RIC to get types for. type: string - example: 'ric11' - responses: - 200: - description: Policy type names - content: - text/plain;charset=ISO-8859-1: - schema: - type: array - items: - type: string - examples: - OSC: - value: - - "1" - 404: - description: RIC is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'org.oransc.policyagent.exceptions.ServiceException: Could - not find ric: ric11' - deprecated: false - /ric: - get: + required: false tags: - - RIC Repository - summary: Returns the name of a RIC managing one Mananged Element - operationId: getRicUsingGET - parameters: - - name: managedElementId - in: query - description: The identity of the Managed Element - required: true - allowEmptyValue: false - schema: - type: string - example: 'Node 1' - responses: - 200: - description: RIC is found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: ric1 - 404: - description: RIC is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: No RIC found - deprecated: false - /rics: + - A1 Policy Management Version 2.0 (in progress) + /v2/services: get: - tags: - - RIC Repository - summary: Query Near-RT RIC information - operationId: getRicsUsingGET - parameters: - - name: policyType - in: query - description: The name of the policy type - allowEmptyValue: false - schema: - type: string - example: 'STD_PolicyModelUnconstrained_0.2.0' + summary: Returns service information + deprecated: false + produces: + - application/json + description: Either information about a registered service with given identity or all registered services are returned. + operationId: getServicesUsingGET responses: - 200: + '200': + schema: + $ref: '#/definitions/service_list_v2' description: OK - content: - text/plain;charset=ISO-8859-1: - schema: - type: array - items: - $ref: '#/components/schemas/RicInfo' - 404: - description: Policy type is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: Policy type not found + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Service is not found + parameters: + - in: query + allowEmptyValue: false + name: service_id + description: The identity of the service + type: string + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) + delete: + summary: Unregister a service deprecated: false - /service: - put: + produces: + - '*/*' + operationId: deleteServiceUsingDELETE + responses: + '200': + description: Not used + '204': + schema: + type: object + description: Service unregistered + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Service not found + parameters: + - in: query + allowEmptyValue: false + name: service_id + description: The idenitity of the service + type: string + required: true tags: - - Service registry and supervision + - A1 Policy Management Version 2.0 (in progress) + put: summary: Register a service + deprecated: false + produces: + - '*/*' + description: 'Registering a service is needed to:<ul><li>Get callbacks.</li><li>Activate supervision of the service. If a service is inactive, its policies will be deleted.</li></ul>' operationId: putServiceUsingPUT - requestBody: - description: registrationInfo - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceRegistrationInfo' - required: true responses: - 200: + '200': + schema: + type: object description: Service updated - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: OK - 201: + '201': + schema: + type: object description: Service created - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: OK - 400: + '400': + schema: + $ref: '#/definitions/error_information' description: The ServiceRegistrationInfo is not accepted - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: Missing mandatory parameter 'serviceName' - 404: + '401': + description: Unauthorized + '403': + description: Forbidden + '404': description: Not Found - deprecated: false - x-codegen-request-body-name: registrationInfo + parameters: + - schema: + $ref: '#/definitions/service_registration_info_v2' + in: body + name: registrationInfo + description: registrationInfo + required: true + tags: + - A1 Policy Management Version 2.0 (in progress) + consumes: + - application/json /services: get: - tags: - - Service registry and supervision summary: Returns service information - operationId: getServicesUsingGET - parameters: - - name: name - in: query - description: The name of the service - allowEmptyValue: false - schema: - type: string - example: 'service1' + deprecated: false + produces: + - '*/*' + operationId: getServicesUsingGET_1 responses: - 200: + '200': + schema: + type: array + items: + $ref: '#/definitions/service_status_v1' description: OK - content: - text/plain;charset=ISO-8859-1: - schema: - type: array - example: - - serviceName: "service1" - keepAliveIntervalSeconds: 1000 - timeSinceLastActivitySeconds: 7 - callbackUrl: http://localhost:8080 - items: - $ref: '#/components/schemas/ServiceStatus' - 404: + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string description: Service is not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: Service not found - deprecated: false - delete: + parameters: + - in: query + allowEmptyValue: false + name: name + description: The name of the service + type: string + required: false tags: - - Service registry and supervision + - A1 Policy Management Version 1.0 + delete: summary: Delete a service - operationId: deleteServiceUsingDELETE - parameters: - - name: name - in: query - description: The name of the service - required: true - allowEmptyValue: false - schema: - type: string - example: 'service1' + deprecated: false + produces: + - '*/*' + operationId: deleteServiceUsingDELETE_1 responses: - 200: - description: OK - 204: + '200': + schema: + type: string description: OK - 404: + '204': + schema: + type: string + description: Service deleted + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string description: Service not found - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'Could not find service: service1' + parameters: + - in: query + allowEmptyValue: false + name: name + description: The name of the service + type: string + required: true + tags: + - A1 Policy Management Version 1.0 + /ric: + get: + summary: Returns the name of a RIC managing one Mananged Element deprecated: false + produces: + - '*/*' + operationId: getRicUsingGET + responses: + '200': + schema: + type: string + description: Near-RT RIC is found + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Near-RT RIC is not found + parameters: + - in: query + allowEmptyValue: false + name: managedElementId + description: The identity of the Managed Element + type: string + required: true + tags: + - A1 Policy Management Version 1.0 /services/keepalive: put: + summary: Heartbeat from a service + deprecated: false + produces: + - '*/*' + operationId: keepAliveServiceUsingPUT_1 + responses: + '200': + schema: + type: string + description: 'Service supervision timer refreshed, OK' + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: 'The service is not found, needs re-registration' + parameters: + - in: query + allowEmptyValue: false + name: name + description: The name of the service + type: string + required: true tags: - - Service registry and supervision - summary: Heartbeat from a serice + - A1 Policy Management Version 1.0 + consumes: + - application/json + /v2/services/keepalive: + put: + summary: Heartbeat indicates that the service is running + deprecated: false + produces: + - '*/*' operationId: keepAliveServiceUsingPUT - parameters: - - name: name - in: query - description: The name of the service - required: true - allowEmptyValue: false - schema: - type: string - example: 'service1' responses: - 200: - description: Service supervision timer refreshed, OK - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: OK - 201: + '200': + schema: + type: object + description: 'Service supervision timer refreshed, OK' + '201': description: Created - 404: - description: The service is not found, needs re-registration - content: - text/plain;charset=ISO-8859-1: - schema: - type: string - example: 'Could not find service: service1' + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: 'The service is not found, needs re-registration' + parameters: + - in: query + allowEmptyValue: false + name: service_id + description: The identity of the service + type: string + required: true + tags: + - A1 Policy Management Version 2.0 (in progress) + consumes: + - application/json + /v2/policy-schemas: + get: + summary: Returns policy type schema definitions deprecated: false - /status: + produces: + - application/json + operationId: getPolicySchemasUsingGET + responses: + '200': + schema: + $ref: '#/definitions/policy_schema_list_v2' + description: Policy schemas + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC is not found + parameters: + - in: query + allowEmptyValue: false + name: policytype_id + description: 'The identity of the policy type to get the definition for. When this parameter is given, max one schema will be returned' + type: string + required: true + - in: query + allowEmptyValue: false + name: ric_id + description: The identity of the Near-RT RIC to get the definitions for. + type: string + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) + /v2/ric: get: + summary: Returns info for a Near-RT RIC + deprecated: false + produces: + - application/json + description: Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU). + operationId: getRicUsingGET_1 + responses: + '200': + schema: + $ref: '#/definitions/ric_info_v2' + description: Near-RT RIC is found + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC is not found + parameters: + - in: query + allowEmptyValue: false + name: managed_element_id + description: 'The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.' + type: string + required: false + - in: query + allowEmptyValue: false + name: ric_id + description: The identity of a Near-RT RIC to get information for. + type: string + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) + /policy: + get: + summary: Returns a policy configuration + deprecated: false + produces: + - '*/*' + operationId: getPolicyUsingGET_1 + responses: + '200': + schema: + type: object + description: Policy found + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Policy is not found + parameters: + - in: query + allowEmptyValue: false + name: id + description: The identity of the policy instance. + type: string + required: true + tags: + - A1 Policy Management Version 1.0 + delete: + summary: Delete a policy + deprecated: false + produces: + - '*/*' + operationId: deletePolicyUsingDELETE_1 + responses: + '200': + description: Not used + '204': + description: Policy deleted + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Policy is not found + '423': + schema: + type: string + description: Near-RT RIC is not operational + parameters: + - in: query + allowEmptyValue: false + name: id + description: The identity of the policy instance. + type: string + required: true + tags: + - A1 Policy Management Version 1.0 + put: + summary: Put a policy + deprecated: false + produces: + - '*/*' + operationId: putPolicyUsingPUT_1 + responses: + '200': + description: Policy updated + '201': + description: Policy created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Near-RT RIC or policy type is not found + '423': + schema: + type: string + description: Near-RT RIC is not operational + parameters: + - in: query + allowEmptyValue: false + name: id + description: The identity of the policy instance. + type: string + required: true + - schema: + type: object + in: body + name: jsonBody + description: jsonBody + required: true + - in: query + allowEmptyValue: false + name: ric + description: The name of the Near-RT RIC where the policy will be created. + type: string + required: true + - in: query + allowEmptyValue: false + name: service + description: The name of the service creating the policy. + type: string + required: true + - default: false + in: query + allowEmptyValue: false + name: transient + x-example: 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. + type: boolean + required: false + - in: query + allowEmptyValue: false + name: type + description: The name of the policy type. + type: string + required: false tags: - - Health check + - A1 Policy Management Version 1.0 + consumes: + - application/json + /status: + get: summary: Returns status and statistics of this service + deprecated: false + produces: + - '*/*' operationId: getStatusUsingGET responses: - 200: + '200': + schema: + type: string description: Service is living - content: - '*/*': - schema: - type: string - example: alive - 404: + '401': + description: Unauthorized + '403': + description: Forbidden + '404': description: Not Found + tags: + - A1 Policy Management Version 1.0 + /v2/policy-ids: + get: + summary: 'Query policies, only policy identities are returned' deprecated: false -components: - schemas: - PolicyInfo: - title: PolicyInfo - type: object - properties: - id: - type: string - description: identity of the policy - json: - type: object - properties: {} - description: the configuration of the policy - lastModified: - type: string - description: timestamp, last modification time - ric: - type: string - description: identity of the target Near-RT RIC - service: - type: string - description: the name of the service owning the policy - type: - type: string - description: name of the policy type - RicInfo: - title: RicInfo - type: object - properties: - managedElementIds: - type: array - description: O1 identities for managed entities - items: + produces: + - application/json + description: 'Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.' + operationId: getPolicyIdsUsingGET + responses: + '200': + schema: + $ref: '#/definitions/policy_id_list_v2' + description: Policy identities + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Near-RT RIC or type not found + parameters: + - in: query + allowEmptyValue: false + name: policytype_id + description: The identity of the policy type to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: ric_id + description: The identity of the Near-RT RIC to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: service_id + description: The identity of the service to get policies for. + type: string + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) + /policies: + get: + summary: Query policies + deprecated: false + produces: + - '*/*' + operationId: getPoliciesUsingGET_1 + responses: + '200': + schema: + type: array + items: + $ref: '#/definitions/policy_info_v1' + description: Policies + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: type: string - policyTypes: - type: array - description: supported policy types - items: + description: Near-RT RIC or type not found + parameters: + - in: query + allowEmptyValue: false + name: ric + description: The name of the Near-RT RIC to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: service + description: The name of the service to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: type + description: The name of the policy type to get policies for. + type: string + required: false + tags: + - A1 Policy Management Version 1.0 + /v2/policy-status: + get: + summary: Returns a policy status + deprecated: false + produces: + - application/json + operationId: getPolicyStatusUsingGET + responses: + '200': + schema: + $ref: '#/definitions/json_object' + description: Policy status + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Policy is not found + parameters: + - in: query + allowEmptyValue: false + name: policy_id + description: The identity of the policy. + type: string + required: true + tags: + - A1 Policy Management Version 2.0 (in progress) + /policy_schema: + get: + summary: Returns one policy type schema definition + deprecated: false + produces: + - '*/*' + operationId: getPolicySchemaUsingGET + responses: + '200': + schema: + type: object + description: Policy schema + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: type: string - ricName: - type: string - description: identity of the ric - state: - type: string - description: state info - example: - - ricName: ric1 - managedElementIds: - - ME-1 - - ME-2 - policyTypes: - - '1' - state: AVAILABLE - - ricName: ric3 - managedElementIds: - - ME-1 - - ME-2 - policyTypes: - - '' - state: AVAILABLE - - ricName: ric2 - managedElementIds: - - ME-1 - - ME-2 - policyTypes: [] - state: AVAILABLE - - ricName: ric4 - managedElementIds: - - ME-1 - - ME-2 - policyTypes: - - '' - state: AVAILABLE - ServiceRegistrationInfo: - title: ServiceRegistrationInfo - required: - - serviceName - type: object - properties: - callbackUrl: - type: string - description: callback for notifying of RIC synchronization - 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 - serviceName: - type: string - description: identity of the service - example: - callbackUrl: http://localhost:9080 - keepAliveIntervalSeconds: 1000 - serviceName: service1 - ServiceStatus: - title: ServiceStatus - type: object - properties: - callbackUrl: - type: string - description: callback for notifying of RIC synchronization - keepAliveIntervalSeconds: - type: integer - description: policy keep alive timeout - format: int64 - serviceName: - type: string - description: identity of the service - timeSinceLastActivitySeconds: - type: integer - description: time since last invocation by the service - format: int64 - examples: - Policies-STD: - value: - - id: a986eb38-aac3-4897-bdf5-0333ea2bf730 - type: '' - ric: ric3 - json: - scope: - ueId: ue1 - groupId: group1 - sliceId: slice1 - qosId: qos1 - cellId: cell1 - statement: - priorityLevel: 5 - service: controlpanel - lastModified: '2020-07-22T12:21:48.157854Z' - Policies-OSC: - value: - - id: 73428e58-1670-4972-8498-e7e8f1003631 - type: '1' - ric: ric1 - json: - scope: - qosId: '36' - ueId: '1' - statement: - priorityLevel: 1 - service: c - lastModified: '2020-07-20T17:16:18.244383Z' - - id: 73428e58-1670-4972-8498-e7e8f100363e - type: '1' - ric: ric1 - json: - scope: - qosId: '34' - ueId: '1' - statement: - priorityLevel: 1 - service: controlpanel - lastModified: '2020-07-20T17:15:39.320469Z' - Policy-STD: - value: - scope: - ueId: ue1 - groupId: group1 - sliceId: slice1 - qosId: qos1 - cellId: cell1 - statement: - priorityLevel: 5 - Policy-OSC: - value: - scope: - qosId: '36' - ueId: '1' - statement: - priorityLevel: 1
\ No newline at end of file + description: The policy type is not found + parameters: + - in: query + allowEmptyValue: false + name: id + description: The identity of the policy type to get the definition for. + type: string + required: true + tags: + - A1 Policy Management Version 1.0 + /rics: + get: + summary: Query Near-RT RIC information + deprecated: false + produces: + - '*/*' + operationId: getRicsUsingGET + responses: + '200': + schema: + type: array + items: + $ref: '#/definitions/ric_info_v1' + description: OK + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Policy type is not found + parameters: + - in: query + allowEmptyValue: false + name: policyType + description: The name of the policy type + type: string + required: false + tags: + - A1 Policy Management Version 1.0 + /service: + put: + summary: Register a service + deprecated: false + produces: + - '*/*' + operationId: putServiceUsingPUT_1 + responses: + '200': + schema: + type: string + description: Service updated + '201': + schema: + type: string + description: Service created + '400': + schema: + type: string + description: The ServiceRegistrationInfo is not accepted + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + parameters: + - schema: + $ref: '#/definitions/service_registration_info_v1' + in: body + name: registrationInfo + description: registrationInfo + required: true + tags: + - A1 Policy Management Version 1.0 + consumes: + - application/json + /v2/policies: + get: + summary: Query for existing A1 policies + deprecated: false + produces: + - application/json + description: 'Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.' + operationId: getPoliciesUsingGET + responses: + '200': + schema: + $ref: '#/definitions/policy_info_list_v2' + description: Policies + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: 'Near-RT RIC, policy type or service not found' + parameters: + - in: query + allowEmptyValue: false + name: policytype_id + description: The identity of the policy type to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: ric_id + description: The identity of the Near-RT RIC to get policies for. + type: string + required: false + - in: query + allowEmptyValue: false + name: service_id + description: The identity of the service to get policies for. + type: string + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) + /policy_status: + get: + summary: Returns a policy status + deprecated: false + produces: + - '*/*' + operationId: getPolicyStatusUsingGET_1 + responses: + '200': + schema: + type: object + description: Policy status + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + type: string + description: Policy is not found + parameters: + - in: query + allowEmptyValue: false + name: id + description: The identity of the policy. + type: string + required: true + tags: + - A1 Policy Management Version 1.0 + /v2/rics: + get: + summary: Query Near-RT RIC information + deprecated: false + produces: + - application/json + description: The call returns all Near-RT RICs that supports a given policy type identity + operationId: getRicsUsingGET_1 + responses: + '200': + schema: + $ref: '#/definitions/ric_info_list_v2' + description: OK + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + schema: + $ref: '#/definitions/error_information' + description: Policy type is not found + parameters: + - in: query + allowEmptyValue: false + name: policytype_id + description: 'The identity of a policy type. If given, all Near-RT RICs supporteing the policy type are returned' + type: string + required: false + tags: + - A1 Policy Management Version 2.0 (in progress) +host: 'localhost:41437' +definitions: + error_information: + description: 'Problem as defined in https://tools.ietf.org/html/rfc7807' + type: object + title: error_information + properties: + detail: + description: ' A human-readable explanation specific to this occurrence of the problem.' + type: string + example: Policy type not found + status: + format: int32 + description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' + type: integer + example: 503 + void: + description: Void/empty + type: object + title: void + status_info_v2: + type: object + title: status_info_v2 + properties: + status: + description: status text + type: string + policy_info_v1: + type: object + title: policy_info_v1 + 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 + policy_schema_list_v2: + description: Policy type json schemas + type: object + title: policy_schema_list_v2 + properties: + policy_schemas: + description: 'Policy type json schemas. The schema is a json object following http://json-schema.org/draft-07/schema' + type: array + items: + type: object + Mono«ResponseEntity«object»»: + type: object + title: Mono«ResponseEntity«object»» + ric_info_v2: + description: Information for a Near-RT RIC + type: object + title: ric_info_v2 + properties: + ric_id: + description: identity of the Near-RT RIC + type: string + managed_element_ids: + description: O1 identities for managed entities + type: array + items: + type: string + state: + description: |- + State for the Near-RT RIC, values: + UNAVAILABLE: The Near-RT RIC is not avialable, information may be inconsistent + AVAILABLE: The normal state. Policies can be configured. + + SYNCHRONIZING: The Policy Management Service is synchronizing the view of the Near-RT RIC. Policies cannot be configured. + CONSISTENCY_CHECK: A consistency check between the Policy Management Service and the Near-RT RIC. Policies cannot be configured. + type: string + enum: + - UNAVAILABLE + - AVAILABLE + - SYNCHRONIZING + - CONSISTENCY_CHECK + policy_type_ids: + description: supported policy types + type: array + items: + type: string + service_registration_info_v1: + type: object + title: service_registration_info_v1 + 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 + policy_info_list_v2: + description: List of policy information + type: object + title: policy_info_list_v2 + properties: + policies: + description: List of policy information + type: array + items: + $ref: '#/definitions/policy_info_v2' + service_registration_info_v2: + description: Information for one service + type: object + title: service_registration_info_v2 + required: + - service_id + properties: + callback_url: + description: callback for notifying of RIC synchronization + type: string + service_id: + description: identity of the service + type: string + keep_alive_interval_seconds: + 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 + ric_info_v1: + type: object + title: ric_info_v1 + properties: + managedElementIds: + description: O1 identities for managed entities + type: array + items: + type: string + policyTypes: + description: supported policy types + type: array + items: + type: string + state: + description: state info + type: string + ricName: + description: identity of the Near-RT RIC + type: string + policy_type_id_list_v2: + description: Information about policy types + type: object + title: policy_type_id_list_v2 + properties: + policy_type_ids: + description: Policy type identities + type: array + items: + type: string + service_status_v1: + type: object + title: service_status_v1 + properties: + keepAliveIntervalSeconds: + format: int64 + description: policy keep alive timeout + type: integer + callbackUrl: + description: callback for notifying of RIC synchronization + type: string + timeSinceLastActivitySeconds: + format: int64 + description: time since last invocation by the service + type: integer + serviceName: + description: identity of the service + type: string + service_status_v2: + type: object + title: service_status_v2 + properties: + callback_url: + description: callback for notifying of RIC synchronization + type: string + service_id: + description: identity of the service + type: string + keep_alive_interval_seconds: + format: int64 + description: policy keep alive timeout + type: integer + time_since_last_activity_seconds: + format: int64 + description: time since last invocation by the service + type: integer + ric_info_list_v2: + description: List of Near-RT RIC information + type: object + title: ric_info_list_v2 + properties: + rics: + description: List of Near-RT RIC information + type: array + items: + $ref: '#/definitions/ric_info_v2' + policy_id_list_v2: + description: A list of policy identities + type: object + title: policy_id_list_v2 + properties: + policy_ids: + description: Policy identities + type: array + items: + type: string + policy_info_v2: + description: Information for one A1-P Policy + type: object + title: policy_info_v2 + properties: + ric_id: + description: identity of the target Near-RT RIC + type: string + policy_id: + description: identity of the policy + type: string + service_id: + description: the name of the service owning the policy + type: string + policy_data: + description: the configuration of the policy + type: object + last_modified: + description: 'timestamp, last modification time' + type: string + policy_type_id: + description: name of the policy type + type: string + json_object: + description: A JSON object defining the configuration of the policy. The schema is defined by the Policy Type. + type: object + title: json_object + service_list_v2: + description: List of service information + type: object + title: service_list_v2 + properties: + service_list: + description: List of service information + type: array + items: + $ref: '#/definitions/service_status_v2' + Mono«ResponseEntity«string»»: + type: object + title: Mono«ResponseEntity«string»» +swagger: '2.0' +info: + x-audience: external-partner + x-api-id: 60f9a0e7-343f-43bf-9194-d8d65688d465 + contact: + name: Ericsson Software Technology + email: nonrtric@est.tech + description: |- + The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. + It provides support for:<ul><li>A1 Policy creation and modification.</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> <li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs </li></ul> + title: A1 Policy management service + version: 1.1.0 +tags: + - name: A1 Policy Management Version 1.0 + description: Policy Controller + - name: A1 Policy Management Version 2.0 (in progress) + description: Policy Controller + |