diff options
Diffstat (limited to 'docs/offeredapis/swagger/pms-api.json')
| -rw-r--r-- | docs/offeredapis/swagger/pms-api.json | 1698 |
1 files changed, 757 insertions, 941 deletions
diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index fe4554bf..9514f7ed 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -1,1438 +1,1254 @@ { - "basePath": "/", + "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": 503 + } + } + }, + "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 name 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 names", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPolicyTypesUsingGET_1", + "operationId": "getPolicyTypes", "responses": { "200": { - "schema": { + "description": "Policy type names", + "content": {"*/*": {"schema": { "type": "array", "items": {"type": "string"} - }, - "description": "Policy type names" + }}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC is not found" + "description": "Near-RT RIC is not found", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "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 Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, "/a1-policy/v2/policy-instances": {"get": { "summary": "Query for A1 policy instances", - "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": "getPolicyInstancesUsingGET", + "operationId": "getPolicyInstances", "responses": { "200": { - "schema": {"$ref": "#/definitions/policy_info_list_v2"}, - "description": "Policies" + "description": "Policies", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_list_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC, policy type or service not found" + "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", - "allowEmptyValue": false, "name": "policytype_id", "description": "The identity of the policy type to get policies for.", - "type": "string", "required": false }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "ric_id", "description": "The identity of the Near-RT RIC to get policies for.", - "type": "string", "required": false }, { + "schema": {"type": "string"}, "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"] + "tags": ["A1 Policy Management"] }}, "/a1-policy/v2/status": {"get": { "summary": "Returns status and statistics of this service", - "deprecated": false, - "produces": ["application/json"], - "operationId": "getStatusUsingGET", - "responses": { - "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"] + "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", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getServicesUsingGET_1", + "operationId": "getServices", "responses": { "200": { - "schema": { + "description": "OK", + "content": {"*/*": {"schema": { "type": "array", - "items": {"$ref": "#/definitions/service_status_v1"} - }, - "description": "OK" + "items": {"$ref": "#/components/schemas/service_status_v1"} + }}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Service is not found" + "description": "Service is not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "name", "description": "The name of the service", - "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }, "delete": { "summary": "Delete a service", - "deprecated": false, - "produces": ["*/*"], - "operationId": "deleteServiceUsingDELETE_1", + "operationId": "deleteService", "responses": { - "200": { - "schema": {"type": "string"}, - "description": "OK" - }, - "401": {"description": "Unauthorized"}, "204": { - "schema": {"type": "string"}, - "description": "Service deleted" + "description": "Service deleted", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} }, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Service not found" + "description": "Service not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "name", "description": "The name of the service", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] } }, "/a1-policy/v2/rics/ric": {"get": { "summary": "Returns info for one 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", + "operationId": "getRic_1", "responses": { "200": { - "schema": {"$ref": "#/definitions/ric_info_v2"}, - "description": "Near-RT RIC is found" + "description": "Near-RT RIC is found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ric_info_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC is not found" + "description": "Near-RT RIC is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [ { + "schema": {"type": "string"}, "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 }, { + "schema": {"type": "string"}, "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"] + "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": "The identity of the Near-RT RIC to get types for.", + "required": false + }], + "tags": ["A1 Policy Management"] }}, "/a1-policy/v2/policies/{policy_id}": { "get": { "summary": "Returns a policy", - "deprecated": false, - "produces": ["application/json"], - "operationId": "getPolicyUsingGET", + "operationId": "getPolicy_1", "responses": { "200": { - "schema": {"$ref": "#/definitions/policy_info_v2"}, - "description": "Policy found" + "description": "Policy found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Policy is not found" + "description": "Policy is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "path", "name": "policy_id", - "description": "policy_id", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0"] + "tags": ["A1 Policy Management"] }, "delete": { "summary": "Delete a policy", - "deprecated": false, - "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE", + "operationId": "deletePolicy_1", "responses": { - "200": {"description": "Not used"}, - "401": {"description": "Unauthorized"}, + "200": { + "description": "Not used", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} + }, "423": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC is not operational" + "description": "Near-RT RIC is not operational", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} + }, + "204": { + "description": "Policy deleted", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} }, - "204": {"description": "Policy deleted"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Policy is not found" + "description": "Policy is not found", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "path", "name": "policy_id", - "description": "policy_id", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0"] + "tags": ["A1 Policy Management"] } }, - "/a1-policy/v2/policy-types": {"get": { - "summary": "Query policy type identities", - "deprecated": false, - "produces": ["application/json"], - "operationId": "getPolicyTypesUsingGET", - "responses": { - "200": { - "schema": {"$ref": "#/definitions/policytype_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": [{ - "in": "query", - "allowEmptyValue": false, - "name": "ric_id", - "description": "The identity of the Near-RT RIC to get types for.", - "type": "string", - "required": false - }], - "tags": ["A1 Policy Management Version 2.0"] - }}, "/a1-policy/v2/configuration": { "get": { "summary": "Returns the contents of the configuration file", - "deprecated": false, - "produces": ["application/json"], "description": "Note that the file contents is not relevant if the Consul is used.", - "operationId": "getConfigurationUsingGET", + "operationId": "getConfiguration", "responses": { "200": { - "schema": {"type": "object"}, - "description": "Configuration" + "description": "Configuration", + "content": {"application/json": {"schema": {"type": "object"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "File is not found or readable" + "description": "File is not found or readable", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, - "tags": ["Component Configuration"] + "tags": ["Management of configuration"] }, "put": { "summary": "Replace the current configuration file with the given configuration", - "deprecated": false, - "produces": ["*/*"], + "requestBody": { + "content": {"application/json": {"schema": {"type": "object"}}}, + "required": true + }, "description": "Note that the file is ignored if the Consul is used.", - "operationId": "putConfigurationUsingPUT", + "operationId": "putConfiguration", "responses": { - "200": {"description": "Configuration updated"}, - "201": {"description": "Created"}, + "200": { + "description": "Configuration updated", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} + }, "400": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Invalid configuration provided" + "description": "Invalid configuration provided", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} }, - "401": {"description": "Unauthorized"}, "500": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Something went wrong when replacing the configuration. Try again." - }, - "403": {"description": "Forbidden"}, - "404": {"description": "Not Found"} + "description": "Something went wrong when replacing the configuration. Try again.", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} + } }, - "parameters": [{ - "schema": {"type": "object"}, - "in": "body", - "name": "configuration", - "description": "configuration", - "required": true - }], - "tags": ["Component Configuration"], - "consumes": ["application/json"] + "tags": ["Management of configuration"] } }, "/policy": { "get": { "summary": "Returns a policy configuration", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPolicyUsingGET_1", + "operationId": "getPolicy", "responses": { "200": { - "schema": {"type": "object"}, - "description": "Policy found" + "description": "Policy found", + "content": {"*/*": {"schema": {"type": "object"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Policy is not found" + "description": "Policy is not found", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "id", "description": "The identity of the policy instance.", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }, "delete": { "summary": "Delete a policy", - "deprecated": false, - "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE_1", + "operationId": "deletePolicy", "responses": { - "200": {"description": "Not used"}, - "401": {"description": "Unauthorized"}, + "200": { + "description": "Not used", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} + }, "423": { - "schema": {"type": "string"}, - "description": "Near-RT RIC is not operational" + "description": "Near-RT RIC is not operational", + "content": {"*/*": {"schema": {"type": "string"}}} + }, + "204": { + "description": "Policy deleted", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} }, - "204": {"description": "Policy deleted"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Policy is not found" + "description": "Policy is not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "id", "description": "The identity of the policy instance.", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }, "put": { "summary": "Put a policy", - "deprecated": false, - "produces": ["*/*"], - "operationId": "putPolicyUsingPUT_1", + "requestBody": { + "content": {"application/json": {"schema": {"type": "object"}}}, + "required": true + }, + "operationId": "putPolicy", "responses": { - "200": {"description": "Policy updated"}, - "201": {"description": "Policy created"}, - "401": {"description": "Unauthorized"}, + "200": { + "description": "Policy updated", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} + }, + "201": { + "description": "Policy created", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} + }, "423": { - "schema": {"type": "string"}, - "description": "Near-RT RIC is not operational" + "description": "Near-RT RIC is not operational", + "content": {"*/*": {"schema": {"type": "string"}}} }, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Near-RT RIC or policy type is not found" + "description": "Near-RT RIC or policy type is not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [ { + "schema": { + "default": "", + "type": "string" + }, "in": "query", - "allowEmptyValue": false, - "name": "id", - "description": "The identity of the policy instance.", - "type": "string", - "required": true + "name": "type", + "description": "The name of the policy type.", + "required": false }, { - "schema": {"type": "object"}, - "in": "body", - "name": "jsonBody", - "description": "jsonBody", + "schema": {"type": "string"}, + "in": "query", + "name": "id", + "description": "The identity of the policy instance.", "required": true }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "ric", "description": "The name of the Near-RT RIC where the policy will be created.", - "type": "string", "required": true }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "service", "description": "The name of the service creating the policy.", - "type": "string", "required": true }, { - "default": false, + "schema": { + "default": false, + "type": "boolean" + }, "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": ["A1 Policy Management Version 1.0 (deprecated)"], - "consumes": ["application/json"] + "tags": ["A1 Policy Management V1.0"] } }, "/policies": {"get": { "summary": "Query policies", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPoliciesUsingGET", + "operationId": "getPolicies", "responses": { "200": { - "schema": { + "description": "Policies", + "content": {"*/*": {"schema": { "type": "array", - "items": {"$ref": "#/definitions/policy_info_v1"} - }, - "description": "Policies" + "items": {"$ref": "#/components/schemas/policy_info_v1"} + }}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Near-RT RIC or type not found" + "description": "Near-RT RIC or type not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [ { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "ric", - "description": "The name of the Near-RT RIC to get policies for.", - "type": "string", + "name": "type", + "description": "The name of the policy type to get policies for.", "required": false }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "service", - "description": "The name of the service to get policies for.", - "type": "string", + "name": "ric", + "description": "The name of the Near-RT RIC to get policies for.", "required": false }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "type", - "description": "The name of the policy type to get policies for.", - "type": "string", + "name": "service", + "description": "The name of the service to get policies for.", "required": false } ], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, "/a1-policy/v2/services/{service_id}/keepalive": {"put": { "summary": "Heartbeat indicates that the service is running", - "deprecated": false, - "produces": ["*/*"], - "operationId": "keepAliveServiceUsingPUT", + "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": { - "schema": {"type": "object"}, - "description": "Service supervision timer refreshed, OK" + "description": "Service supervision timer refreshed, OK", + "content": {"*/*": {"schema": {"type": "object"}}} }, - "201": {"description": "Created"}, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "The service is not found, needs re-registration" + "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", - "description": "service_id", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0"], - "consumes": ["application/json"] + "tags": ["Service Registry and Supervision"] }}, - "/policy_schema": {"get": { - "summary": "Returns one policy type schema definition", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPolicySchemaUsingGET", + "/rics": {"get": { + "summary": "Query Near-RT RIC information", + "operationId": "getRics", "responses": { "200": { - "schema": {"type": "object"}, - "description": "Policy schema" + "description": "OK", + "content": {"*/*": {"schema": { + "type": "array", + "items": {"$ref": "#/components/schemas/ric_info_v1"} + }}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "The policy type is not found" + "description": "Policy type is not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "id", - "description": "The identity of the policy type to get the definition for.", - "type": "string", - "required": true + "name": "policyType", + "description": "The name of the policy type", + "required": false }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, - "/rics": {"get": { - "summary": "Query Near-RT RIC information", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getRicsUsingGET", + "/policy_schema": {"get": { + "summary": "Returns one policy type schema definition", + "operationId": "getPolicySchema", "responses": { "200": { - "schema": { - "type": "array", - "items": {"$ref": "#/definitions/ric_info_v1"} - }, - "description": "OK" + "description": "Policy schema", + "content": {"*/*": {"schema": {"type": "object"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Policy type is not found" + "description": "The policy type is not found", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "policyType", - "description": "The name of the policy type", - "type": "string", - "required": false + "name": "id", + "description": "The identity of the policy type to get the definition for.", + "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, "/policy_status": {"get": { "summary": "Returns a policy status", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPolicyStatusUsingGET_1", + "operationId": "getPolicyStatus", "responses": { "200": { - "schema": {"type": "object"}, - "description": "Policy status" + "description": "Policy status", + "content": {"*/*": {"schema": {"type": "object"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Policy is not found" + "description": "Policy is not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "id", "description": "The identity of the policy.", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, "/a1-policy/v2/rics": {"get": { "summary": "Query Near-RT RIC information", - "deprecated": false, - "produces": ["application/json"], "description": "The call returns all Near-RT RICs that supports a given policy type identity", - "operationId": "getRicsUsingGET_1", + "operationId": "getRics_1", "responses": { "200": { - "schema": {"$ref": "#/definitions/ric_info_list_v2"}, - "description": "OK" + "description": "OK", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ric_info_list_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Policy type is not found" + "description": "Policy type is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "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"] + "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", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPolicyIdsUsingGET_1", + "operationId": "getPolicyIds", "responses": { "200": { - "schema": { + "description": "Policy identitiess", + "content": {"*/*": {"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" + "description": "Near-RT RIC or type not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [ { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "ric", - "description": "The name of the Near-RT RIC to get policies for.", - "type": "string", + "name": "type", + "description": "The name of the policy type to get policies for.", "required": false }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "service", - "description": "The name of the service to get policies for.", - "type": "string", + "name": "ric", + "description": "The name of the Near-RT RIC to get policies for.", "required": false }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, - "name": "type", - "description": "The name of the policy type to get policies for.", - "type": "string", + "name": "service", + "description": "The name of the service to get policies for.", "required": false } ], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] - }}, - "/policy_schemas": {"get": { - "summary": "Returns policy type schema definitions", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getPolicySchemasUsingGET", - "responses": { - "200": { - "schema": { - "type": "array", - "items": {"type": "object"} - }, - "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": "ric", - "description": "The name of the Near-RT RIC to get the definitions for.", - "type": "string", - "required": false - }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, "/a1-policy/v2/services": { "get": { "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", + "operationId": "getServices_1", "responses": { "200": { - "schema": {"$ref": "#/definitions/service_list_v2"}, - "description": "OK" + "description": "OK", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_list_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Service is not found" + "description": "Service is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "service_id", "description": "The identity of the service", - "type": "string", "required": false }], - "tags": ["A1 Policy Management Version 2.0"] + "tags": ["Service Registry and Supervision"] }, "put": { "summary": "Register a service", - "deprecated": false, - "produces": ["*/*"], + "requestBody": { + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_registration_info_v2"}}}, + "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": "putServiceUsingPUT", + "operationId": "putService_1", "responses": { "200": { - "schema": {"type": "object"}, - "description": "Service updated" + "description": "Service updated", + "content": {"*/*": {"schema": {"type": "object"}}} }, "201": { - "schema": {"type": "object"}, - "description": "Service created" + "description": "Service created", + "content": {"*/*": {"schema": {"type": "object"}}} }, "400": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "The ServiceRegistrationInfo is not accepted" - }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, - "404": {"description": "Not Found"} + "description": "The ServiceRegistrationInfo is not accepted", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} + } }, - "parameters": [{ - "schema": {"$ref": "#/definitions/service_registration_info_v2"}, - "in": "body", - "name": "registrationInfo", - "description": "registrationInfo", - "required": true - }], - "tags": ["A1 Policy Management Version 2.0"], - "consumes": ["application/json"] + "tags": ["Service Registry and Supervision"] } }, "/ric": {"get": { "summary": "Returns the name of a RIC managing one Mananged Element", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getRicUsingGET", + "operationId": "getRic", "responses": { "200": { - "schema": {"type": "string"}, - "description": "Near-RT RIC is found" + "description": "Near-RT RIC is found", + "content": {"*/*": {"schema": {"type": "string"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"type": "string"}, - "description": "Near-RT RIC is not found" + "description": "Near-RT RIC is not found", + "content": {"*/*": {"schema": {"type": "string"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "managedElementId", "description": "The identity of the Managed Element", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management V1.0"] }}, "/services/keepalive": {"put": { "summary": "Heartbeat from a service", - "deprecated": false, - "produces": ["*/*"], - "operationId": "keepAliveServiceUsingPUT_1", + "operationId": "keepAliveService", "responses": { "200": { - "schema": {"type": "string"}, - "description": "Service supervision timer refreshed, OK" + "description": "Service supervision timer refreshed, OK", + "content": {"*/*": {"schema": {"type": "string"}}} }, - "201": {"description": "Created"}, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, - "404": {"description": "The service is not found, needs re-registration"} + "404": { + "description": "The service is not found, needs re-registration", + "content": {"*/*": {"schema": {"type": "string"}}} + } }, "parameters": [{ + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "name", "description": "The name of the service", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 1.0 (deprecated)"], - "consumes": ["application/json"] + "tags": ["A1 Policy Management V1.0"] + }}, + "/status": {"get": { + "summary": "Returns status and statistics of this service", + "operationId": "getStatus", + "responses": {"200": { + "description": "Service is living", + "content": {"*/*": {"schema": {"type": "string"}}} + }}, + "tags": ["A1 Policy Management V1.0"] }}, "/a1-policy/v2/policy-types/{policytype_id}": {"get": { "summary": "Returns a policy type definition", - "deprecated": false, - "produces": ["application/json"], - "operationId": "getPolicyTypeUsingGET", + "operationId": "getPolicyType", "responses": { "200": { - "schema": {"$ref": "#/definitions/policytype_v2"}, - "description": "Policy type" + "description": "Policy type", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/policytype_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Policy type is not found" + "description": "Policy type is not found", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "path", "name": "policytype_id", - "description": "policytype_id", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0"] - }}, - "/status": {"get": { - "summary": "Returns status and statistics of this service", - "deprecated": false, - "produces": ["*/*"], - "operationId": "getStatusUsingGET_1", - "responses": { - "200": { - "schema": {"type": "string"}, - "description": "Service is living" - }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, - "404": {"description": "Not Found"} - }, - "tags": ["A1 Policy Management Version 1.0 (deprecated)"] + "tags": ["A1 Policy Management"] }}, "/a1-policy/v2/policies": { "get": { "summary": "Query policy identities", - "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", + "operationId": "getPolicyIds_1", "responses": { "200": { - "schema": {"$ref": "#/definitions/policy_id_list_v2"}, - "description": "Policy identities" + "description": "Policy identities", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_id_list_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC or type not found" + "description": "Near-RT RIC or type not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [ { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "policytype_id", "description": "The identity of the policy type to get policies for.", - "type": "string", "required": false }, { + "schema": {"type": "string"}, "in": "query", - "allowEmptyValue": false, "name": "ric_id", "description": "The identity of the Near-RT RIC to get policies for.", - "type": "string", "required": false }, { + "schema": {"type": "string"}, "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"] + "tags": ["A1 Policy Management"] }, "put": { "summary": "Create or update a policy", - "deprecated": false, - "produces": ["application/json"], - "operationId": "putPolicyUsingPUT", + "requestBody": { + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}}, + "required": true + }, + "operationId": "putPolicy_1", "responses": { - "200": {"description": "Policy updated"}, - "201": {"description": "Policy created"}, - "401": {"description": "Unauthorized"}, + "200": { + "description": "Policy updated", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} + }, + "201": { + "description": "Policy created", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} + }, "423": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC is not operational" + "description": "Near-RT RIC is not operational", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} }, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Near-RT RIC or policy type is not found" + "description": "Near-RT RIC or policy type is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, - "parameters": [{ - "schema": {"$ref": "#/definitions/policy_info_v2"}, - "in": "body", - "name": "policyInfo", - "description": "policyInfo", - "required": true - }], - "tags": ["A1 Policy Management Version 2.0"], - "consumes": ["application/json"] + "tags": ["A1 Policy Management"] } }, - "/r-app/pms-callback": {"post": { + "/r-app/near-rt-ric-status": {"post": { "summary": "Callback for Near-RT RIC status", - "deprecated": false, - "produces": ["application/json"], + "requestBody": { + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_callback_info_v2"}}}, + "required": true + }, "description": "The URL to this call is registerred at Service registration.", - "operationId": "jobStatusCallbackUsingPOST", + "operationId": "jobStatusCallback", + "responses": {"200": { + "description": "OK", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} + }}, + "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": "OK"}, - "201": {"description": "Created"}, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, - "404": {"description": "Not Found"} + "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"}}} + } }, - "parameters": [{ - "schema": {"$ref": "#/definitions/service_callback_info_v2"}, - "in": "body", - "name": "body", - "description": "body", - "required": true - }], - "tags": ["R-App Callbacks"], - "consumes": ["application/json"] + "tags": ["A1 Policy Management V1.0"] }}, "/a1-policy/v2/services/{service_id}": {"delete": { "summary": "Unregister a service", - "deprecated": false, - "produces": ["*/*"], - "operationId": "deleteServiceUsingDELETE", + "operationId": "deleteService_1", "responses": { - "200": {"description": "Not used"}, - "401": {"description": "Unauthorized"}, + "200": { + "description": "Not used", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} + }, "204": { - "schema": {"type": "object"}, - "description": "Service unregistered" + "description": "Service unregistered", + "content": {"*/*": {"schema": {"type": "object"}}} }, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Service not found" + "description": "Service not found", + "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "path", "name": "service_id", - "description": "service_id", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.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 (deprecated)"], - "consumes": ["application/json"] + "tags": ["Service Registry and Supervision"] }}, "/a1-policy/v2/policies/{policy_id}/status": {"get": { "summary": "Returns a policy status", - "deprecated": false, - "produces": ["application/json"], - "operationId": "getPolicyStatusUsingGET", + "operationId": "getPolicyStatus_1", "responses": { "200": { - "schema": {"$ref": "#/definitions/policy_status_info_v2"}, - "description": "Policy status" + "description": "Policy status", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_status_info_v2"}}} }, - "401": {"description": "Unauthorized"}, - "403": {"description": "Forbidden"}, "404": { - "schema": {"$ref": "#/definitions/error_information"}, - "description": "Policy is not found" + "description": "Policy is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} } }, "parameters": [{ + "schema": {"type": "string"}, "in": "path", "name": "policy_id", - "description": "policy_id", - "type": "string", "required": true }], - "tags": ["A1 Policy Management Version 2.0"] + "tags": ["A1 Policy Management"] }} }, - "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 - } - } - }, - "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" - } - } - }, - "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: \nUNAVAILABLE: The Near-RT RIC is not avialable, information may be inconsistent \nAVAILABLE: The normal state. Policies can be configured. +\nSYNCHRONIZING: The Policy Management Service is synchronizing the view of the Near-RT RIC. Policies cannot be configured. \nCONSISTENCY_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" - ] - }, - "policytype_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 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" - } - } - }, - "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_status_info_v2": { - "description": "Status for one A1-P Policy", - "type": "object", - "title": "policy_status_info_v2", - "properties": { - "last_modified": { - "description": "timestamp, last modification time", - "type": "string" - }, - "status": { - "description": "the Policy status", - "type": "object" - } - } - }, - "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" - } - } - }, - "policytype_v2": { - "description": "Policy type", - "type": "object", - "title": "policytype_v2", - "properties": {"policy_schema": { - "description": "Policy type json scema. The schema is a json object following http://json-schema.org/draft-07/schema", - "type": "object" - }} - }, - "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"} - }} - }, - "policytype_id_list_v2": { - "description": "Information about policy types", - "type": "object", - "title": "policytype_id_list_v2", - "properties": {"policytype_ids": { - "description": "Policy type identities", - "type": "array", - "items": {"type": "string"} - }} - }, - "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", - "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 name 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" - } - } - }, - "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"} - }} - }, - "service_callback_info_v2": { - "description": "Information transferred as in Service callbacks (callback_url)", - "type": "object", - "title": "service_callback_info_v2", - "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"] - } - } - } - }, - "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" + "license": { + "name": "Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.", + "url": "http://www.apache.org/licenses/LICENSE-2.0" }, - "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>", + "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>", "title": "A1 Policy management service", "version": "1.1.0" }, "tags": [ { - "name": "A1 Policy Management Version 1.0 (deprecated)", - "description": "Policy Controller" - }, - { - "name": "A1 Policy Management Version 2.0", - "description": "Policy Controller" + "name": "A1 Policy Management V1.0", + "description": "(deprecated primitves)" }, - { - "name": "Component Configuration", - "description": "Configuration Controller" - }, - { - "name": "R-App Callbacks", - "description": "Rapp Simulator Controller" - } + {"name": "Management of configuration"}, + {"name": "A1 Policy Management"}, + {"name": "NearRT-RIC Repository"}, + {"name": "Service Registry and Supervision"}, + {"name": "Health Check"}, + {"name": "Callbacks"} ] }
\ No newline at end of file |