{ "components": {"schemas": { "error_information": { "description": "Problem as defined in https://tools.ietf.org/html/rfc7807", "type": "object", "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": 404 } } }, "void": { "description": "Void/empty", "type": "object" }, "status_info_v2": { "type": "object", "properties": {"status": { "description": "status text", "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", "properties": { "ric_id": { "description": "identity of the Near-RT RIC", "type": "string" }, "managed_element_ids": { "description": "O1 identities for managed entities", "type": "array", "items": { "description": "O1 identities for managed entities", "type": "string" } }, "state": { "description": "Represents the states for a Near-RT RIC", "type": "string", "enum": [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ] }, "policytype_ids": { "description": "supported policy types", "type": "array", "items": { "description": "supported policy types", "type": "string" } } } }, "service_registration_info_v2": { "description": "Information for one service", "type": "object", "required": ["service_id"], "properties": { "callback_url": { "description": "callback for notifying of Near-RT RIC state changes", "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" } } }, "policy_info_list_v2": { "description": "List of policy information", "type": "object", "properties": {"policies": { "description": "List of policy information", "type": "array", "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", "properties": { "last_modified": { "description": "timestamp, last modification time", "type": "string" }, "status": { "description": "the Policy status", "type": "object" } } }, "service_status_v2": { "description": "List of service information", "type": "object", "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", "properties": {"rics": { "description": "List of Near-RT RIC information", "type": "array", "items": {"$ref": "#/components/schemas/ric_info_v2"} }} }, "policytype_v2": { "description": "Policy type", "type": "object", "properties": {"policy_schema": { "description": "Policy type json scema. The schema is a json object following http://json-schema.org/draft-07/schema", "type": "object" }} }, "policytype_id_list_v2": { "description": "Information about policy types", "type": "object", "properties": {"policytype_ids": { "description": "Policy type identities", "type": "array", "items": { "description": "Policy type identities", "type": "string" } }} }, "policy_info_v2": { "description": "Information for one A1-P Policy", "type": "object", "required": [ "policy_data", "policy_id", "policytype_id", "ric_id", "service_id" ], "properties": { "ric_id": { "description": "identity of the target Near-RT RIC", "type": "string" }, "policy_id": { "description": "identity of the policy", "type": "string" }, "transient": { "description": "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", "type": "boolean" }, "service_id": { "description": "the identity of the service owning the policy", "type": "string" }, "policy_data": { "description": "the configuration of the policy", "type": "object" }, "status_notification_uri": { "description": "Callback URI for policy status updates", "type": "string" }, "policytype_id": { "description": "identity of the policy type", "type": "string" } } }, "policy_id_list_v2": { "description": "A list of policy identities", "type": "object", "properties": {"policy_ids": { "description": "Policy identities", "type": "array", "items": { "description": "Policy identities", "type": "string" } }} }, "service_list_v2": { "description": "List of service information", "type": "object", "properties": {"service_list": { "description": "List of service information", "type": "array", "items": {"$ref": "#/components/schemas/service_status_v2"} }} }, "service_callback_info_v2": { "description": "Information transferred as in Service callbacks (callback_url)", "type": "object", "required": [ "event_type", "ric_id" ], "properties": { "ric_id": { "description": "identity of a Near-RT RIC", "type": "string" }, "event_type": { "description": "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management", "type": "string", "enum": ["AVAILABLE"] } } } }}, "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.
If several query parameters are defined, the policies matching all conditions are returned.", "operationId": "getPolicyInstances", "responses": { "200": { "description": "Policies", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_list_v2"}}} }, "404": { "description": "Near-RT RIC, policy type or service not found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [ { "schema": {"type": "string"}, "in": "query", "name": "policytype_id", "description": "Select policies with a given type identity.", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "ric_id", "description": "Select policies for a given Near-RT RIC identity.", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "service_id", "description": "Select policies owned by a given service.", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "type_name", "description": "Select policies of a given type name (type identity has the format )", "required": false } ], "tags": ["A1 Policy Management"] }}, "/a1-policy/v2/status": {"get": { "summary": "Returns status and statistics of this service", "operationId": "getStatus_1", "responses": {"200": { "description": "Service is living", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/status_info_v2"}}} }}, "tags": ["Health Check"] }}, "/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.
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", "responses": { "200": { "description": "Near-RT RIC is found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ric_info_v2"}}} }, "404": { "description": "Near-RT RIC is not found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [ { "schema": {"type": "string"}, "in": "query", "name": "managed_element_id", "description": "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "ric_id", "description": "The identity of a Near-RT RIC to get information for.", "required": false } ], "tags": ["NearRT-RIC Repository"] }}, "/a1-policy/v2/policy-types": {"get": { "summary": "Query policy type identities", "operationId": "getPolicyTypes_1", "responses": { "200": { "description": "Policy type IDs", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policytype_id_list_v2"}}} }, "404": { "description": "Near-RT RIC is not found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [ { "schema": {"type": "string"}, "in": "query", "name": "ric_id", "description": "Select types for the given Near-RT RIC identity.", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "type_name", "description": "Select types with the given type name (type identity has the format )", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "regexp", "description": "Select types with type identity that matches a regular expression.", "required": false }, { "schema": {"type": "string"}, "in": "query", "name": "compatible_with_version", "description": "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around.", "required": false } ], "tags": ["A1 Policy Management"] }}, "/a1-policy/v2/policies/{policy_id}": { "get": { "summary": "Returns a policy", "operationId": "getPolicy_1", "responses": { "200": { "description": "Policy found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}} }, "404": { "description": "Policy is not found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ "schema": {"type": "string"}, "in": "path", "name": "policy_id", "required": true }], "tags": ["A1 Policy Management"] }, "delete": { "summary": "Delete a policy", "operationId": "deletePolicy_1", "responses": { "200": { "description": "Not used", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} }, "423": { "description": "Near-RT RIC is not operational", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} }, "204": { "description": "Policy deleted", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} }, "404": { "description": "Policy is not found", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ "schema": {"type": "string"}, "in": "path", "name": "policy_id", "required": true }], "tags": ["A1 Policy Management"] } }, "/a1-policy/v2/configuration": { "get": { "summary": "Returns the contents of the configuration file", "description": "Note that the file contents is not relevant if the Consul is used.", "operationId": "getConfiguration", "responses": { "200": { "description": "Configuration", "content": {"application/json": {"schema": {"type": "object"}}} }, "404": { "description": "File is not found or readable", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "tags": ["Management of configuration"] }, "put": { "summary": "Replace the current configuration file with the given configuration", "requestBody": { "content": {"application/json": {"schema": {"type": "object"}}}, "required": true }, "description": "Note that the file is ignored if the Consul is used.", "operationId": "putConfiguration", "responses": { "200": { "description": "Configuration updated", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} }, "400": { "description": "Invalid configuration provided", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} }, "500": { "description": "Something went wrong when replacing the configuration. Try again.", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "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"] } }, "/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"] }}, "/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", "responses": { "200": { "description": "Service supervision timer refreshed, OK", "content": {"*/*": {"schema": {"type": "object"}}} }, "404": { "description": "The service is not found, needs re-registration", "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ "schema": {"type": "string"}, "in": "path", "name": "service_id", "required": true }], "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"] }}, "/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", "responses": { "200": { "description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ric_info_list_v2"}}} }, "404": { "description": "Policy type is not found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ "schema": {"type": "string"}, "in": "query", "name": "policytype_id", "description": "The identity of a policy type. If given, all Near-RT RICs supporteing the policy type are returned", "required": false }], "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", "responses": { "200": { "description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_list_v2"}}} }, "404": { "description": "Service is not found", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ "schema": {"type": "string"}, "in": "query", "name": "service_id", "description": "The identity of the service", "required": false }], "tags": ["Service Registry and Supervision"] }, "put": { "summary": "Register a service", "requestBody": { "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_registration_info_v2"}}}, "required": true }, "description": "Registering a service is needed to: