From ecd99896ee598c29a228c8acbf2e72f81310a42e Mon Sep 17 00:00:00 2001 From: lapentafd Date: Fri, 9 Aug 2024 11:35:29 +0100 Subject: Set serviceId in v2 policy_info to optional and blank by default - master Issue-ID: CCSDK-4044 Change-Id: I607062cadf46d4f84b1285c24140105e1e7ad05e Signed-off-by: lapentafd --- a1-policy-management/api/pms-api.json | 2884 +++++++++++------ a1-policy-management/api/pms-api.yaml | 2 +- a1-policy-management/api/pms-api/index.html | 4458 +++++++++------------------ 3 files changed, 3387 insertions(+), 3957 deletions(-) (limited to 'a1-policy-management/api') diff --git a/a1-policy-management/api/pms-api.json b/a1-policy-management/api/pms-api.json index 33fa5e18..5dd8b493 100644 --- a/a1-policy-management/api/pms-api.json +++ b/a1-policy-management/api/pms-api.json @@ -1,1020 +1,1866 @@ -{ - "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" - }} - }, - "authorization_result": { - "description": "Result of authorization", - "type": "object", - "required": ["result"], - "properties": {"result": { - "description": "If true, the access is granted", - "type": "boolean" - }} - }, - "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 used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.", - "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"} - }} - }, - "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 schema. The schema is a json object following http://json-schema.org/draft-07/schema", - "type": "object" - }} - }, - "input": { - "description": "input", - "type": "object", - "required": [ - "access_type", - "auth_token", - "policy_type_id" - ], - "properties": { - "access_type": { - "description": "Access type", - "type": "string", - "enum": [ - "READ", - "WRITE", - "DELETE" - ] - }, - "auth_token": { - "description": "Authorization token", - "type": "string" - }, - "policy_type_id": { - "description": "Policy type identifier", - "type": "string" - } - } - }, - "policy_authorization": { - "description": "Authorization request for A1 policy requests", - "type": "object", - "required": ["input"], - "properties": {"input": {"$ref": "#/components/schemas/input"}} - }, - "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" - ], - "properties": { - "ric_id": { - "description": "identity of the target Near-RT RIC", - "type": "string" - }, - "policy_id": { - "description": "identity of the policy", - "type": "string" - }, - "transient": { - "default": false, - "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", - "example": false - }, - "service_id": { - "description": "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered.", - "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"] - } - } - }, - "Link": { - "type": "object", - "properties": { - "templated": {"type": "boolean"}, - "href": {"type": "string"} - } - } - }}, - "openapi": "3.0.1", - "paths": { - "/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"] - }}, - "/example-authz-check": {"post": { - "summary": "Request for access authorization.", - "requestBody": { - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_authorization"}}}, - "required": true - }, - "description": "The authorization function decides if access is granted.", - "operationId": "performAccessControl", - "responses": {"200": { - "description": "OK", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/authorization_result"}}} - }}, - "tags": ["Authorization API"] - }}, - "/actuator/threaddump": {"get": { - "summary": "Actuator web endpoint 'threaddump'", - "operationId": "threaddump", - "responses": {"200": { - "description": "OK", - "content": { - "text/plain;charset=UTF-8": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/a1-policy/v2/status": {"get": { - "summary": "Returns status and statistics of this service", - "operationId": "getStatus", - "responses": {"200": { - "description": "Service is living", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/status_info_v2"}}} - }}, - "tags": ["Health Check"] - }}, - "/actuator/loggers": {"get": { - "summary": "Actuator web endpoint 'loggers'", - "operationId": "loggers", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/actuator/health/**": {"get": { - "summary": "Actuator web endpoint 'health-path'", - "operationId": "health-path", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/a1-policy/v2/rics/ric": {"get": { - "summary": "Returns info for one Near-RT RIC", - "description": "Either a Near-RT RIC identity or a Managed Element identity can be specified.
The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", - "operationId": "getRic", - "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"] - }}, - "/actuator/shutdown": {"post": { - "summary": "Actuator web endpoint 'shutdown'", - "operationId": "shutdown", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/a1-policy/v2/policy-types": {"get": { - "summary": "Query policy type identities", - "operationId": "getPolicyTypes", - "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": "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. Matching types will be returned sorted in ascending order.", - "required": false - } - ], - "tags": ["A1 Policy Management"] - }}, - "/a1-policy/v2/policies/{policy_id}": { - "get": { - "summary": "Returns a policy", - "operationId": "getPolicy", - "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", - "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"] - } - }, - "/actuator/metrics/{requiredMetricName}": {"get": { - "summary": "Actuator web endpoint 'metrics-requiredMetricName'", - "operationId": "metrics-requiredMetricName", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "requiredMetricName", - "required": true - }], - "tags": ["Actuator"] - }}, - "/a1-policy/v2/configuration": { - "get": { - "summary": "Returns the contents of the application configuration file", - "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 - }, - "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"] - } - }, - "/actuator": {"get": { - "summary": "Actuator root web endpoint", - "operationId": "links", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": { - "additionalProperties": { - "additionalProperties": {"$ref": "#/components/schemas/Link"}, - "type": "object" - }, - "type": "object" - }}, - "application/json": {"schema": { - "additionalProperties": { - "additionalProperties": {"$ref": "#/components/schemas/Link"}, - "type": "object" - }, - "type": "object" - }}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": { - "additionalProperties": { - "additionalProperties": {"$ref": "#/components/schemas/Link"}, - "type": "object" - }, - "type": "object" - }} - } - }}, - "tags": ["Actuator"] - }}, - "/actuator/loggers/{name}": { - "post": { - "summary": "Actuator web endpoint 'loggers-name'", - "requestBody": {"content": {"application/json": {"schema": { - "type": "string", - "enum": [ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL", - "OFF" - ] - }}}}, - "operationId": "loggers-name_2", - "responses": {"200": { - "description": "OK", - "content": {"*/*": {"schema": {"type": "object"}}} - }}, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "name", - "required": true - }], - "tags": ["Actuator"] - }, - "get": { - "summary": "Actuator web endpoint 'loggers-name'", - "operationId": "loggers-name", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "name", - "required": true - }], - "tags": ["Actuator"] - } - }, - "/a1-policy/v2/services/{service_id}/keepalive": {"put": { - "summary": "Heartbeat indicates that the service is running", - "description": "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)", - "operationId": "keepAliveService", - "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"] - }}, - "/actuator/metrics": {"get": { - "summary": "Actuator web endpoint 'metrics'", - "operationId": "metrics", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/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", - "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 supporting the policy type are returned", - "required": false - }], - "tags": ["NearRT-RIC Repository"] - }}, - "/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", - "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:
  • Get callbacks about available NearRT RICs.<\/li>
  • Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.<\/li><\/ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", - "operationId": "putService", - "responses": { - "200": { - "description": "Service updated", - "content": {"*/*": {"schema": {"type": "object"}}} - }, - "201": { - "description": "Service created", - "content": {"*/*": {"schema": {"type": "object"}}} - }, - "400": { - "description": "The ServiceRegistrationInfo is not accepted", - "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} - } - }, - "tags": ["Service Registry and Supervision"] - } - }, - "/actuator/info": {"get": { - "summary": "Actuator web endpoint 'info'", - "operationId": "info", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/status": {"get": { - "summary": "Returns status and statistics of this service", - "operationId": "getStatusV1", - "responses": {"200": { - "description": "Service is living", - "content": {"*/*": {"schema": {"type": "string"}}} - }}, - "tags": ["Health Check"] - }}, - "/a1-policy/v2/policy-types/{policytype_id}": {"get": { - "summary": "Returns a policy type definition", - "operationId": "getPolicyType", - "responses": { - "200": { - "description": "Policy type", - "content": {"*/*": {"schema": {"$ref": "#/components/schemas/policytype_v2"}}} - }, - "404": { - "description": "Policy type is not found", - "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} - } - }, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "policytype_id", - "required": true - }], - "tags": ["A1 Policy Management"] - }}, - "/actuator/logfile": {"get": { - "summary": "Actuator web endpoint 'logfile'", - "operationId": "logfile", - "responses": {"200": { - "description": "OK", - "content": {"text/plain;charset=UTF-8": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] - }}, - "/actuator/health": {"get": { - "summary": "Actuator web endpoint 'health'", - "operationId": "health", - "responses": {"200": { - "description": "OK", - "content": { - "application/vnd.spring-boot.actuator.v3+json": {"schema": {"type": "object"}}, - "application/json": {"schema": {"type": "object"}}, - "application/vnd.spring-boot.actuator.v2+json": {"schema": {"type": "object"}} - } - }}, - "tags": ["Actuator"] - }}, - "/a1-policy/v2/policies": { - "get": { - "summary": "Query policy identities", - "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": "getPolicyIds", - "responses": { - "200": { - "description": "Policy identities", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_id_list_v2"}}} - }, - "404": { - "description": "Near-RT RIC or type not found", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} - } - }, - "parameters": [ - { - "schema": {"type": "string"}, - "in": "query", - "name": "policytype_id", - "description": "Select policies of a given policy type identity.", - "required": false - }, - { - "schema": {"type": "string"}, - "in": "query", - "name": "ric_id", - "description": "Select policies of 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 types with the given type name (type identity has the format )", - "required": false - } - ], - "tags": ["A1 Policy Management"] - }, - "put": { - "summary": "Create or update a policy", - "requestBody": { - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}}, - "required": true - }, - "operationId": "putPolicy", - "responses": { - "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": { - "description": "Near-RT RIC is not operational", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} - }, - "404": { - "description": "Near-RT RIC or policy type is not found", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} - } - }, - "tags": ["A1 Policy Management"] - } - }, - "/r-app/near-rt-ric-status": {"post": { - "summary": "Callback for Near-RT RIC status", - "requestBody": { - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_callback_info_v2"}}}, - "required": true - }, - "description": "The URL to this call is registered at Service registration.", - "operationId": "serviceCallback", - "responses": {"200": { - "description": "OK", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} - }}, - "tags": ["Service callbacks"] - }}, - "/a1-policy/v2/services/{service_id}": {"delete": { - "summary": "Unregister a service", - "operationId": "deleteService", - "responses": { - "200": { - "description": "Not used", - "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}} - }, - "204": { - "description": "Service unregistered", - "content": {"*/*": {"schema": {"type": "object"}}} - }, - "404": { - "description": "Service not found", - "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}} - } - }, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "service_id", - "required": true - }], - "tags": ["Service Registry and Supervision"] - }}, - "/actuator/heapdump": {"get": { - "summary": "Actuator web endpoint 'heapdump'", - "operationId": "heapdump", - "responses": {"200": { - "description": "OK", - "content": {"application/octet-stream": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] - }}, - "/a1-policy/v2/policies/{policy_id}/status": {"get": { - "summary": "Returns a policy status", - "operationId": "getPolicyStatus", - "responses": { - "200": { - "description": "Policy status", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_status_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"] - }} - }, - "info": { - "license": { - "name": "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - }, - "description": "

    General<\/h2>

    The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies.
    The main tasks of the service are:<\/p>

    • A1 Policy creation, modification and deletion.<\/li>
    • Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs<\/li>
    • Maintaining a view of supported Near-RT RIC policy types<\/li>
    • Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.<\/li><\/ul>

      APIs provided or defined by the service<\/h2>

      A1 Policy Management<\/h3>

      This is an API for management of A1 Policies.<\/p>

      • A1 Policy retrieval, creation, modification and deletion.<\/li>
      • Retrieval of supported A1 Policy types for a Near-RT RIC<\/li>
      • Retrieval of status for existing A1 policies<\/li><\/ul>

        Management of configuration<\/h3>

        API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.<\/p>

        Service callbacks<\/h3>

        These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.<\/p>

        NearRT-RIC Repository<\/h3>

        This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.<\/p>

        Health Check<\/h3>

        API used for supervision of the PMS component.<\/p>

        Service Registry and Supervision<\/h3>

        API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.<\/p>

        Authorization API<\/h3>

        API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.<\/p>

        Spring Boot Actuator<\/h3>

        Provides generic functions used to monitor and manage the Spring web application.<\/p>", - "title": "A1 Policy Management Service", - "version": "1.2.0" - }, - "tags": [ - { - "name": "Authorization API", - "description": "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA).\nNote that this API is called by PMS, it is not provided.\n" - }, - { - "name": "Actuator", - "description": "Monitor and interact", - "externalDocs": { - "description": "Spring Boot Actuator Web API Documentation", - "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" - } - } - ] +{ + "openapi" : "3.0.3", + "info" : { + "title" : "A1 Policy Management Service", + "description" : "

        General

        The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
        The main tasks of the service are:

        • A1 Policy creation, modification and deletion.
        • Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
        • Maintaining a view of supported Near-RT RIC policy types
        • Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

        APIs provided or defined by the service

        A1 Policy Management

        This is an API for management of A1 Policies.

        • A1 Policy retrieval, creation, modification and deletion.
        • Retrieval of supported A1 Policy types for a Near-RT RIC
        • Retrieval of status for existing A1 policies

        Management of configuration

        API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

        Service callbacks

        These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

        NearRT-RIC Repository

        This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

        Health Check

        API used for supervision of the PMS component.

        Service Registry and Supervision

        API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.

        Authorization API

        API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

        Spring Boot Actuator

        Provides generic functions used to monitor and manage the Spring web application.

        ", + "contact" : { + "url" : "https://www.onap.org/", + "email" : "discuss-list@onap.com" + }, + "license" : { + "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "version" : "1.3.0", + "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", + "x-audience" : "external-public" + }, + "servers" : [ { + "url" : "/" + } ], + "tags" : [ { + "name" : "A1 Policy Management", + "description" : "API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances." + }, { + "name" : "NearRT-RIC Repository", + "description" : "API used to get the NearRT-RIC for the managed element." + }, { + "name" : "Service Registry and Supervision", + "description" : "API used to keep the service Alive with in the timeout period" + }, { + "name" : "Health Check", + "description" : "API used to get the health status and statistics of this service" + }, { + "name" : "Service callbacks" + }, { + "name" : "Authorization API", + "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA).
        Note that this API is called by PMS, it is not provided." + }, { + "name" : "Configuration", + "description" : "API used to create or fetch the application configuration." + }, { + "name" : "Actuator", + "description" : "Monitor and interact", + "externalDocs" : { + "description" : "Spring Boot Actuator Web API Documentation", + "url" : "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" + } + } ], + "paths" : { + "/a1-policy/v2/policy-instances" : { + "get" : { + "tags" : [ "A1 Policy Management" ], + "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", + "parameters" : [ { + "name" : "policytype_id", + "in" : "query", + "description" : "Select policies with a given type identity.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "ric_id", + "in" : "query", + "description" : "Select policies for a given Near-RT RIC identity.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "service_id", + "in" : "query", + "description" : "Select policies owned by a given service.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "type_name", + "in" : "query", + "description" : "Select policies of a given type name (type identity has the format )", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Returns A1 Policies which matches the criteria", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_info_list" + }, + "examples" : { + "policy_info_list" : { + "$ref" : "#/components/examples/policy_info_list" + } + } + } + } + }, + "404" : { + "description" : "Not Found - Near-RT RIC, policy type or service not found", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + } + } + } + } + }, + "/example-authz-check" : { + "post" : { + "tags" : [ "Authorization API" ], + "summary" : "Request for access authorization.", + "description" : "The authorization function decides if access is granted.", + "operationId" : "performAccessControl", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_authorization" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/authorization_result" + } + } + } + }, + "403" : { + "description" : "Forbidden", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 403, + "title" : "Forbidden", + "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." + } + } + } + } + } + } + }, + "/actuator/threaddump" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'threaddump'", + "operationId" : "threaddump", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain;charset=UTF-8" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/status" : { + "get" : { + "tags" : [ "Health Check" ], + "description" : "Returns status and statistics of this service", + "operationId" : "getStatus", + "responses" : { + "200" : { + "description" : "OK- Service is living Ok", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/status_info" + }, + "examples" : { + "status_info" : { + "$ref" : "#/components/examples/status_info" + } + } + } + } + } + } + } + }, + "/actuator/loggers" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'loggers'", + "operationId" : "loggers", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/actuator/health/**" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'health-path'", + "operationId" : "health-path", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/rics/ric" : { + "get" : { + "tags" : [ "NearRT-RIC Repository" ], + "summary" : "Returns info of Near-RT RIC queried by the ric-id and managed-element-id", + "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.
        The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", + "operationId" : "getRic", + "parameters" : [ { + "name" : "managed_element_id", + "in" : "query", + "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "ric_id", + "in" : "query", + "description" : "The identity of a Near-RT RIC to get information for.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Near-RT RIC is found", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ric_info" + }, + "examples" : { + "ric_info" : { + "$ref" : "#/components/examples/ric_info" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + }, + "/actuator/shutdown" : { + "post" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'shutdown'", + "operationId" : "shutdown", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/policy-types" : { + "get" : { + "tags" : [ "A1 Policy Management" ], + "description" : "Query policy type identities", + "operationId" : "getPolicyTypes", + "parameters" : [ { + "name" : "ric_id", + "in" : "query", + "description" : "Select types for the given Near-RT RIC identity.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "type_name", + "in" : "query", + "description" : "Select types with the given type name (type identity has the format )", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "compatible_with_version", + "in" : "query", + "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. Matching types will be returned sorted in ascending order.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Policy Type IDs Found", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_type_id_list" + }, + "examples" : { + "policy_type_id_list" : { + "$ref" : "#/components/examples/policy_type_id_list" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + }, + "/a1-policy/v2/policies/{policy_id}" : { + "get" : { + "tags" : [ "A1 Policy Management" ], + "description" : "Returns a policy", + "operationId" : "getPolicy", + "parameters" : [ { + "name" : "policy_id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Policy found", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_info" + }, + "examples" : { + "policy_info" : { + "$ref" : "#/components/examples/policy_info" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + }, + "delete" : { + "tags" : [ "A1 Policy Management" ], + "summary" : "Delete a policy", + "description" : "Deleting the policy using the Policy's Policy ID.", + "operationId" : "deletePolicy", + "parameters" : [ { + "name" : "policy_id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Policy deleted", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + } + }, + "423" : { + "description" : "Locked - HTTP Status code which can be used when the state is Locked", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + } + } + } + } + } + } + }, + "/actuator/metrics/{requiredMetricName}" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'metrics-requiredMetricName'", + "operationId" : "metrics-requiredMetricName", + "parameters" : [ { + "name" : "requiredMetricName", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/configuration" : { + "get" : { + "tags" : [ "Configuration" ], + "description" : "Returns the contents of the application configuration file", + "operationId" : "getConfiguration", + "responses" : { + "200" : { + "description" : "OK - Configuration", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + }, + "x-internal" : true + }, + "put" : { + "tags" : [ "Configuration" ], + "description" : "Replace the current configuration with the given configuration", + "operationId" : "putConfiguration", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "object" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK - Configuration updated", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + } + } + } + } + }, + "x-internal" : true + } + }, + "/actuator" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator root web endpoint", + "operationId" : "links", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Link" + } + } + } + }, + "application/json" : { + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Link" + } + } + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Link" + } + } + } + } + } + } + }, + "x-internal" : true + } + }, + "/actuator/loggers/{name}" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'loggers-name'", + "operationId" : "loggers-name", + "parameters" : [ { + "name" : "name", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + }, + "post" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'loggers-name'", + "operationId" : "loggers-name_2", + "parameters" : [ { + "name" : "name", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ] + } + } + } + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/services/{service_id}/keepalive" : { + "put" : { + "tags" : [ "Service Registry and Supervision" ], + "summary" : "Heartbeat indicates that the service is running", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)", + "operationId" : "keepAliveService", + "parameters" : [ { + "name" : "service_id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Service supervision timer refreshed, OK", + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + }, + "/actuator/metrics" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'metrics'", + "operationId" : "metrics", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/rics" : { + "get" : { + "tags" : [ "NearRT-RIC Repository" ], + "summary" : "Query Near-RT RIC information", + "description" : "The call returns all Near-RT RICs that supports a given policy type identity", + "operationId" : "getRics", + "parameters" : [ { + "name" : "policytype_id", + "in" : "query", + "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ric_info_list" + }, + "examples" : { + "ric_info_list" : { + "$ref" : "#/components/examples/ric_info_list" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + }, + "/a1-policy/v2/services" : { + "get" : { + "tags" : [ "Service Registry and Supervision" ], + "summary" : "Returns service information", + "description" : "Either information about a registered service with given identity or all registered services are returned.", + "operationId" : "getServices", + "parameters" : [ { + "name" : "service_id", + "in" : "query", + "description" : "The identity of the service", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/service_status_list" + }, + "examples" : { + "service_status_list" : { + "$ref" : "#/components/examples/service_status_list" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + }, + "put" : { + "tags" : [ "Service Registry and Supervision" ], + "summary" : "Register a service", + "description" : "Registering a service is needed to:
        • Get callbacks about available NearRT RICs.
        • Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.
        Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "operationId" : "putService", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/service_registration_info" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK - Service updated", + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "201" : { + "description" : "Created - Service created", + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + } + } + } + } + }, + "callbacks" : { + "RICStatus" : { + "{$request.body#/callback_url}" : { + "post" : { + "tags" : [ "Service callbacks" ], + "summary" : "Callback for Near-RT RIC status", + "description" : "The URL to this call is registered at Service registration.", + "operationId" : "serviceCallback", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/service_callback_info_v2" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + } + } + } + } + }, + "/actuator/info" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'info'", + "operationId" : "info", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/status" : { + "get" : { + "tags" : [ "Health Check" ], + "description" : "Returns status and statistics of this service", + "operationId" : "getStatusV1", + "responses" : { + "200" : { + "description" : "OK - Service is living", + "content" : { + "*/*" : { + "schema" : { + "type" : "string" + } + } + } + } + } + } + }, + "/a1-policy/v2/policy-types/{policytype_id}" : { + "get" : { + "tags" : [ "A1 Policy Management" ], + "description" : "Returns a policy type definition", + "operationId" : "getPolicyTypeDefinition", + "parameters" : [ { + "name" : "policytype_id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - schema of the given policy type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_type_definition" + }, + "examples" : { + "policy_type_definition" : { + "$ref" : "#/components/examples/policy_type_definition" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + }, + "/actuator/logfile" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'logfile'", + "operationId" : "logfile", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain;charset=UTF-8" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/actuator/health" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'health'", + "operationId" : "health", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/policies" : { + "get" : { + "tags" : [ "A1 Policy Management" ], + "summary" : "Query policy identities", + "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" : "getPolicyIds", + "parameters" : [ { + "name" : "policytype_id", + "in" : "query", + "description" : "Select policies of a given policy type identity.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "ric_id", + "in" : "query", + "description" : "Select policies of a given Near-RT RIC identity.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "service_id", + "in" : "query", + "description" : "Select policies owned by a given service.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "type_name", + "in" : "query", + "description" : "Select policies of types with the given type name (type identity has the format )", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Policy identities", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_id_list" + }, + "examples" : { + "policy_id_list" : { + "$ref" : "#/components/examples/policy_id_list" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + }, + "put" : { + "tags" : [ "A1 Policy Management" ], + "description" : "Create or update a policy", + "operationId" : "putPolicy", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_info" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK - Policy updated", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + } + }, + "201" : { + "description" : "Created - Policy created", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + } + }, + "423" : { + "description" : "Locked - HTTP Status code which can be used when the state is Locked", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + } + } + } + } + } + } + }, + "/a1-policy/v2/services/{service_id}" : { + "delete" : { + "tags" : [ "Service Registry and Supervision" ], + "description" : "Unregister a service", + "operationId" : "deleteService", + "parameters" : [ { + "name" : "service_id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No Content - Service unregistered", + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + }, + "/actuator/heapdump" : { + "get" : { + "tags" : [ "Actuator" ], + "summary" : "Actuator web endpoint 'heapdump'", + "operationId" : "heapdump", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + } + } + }, + "x-internal" : true + } + }, + "/a1-policy/v2/policies/{policy_id}/status" : { + "get" : { + "tags" : [ "A1 Policy Management" ], + "description" : "Returns a policy status", + "operationId" : "getPolicyStatus", + "parameters" : [ { + "name" : "policy_id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK - Policy status", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_status_info" + }, + "examples" : { + "policy_status_info" : { + "$ref" : "#/components/examples/policy_status_info" + } + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + } + } + } + }, + "components" : { + "schemas" : { + "policy_type_definition" : { + "type" : "object", + "properties" : { + "policy_schema" : { + "type" : "object", + "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema" + } + }, + "description" : "Contains policy type schema definition" + }, + "error_information" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : " A human-readable explanation specific to this occurrence of the problem.", + "example" : "Policy type not found" + }, + "title" : { + "type" : "string", + "description" : "A specific error name", + "example" : "Not Found" + }, + "status" : { + "type" : "integer", + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ", + "format" : "int32", + "example" : 404 + } + }, + "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807" + }, + "void" : { + "type" : "object", + "description" : "Void/empty" + }, + "status_info" : { + "type" : "object", + "properties" : { + "status" : { + "type" : "string", + "description" : "status text" + } + } + }, + "authorization_result" : { + "required" : [ "result" ], + "type" : "object", + "properties" : { + "result" : { + "type" : "boolean", + "description" : "If true, the access is granted" + } + }, + "description" : "Result of authorization", + "example" : { + "result" : true + } + }, + "ric_info" : { + "type" : "object", + "properties" : { + "ric_id" : { + "type" : "string", + "description" : "identity of the Near-RT RIC" + }, + "managed_element_ids" : { + "type" : "array", + "description" : "O1 identities for managed entities", + "items" : { + "type" : "string", + "description" : "O1 identities for managed entities" + } + }, + "state" : { + "type" : "string", + "description" : "Represents the states for a Near-RT RIC", + "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ] + }, + "policytype_ids" : { + "type" : "array", + "description" : "supported policy types", + "items" : { + "type" : "string", + "description" : "supported policy types" + } + } + }, + "description" : "Information for a Near-RT RIC" + }, + "service_registration_info" : { + "required" : [ "service_id" ], + "type" : "object", + "properties" : { + "callback_url" : { + "type" : "string", + "description" : "callback for notifying of Near-RT RIC state changes" + }, + "service_id" : { + "type" : "string", + "description" : "identity of the service" + }, + "keep_alive_interval_seconds" : { + "type" : "integer", + "description" : "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.", + "format" : "int64" + } + }, + "description" : "Information for one service" + }, + "policy_info_list" : { + "type" : "object", + "properties" : { + "policies" : { + "type" : "array", + "description" : "List of policy information", + "items" : { + "$ref" : "#/components/schemas/policy_info" + } + } + }, + "description" : "List of policy information" + }, + "policy_status_info" : { + "type" : "object", + "properties" : { + "last_modified" : { + "type" : "string", + "description" : "timestamp, last modification time" + }, + "status" : { + "type" : "object", + "description" : "the Policy status" + } + }, + "description" : "Status for one A1-P Policy" + }, + "service_status" : { + "type" : "object", + "properties" : { + "callback_url" : { + "type" : "string", + "description" : "callback for notifying of RIC synchronization" + }, + "service_id" : { + "type" : "string", + "description" : "identity of the service" + }, + "keep_alive_interval_seconds" : { + "type" : "integer", + "description" : "policy keep alive timeout", + "format" : "int64" + }, + "time_since_last_activity_seconds" : { + "type" : "integer", + "description" : "time since last invocation by the service", + "format" : "int64" + } + } + }, + "ric_info_list" : { + "type" : "object", + "properties" : { + "rics" : { + "type" : "array", + "description" : "List of Near-RT RIC information", + "items" : { + "$ref" : "#/components/schemas/ric_info" + } + } + }, + "description" : "List of Near-RT RIC information" + }, + "input" : { + "required" : [ "access_type", "auth_token", "policy_type_id" ], + "type" : "object", + "properties" : { + "access_type" : { + "type" : "string", + "description" : "Access type", + "enum" : [ "READ", "WRITE", "DELETE" ] + }, + "auth_token" : { + "type" : "string", + "description" : "Authorization token" + }, + "policy_type_id" : { + "type" : "string", + "description" : "Policy type identifier" + } + }, + "description" : "input" + }, + "policy_authorization" : { + "required" : [ "input" ], + "type" : "object", + "properties" : { + "input" : { + "$ref" : "#/components/schemas/input" + } + }, + "description" : "Authorization request for A1 policy requests" + }, + "policy_type_id_list" : { + "type" : "object", + "properties" : { + "policytype_ids" : { + "type" : "array", + "description" : "Policy type identities", + "items" : { + "type" : "string", + "description" : "Policy type identities" + } + } + }, + "description" : "Information about policy types" + }, + "policy_info" : { + "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ], + "type" : "object", + "properties" : { + "ric_id" : { + "type" : "string", + "description" : "identity of the target Near-RT RIC" + }, + "policy_id" : { + "type" : "string", + "description" : "identity of the policy" + }, + "transient" : { + "type" : "boolean", + "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", + "nullable" : false, + "example" : false, + "default" : false + }, + "service_id" : { + "type" : "string", + "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered.", + "default" : "" + }, + "policy_data" : { + "type" : "object", + "description" : "the configuration of the policy" + }, + "status_notification_uri" : { + "type" : "string", + "description" : "Callback URI for policy status updates" + }, + "policytype_id" : { + "type" : "string", + "description" : "identity of the policy type" + } + }, + "description" : "Information for one A1-P Policy" + }, + "policy_id_list" : { + "type" : "object", + "properties" : { + "policy_ids" : { + "type" : "array", + "description" : "Policy identities", + "items" : { + "type" : "string", + "description" : "Policy identities" + } + } + }, + "description" : "A list of policy identities", + "example" : { + "policy_ids" : [ "policy_ids", "policy_ids" ] + } + }, + "service_status_list" : { + "type" : "object", + "properties" : { + "service_list" : { + "type" : "array", + "description" : "List of service information", + "items" : { + "$ref" : "#/components/schemas/service_status" + } + } + } + }, + "service_callback_info_v2" : { + "required" : [ "event_type", "ric_id" ], + "type" : "object", + "properties" : { + "ric_id" : { + "type" : "string", + "description" : "identity of a Near-RT RIC" + }, + "event_type" : { + "type" : "string", + "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management", + "enum" : [ "AVAILABLE" ] + } + }, + "description" : "Information transferred as in Service callbacks (callback_url)" + }, + "Link" : { + "type" : "object", + "properties" : { + "templated" : { + "type" : "boolean" + }, + "href" : { + "type" : "string" + } + } + } + }, + "responses" : { + "Locked" : { + "description" : "Locked - HTTP Status code which can be used when the state is Locked", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + } + } + } + }, + "BadRequest" : { + "description" : "Bad Request", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + } + } + } + }, + "Forbidden" : { + "description" : "Forbidden", + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + }, + "example" : { + "status" : 403, + "title" : "Forbidden", + "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." + } + } + } + }, + "NotFound" : { + "description" : "Not Found", + "content" : { + "application/problem+json" : { + "example" : [ ] + } + } + } + }, + "examples" : { + "service_status" : { + "description" : "List of service information", + "value" : { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + } + }, + "service_status_list" : { + "description" : "List of service information", + "value" : { + "service_list" : [ { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + }, { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + } ] + } + }, + "policy_type_definition" : { + "description" : "Schema of the given Policy type", + "value" : { + "policy_schema" : "{}" + } + }, + "policy_type_id_list" : { + "description" : "Array of policy type id's", + "value" : { + "policy_type_id_list" : [ "policytype_id", "policytype_id" ] + } + }, + "policy_info" : { + "description" : "Policy information of one A1-P policy", + "value" : { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + } + }, + "policy_info_list" : { + "description" : "List of policy information", + "value" : { + "policies" : [ { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + }, { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + } ] + } + }, + "policy_id_list" : { + "description" : "A list of policy identities", + "value" : { + "policy_ids" : [ "some_policy_id", "some_policy_id" ] + } + }, + "policy_status_info" : { + "description" : "Status for one A1-P Policy", + "value" : { + "last_modified" : "last_modified", + "status" : { + "value" : { + "status" : "status" + } + } + } + }, + "status_info" : { + "value" : { + "status" : "status" + } + }, + "ric_info" : { + "value" : { + "ric_id" : "ric_id", + "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ] + } + }, + "ric_info_list" : { + "value" : { + "rics" : [ { + "ric_id" : "ric_id", + "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "policytype_id", "policytype_id" ] + }, { + "ric_id" : "ric_id", + "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "policytype_ids", "policytype_ids" ] + } ] + } + } + } + } } \ No newline at end of file diff --git a/a1-policy-management/api/pms-api.yaml b/a1-policy-management/api/pms-api.yaml index 699d5edc..1c25e051 100644 --- a/a1-policy-management/api/pms-api.yaml +++ b/a1-policy-management/api/pms-api.yaml @@ -1307,6 +1307,7 @@ components: used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered. type: string + default: "" policy_data: description: the configuration of the policy type: object @@ -1319,7 +1320,6 @@ components: required: - ric_id - policy_id - - service_id - policy_data - policytype_id type: object diff --git a/a1-policy-management/api/pms-api/index.html b/a1-policy-management/api/pms-api/index.html index c4aa60e7..66934cda 100644 --- a/a1-policy-management/api/pms-api/index.html +++ b/a1-policy-management/api/pms-api/index.html @@ -846,302 +846,313 @@ ul.nav-tabs { - - - - - -
        -
        -
        - -
        - -
        -
        -

        -

        - - - - - - -
        -
        -
        - -
        - -
        -

        @@ -1832,12 +1699,12 @@ pub fn main() {

        getPolicy

        -

        Returns a policy

        +

        -

        +

        Returns a policy


        /a1-policy/v2/policies/{policy_id}
        @@ -1862,7 +1729,7 @@ pub fn main() {
        curl -X GET \
        - -H "Accept: application/json" \
        + -H "Accept: application/json,application/problem+json" \
          "http://localhost/a1-policy/v2/policies/{policy_id}"
         
        @@ -1883,7 +1750,7 @@ public class A1PolicyManagementApiExample { String policyId = policyId_example; // String | try { - policy_info_v2 result = apiInstance.getPolicy(policyId); + policy_info result = apiInstance.getPolicy(policyId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicy"); @@ -1903,7 +1770,7 @@ public class A1PolicyManagementApiExample { String policyId = policyId_example; // String | try { - policy_info_v2 result = apiInstance.getPolicy(policyId); + policy_info result = apiInstance.getPolicy(policyId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicy"); @@ -1923,9 +1790,8 @@ public class A1PolicyManagementApiExample { A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *policyId = policyId_example; // (default to null) -// Returns a policy [apiInstance getPolicyWith:policyId - completionHandler: ^(policy_info_v2 output, NSError* error) { + completionHandler: ^(policy_info output, NSError* error) { if (output) { NSLog(@"%@", output); } @@ -1976,8 +1842,7 @@ namespace Example var policyId = policyId_example; // String | (default to null) try { - // Returns a policy - policy_info_v2 result = apiInstance.getPolicy(policyId); + policy_info result = apiInstance.getPolicy(policyId); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling A1PolicyManagementApi.getPolicy: " + e.Message ); @@ -2035,7 +1900,6 @@ api_instance = openapi_client.A1PolicyManagementApi() policyId = policyId_example # String | (default to null) try: - # Returns a policy api_response = api_instance.get_policy(policyId) pprint(api_response) except ApiException as e: @@ -2100,7 +1964,7 @@ pub fn main() {

        -
        - -
        @@ -2266,7 +2082,7 @@ pub fn main() {
        curl -X GET \
        - -H "Accept: application/json" \
        + -H "Accept: application/json,application/problem+json" \
          "http://localhost/a1-policy/v2/policies?policytype_id=policytypeId_example&ric_id=ricId_example&service_id=serviceId_example&type_name=typeName_example"
         
        @@ -2290,7 +2106,7 @@ public class A1PolicyManagementApiExample { String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format ) try { - policy_id_list_v2 result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName); + policy_id_list result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicyIds"); @@ -2313,7 +2129,7 @@ public class A1PolicyManagementApiExample { String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format ) try { - policy_id_list_v2 result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName); + policy_id_list result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicyIds"); @@ -2341,7 +2157,7 @@ String *typeName = typeName_example; // Select policies of types with the given ricId:ricId serviceId:serviceId typeName:typeName - completionHandler: ^(policy_id_list_v2 output, NSError* error) { + completionHandler: ^(policy_id_list output, NSError* error) { if (output) { NSLog(@"%@", output); } @@ -2401,7 +2217,7 @@ namespace Example try { // Query policy identities - policy_id_list_v2 result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName); + policy_id_list result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyIds: " + e.Message ); @@ -2596,7 +2412,7 @@ Select policies of types with the given type name (type identity has the format

        -
        - - @@ -2786,7 +2554,7 @@ public class A1PolicyManagementApiExample { String typeName = typeName_example; // String | Select policies of a given type name (type identity has the format ) try { - policy_info_list_v2 result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName); + policy_info_list result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicyInstances"); @@ -2809,7 +2577,7 @@ public class A1PolicyManagementApiExample { String typeName = typeName_example; // String | Select policies of a given type name (type identity has the format ) try { - policy_info_list_v2 result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName); + policy_info_list result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicyInstances"); @@ -2837,7 +2605,7 @@ String *typeName = typeName_example; // Select policies of a given type name (ty ricId:ricId serviceId:serviceId typeName:typeName - completionHandler: ^(policy_info_list_v2 output, NSError* error) { + completionHandler: ^(policy_info_list output, NSError* error) { if (output) { NSLog(@"%@", output); } @@ -2897,7 +2665,7 @@ namespace Example try { // Query for A1 policy instances - policy_info_list_v2 result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName); + policy_info_list result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyInstances: " + e.Message ); @@ -3092,7 +2860,7 @@ Select policies of a given type name (type identity has the format <typename_

        - - -
        -
        -
        +
        +
        -

        getPolicyType

        -

        Returns a policy type definition

        +

        getPolicyTypeDefinition

        +

        -

        +

        Returns a policy type definition


        /a1-policy/v2/policy-types/{policytype_id}
        @@ -3645,28 +3354,28 @@ pub fn main() {

        Usage and SDK Samples

        -
        +
        curl -X GET \
        - -H "Accept: */*" \
        + -H "Accept: application/json,application/problem+json" \
          "http://localhost/a1-policy/v2/policy-types/{policytype_id}"
         
        -
        +
        import org.openapitools.client.*;
         import org.openapitools.client.auth.*;
         import org.openapitools.client.model.*;
        @@ -3683,10 +3392,10 @@ public class A1PolicyManagementApiExample {
                 String policytypeId = policytypeId_example; // String | 
         
                 try {
        -            policytype_v2 result = apiInstance.getPolicyType(policytypeId);
        +            policy_type_definition result = apiInstance.getPolicyTypeDefinition(policytypeId);
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyType");
        +            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
                     e.printStackTrace();
                 }
             }
        @@ -3694,7 +3403,7 @@ public class A1PolicyManagementApiExample {
         
        -
        +
        import org.openapitools.client.api.A1PolicyManagementApi;
         
         public class A1PolicyManagementApiExample {
        @@ -3703,29 +3412,28 @@ public class A1PolicyManagementApiExample {
                 String policytypeId = policytypeId_example; // String | 
         
                 try {
        -            policytype_v2 result = apiInstance.getPolicyType(policytypeId);
        +            policy_type_definition result = apiInstance.getPolicyTypeDefinition(policytypeId);
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyType");
        +            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
                     e.printStackTrace();
                 }
             }
         }
        -
        +
        
         
         // Create an instance of the API class
         A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
         String *policytypeId = policytypeId_example; //  (default to null)
         
        -// Returns a policy type definition
        -[apiInstance getPolicyTypeWith:policytypeId
        -              completionHandler: ^(policytype_v2 output, NSError* error) {
        +[apiInstance getPolicyTypeDefinitionWith:policytypeId
        +              completionHandler: ^(policy_type_definition output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -3736,7 +3444,7 @@ String *policytypeId = policytypeId_example; //  (default to null)
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
        @@ -3750,14 +3458,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.getPolicyType(policytypeId, callback);
        +api.getPolicyTypeDefinition(policytypeId, callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -3766,7 +3474,7 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class getPolicyTypeExample
        +    public class getPolicyTypeDefinitionExample
             {
                 public void main()
                 {
        @@ -3776,11 +3484,10 @@ namespace Example
                     var policytypeId = policytypeId_example;  // String |  (default to null)
         
                     try {
        -                // Returns a policy type definition
        -                policytype_v2 result = apiInstance.getPolicyType(policytypeId);
        +                policy_type_definition result = apiInstance.getPolicyTypeDefinition(policytypeId);
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyType: " + e.Message );
        +                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypeDefinition: " + e.Message );
                     }
                 }
             }
        @@ -3788,7 +3495,7 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
        @@ -3797,15 +3504,15 @@ $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
         $policytypeId = policytypeId_example; // String | 
         
         try {
        -    $result = $api_instance->getPolicyType($policytypeId);
        +    $result = $api_instance->getPolicyTypeDefinition($policytypeId);
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling A1PolicyManagementApi->getPolicyType: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
         use WWW::OPenAPIClient::A1PolicyManagementApi;
        @@ -3815,15 +3522,15 @@ my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
         my $policytypeId = policytypeId_example; # String | 
         
         eval {
        -    my $result = $api_instance->getPolicyType(policytypeId => $policytypeId);
        +    my $result = $api_instance->getPolicyTypeDefinition(policytypeId => $policytypeId);
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling A1PolicyManagementApi->getPolicyType: $@\n";
        +    warn "Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -3835,21 +3542,20 @@ api_instance = openapi_client.A1PolicyManagementApi()
         policytypeId = policytypeId_example # String |  (default to null)
         
         try:
        -    # Returns a policy type definition
        -    api_response = api_instance.get_policy_type(policytypeId)
        +    api_response = api_instance.get_policy_type_definition(policytypeId)
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling A1PolicyManagementApi->getPolicyType: %s\n" % e)
        + print("Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: %s\n" % e)
        -
        +
        extern crate A1PolicyManagementApi;
         
         pub fn main() {
             let policytypeId = policytypeId_example; // String
         
             let mut context = A1PolicyManagementApi::Context::default();
        -    let result = client.getPolicyType(policytypeId, &context).wait();
        +    let result = client.getPolicyTypeDefinition(policytypeId, &context).wait();
         
             println!("{:?}", result);
         }
        @@ -3874,7 +3580,7 @@ pub fn main() {
         
         
         
        -    
        +
        @@ -3897,23 +3603,23 @@ pub fn main() {

        Responses

        -

        -

        +

        +

        -
        @@ -4036,12 +3694,12 @@ pub fn main() {

        getPolicyTypes

        -

        Query policy type identities

        +

        -

        +

        Query policy type identities


        /a1-policy/v2/policy-types
        @@ -4066,7 +3724,7 @@ pub fn main() {
        curl -X GET \
        - -H "Accept: application/json" \
        + -H "Accept: application/json,application/problem+json" \
          "http://localhost/a1-policy/v2/policy-types?ric_id=ricId_example&type_name=typeName_example&compatible_with_version=compatibleWithVersion_example"
         
        @@ -4089,7 +3747,7 @@ public class A1PolicyManagementApiExample { String compatibleWithVersion = compatibleWithVersion_example; // String | 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. Matching types will be returned sorted in ascending order. try { - policytype_id_list_v2 result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion); + policy_type_id_list result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes"); @@ -4111,7 +3769,7 @@ public class A1PolicyManagementApiExample { String compatibleWithVersion = compatibleWithVersion_example; // String | 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. Matching types will be returned sorted in ascending order. try { - policytype_id_list_v2 result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion); + policy_type_id_list result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes"); @@ -4133,11 +3791,10 @@ String *ricId = ricId_example; // Select types for the given Near-RT RIC identit String *typeName = typeName_example; // Select types with the given type name (type identity has the format ) (optional) (default to null) String *compatibleWithVersion = compatibleWithVersion_example; // 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. Matching types will be returned sorted in ascending order. (optional) (default to null) -// Query policy type identities [apiInstance getPolicyTypesWith:ricId typeName:typeName compatibleWithVersion:compatibleWithVersion - completionHandler: ^(policytype_id_list_v2 output, NSError* error) { + completionHandler: ^(policy_type_id_list output, NSError* error) { if (output) { NSLog(@"%@", output); } @@ -4194,8 +3851,7 @@ namespace Example var compatibleWithVersion = compatibleWithVersion_example; // String | 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. Matching types will be returned sorted in ascending order. (optional) (default to null) try { - // Query policy type identities - policytype_id_list_v2 result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion); + policy_type_id_list result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypes: " + e.Message ); @@ -4259,7 +3915,6 @@ typeName = typeName_example # String | Select types with the given type name (ty compatibleWithVersion = compatibleWithVersion_example # String | 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. Matching types will be returned sorted in ascending order. (optional) (default to null) try: - # Query policy type identities api_response = api_instance.get_policy_types(ricId=ricId, typeName=typeName, compatibleWithVersion=compatibleWithVersion) pprint(api_response) except ApiException as e: @@ -4366,7 +4021,7 @@ Select types that are compatible with the given version. This parameter is only

        -
        - -
        @@ -4502,12 +4109,12 @@ Select types that are compatible with the given version. This parameter is only

        putPolicy

        -

        Create or update a policy

        +

        -

        +

        Create or update a policy


        /a1-policy/v2/policies
        @@ -4532,7 +4139,7 @@ Select types that are compatible with the given version. This parameter is only
        curl -X PUT \
        - -H "Accept: application/json" \
        + -H "Accept: application/json,application/problem+json" \
          -H "Content-Type: application/json" \
          "http://localhost/a1-policy/v2/policies" \
          -d ''
        @@ -4552,10 +4159,10 @@ public class A1PolicyManagementApiExample {
         
                 // Create an instance of the API class
                 A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        -        PolicyInfoV2 policyInfoV2 = ; // PolicyInfoV2 | 
        +        PolicyInfo policyInfo = ; // PolicyInfo | 
         
                 try {
        -            Object result = apiInstance.putPolicy(policyInfoV2);
        +            Object result = apiInstance.putPolicy(policyInfo);
                     System.out.println(result);
                 } catch (ApiException e) {
                     System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
        @@ -4572,10 +4179,10 @@ public class A1PolicyManagementApiExample {
         public class A1PolicyManagementApiExample {
             public static void main(String[] args) {
                 A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        -        PolicyInfoV2 policyInfoV2 = ; // PolicyInfoV2 | 
        +        PolicyInfo policyInfo = ; // PolicyInfo | 
         
                 try {
        -            Object result = apiInstance.putPolicy(policyInfoV2);
        +            Object result = apiInstance.putPolicy(policyInfo);
                     System.out.println(result);
                 } catch (ApiException e) {
                     System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
        @@ -4593,10 +4200,9 @@ public class A1PolicyManagementApiExample {
         
         // Create an instance of the API class
         A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
        -PolicyInfoV2 *policyInfoV2 = ; // 
        +PolicyInfo *policyInfo = ; // 
         
        -// Create or update a policy
        -[apiInstance putPolicyWith:policyInfoV2
        +[apiInstance putPolicyWith:policyInfo
                       completionHandler: ^(Object output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
        @@ -4613,7 +4219,7 @@ PolicyInfoV2 *policyInfoV2 = ; //
         
         // Create an instance of the API class
         var api = new A1PolicyManagementService.A1PolicyManagementApi()
        -var policyInfoV2 = ; // {PolicyInfoV2} 
        +var policyInfo = ; // {PolicyInfo} 
         
         var callback = function(error, data, response) {
           if (error) {
        @@ -4622,7 +4228,7 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.putPolicy(policyInfoV2, callback);
        +api.putPolicy(policyInfo, callback);
         
        @@ -4645,11 +4251,10 @@ namespace Example // Create an instance of the API class var apiInstance = new A1PolicyManagementApi(); - var policyInfoV2 = new PolicyInfoV2(); // PolicyInfoV2 | + var policyInfo = new PolicyInfo(); // PolicyInfo | try { - // Create or update a policy - Object result = apiInstance.putPolicy(policyInfoV2); + Object result = apiInstance.putPolicy(policyInfo); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling A1PolicyManagementApi.putPolicy: " + e.Message ); @@ -4666,10 +4271,10 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi(); -$policyInfoV2 = ; // PolicyInfoV2 | +$policyInfo = ; // PolicyInfo | try { - $result = $api_instance->putPolicy($policyInfoV2); + $result = $api_instance->putPolicy($policyInfo); print_r($result); } catch (Exception $e) { echo 'Exception when calling A1PolicyManagementApi->putPolicy: ', $e->getMessage(), PHP_EOL; @@ -4684,10 +4289,10 @@ use WWW::OPenAPIClient::A1PolicyManagementApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new(); -my $policyInfoV2 = WWW::OPenAPIClient::Object::PolicyInfoV2->new(); # PolicyInfoV2 | +my $policyInfo = WWW::OPenAPIClient::Object::PolicyInfo->new(); # PolicyInfo | eval { - my $result = $api_instance->putPolicy(policyInfoV2 => $policyInfoV2); + my $result = $api_instance->putPolicy(policyInfo => $policyInfo); print Dumper($result); }; if ($@) { @@ -4704,11 +4309,10 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.A1PolicyManagementApi() -policyInfoV2 = # PolicyInfoV2 | +policyInfo = # PolicyInfo | try: - # Create or update a policy - api_response = api_instance.put_policy(policyInfoV2) + api_response = api_instance.put_policy(policyInfo) pprint(api_response) except ApiException as e: print("Exception when calling A1PolicyManagementApi->putPolicy: %s\n" % e)
        @@ -4718,10 +4322,10 @@ except ApiException as e:
        extern crate A1PolicyManagementApi;
         
         pub fn main() {
        -    let policyInfoV2 = ; // PolicyInfoV2
        +    let policyInfo = ; // PolicyInfo
         
             let mut context = A1PolicyManagementApi::Context::default();
        -    let result = client.putPolicy(policyInfoV2, &context).wait();
        +    let result = client.putPolicy(policyInfo, &context).wait();
         
             println!("{:?}", result);
         }
        @@ -4744,20 +4348,20 @@ pub fn main() {
                                         Name
                                         Description
                                       
        -                                policyInfoV2 *
        +                                policyInfo *
         
         

        -
        +
        @@ -4791,7 +4395,7 @@ $(document).ready(function() {

        - - - - - -
        -
        -
        - -
        - -
        -

        @@ -5320,32 +4846,18 @@ pub fn main() {
        + + + + + +
        +
        +
        + +
        + +
        +
        + +

        -
        -

        HealthCheck

        -
        -
        +
        +

        Configuration

        +
        +
        -

        getStatus

        -

        Returns status and statistics of this service

        +

        getConfiguration

        +

        -

        +

        Returns the contents of the application configuration file


        -
        /a1-policy/v2/status
        +
        /a1-policy/v2/configuration

        Usage and SDK Samples

        -
        +
        curl -X GET \
        - -H "Accept: application/json" \
        - "http://localhost/a1-policy/v2/status"
        + -H "Accept: application/json,application/problem+json" \
        + "http://localhost/a1-policy/v2/configuration"
         
        -
        +
        import org.openapitools.client.*;
         import org.openapitools.client.auth.*;
         import org.openapitools.client.model.*;
        -import org.openapitools.client.api.HealthCheckApi;
        +import org.openapitools.client.api.ConfigurationApi;
         
         import java.io.File;
         import java.util.*;
         
        -public class HealthCheckApiExample {
        +public class ConfigurationApiExample {
             public static void main(String[] args) {
         
                 // Create an instance of the API class
        -        HealthCheckApi apiInstance = new HealthCheckApi();
        +        ConfigurationApi apiInstance = new ConfigurationApi();
         
                 try {
        -            status_info_v2 result = apiInstance.getStatus();
        +            'String' result = apiInstance.getConfiguration();
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling HealthCheckApi#getStatus");
        +            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
                     e.printStackTrace();
                 }
             }
        @@ -9695,36 +9104,35 @@ public class HealthCheckApiExample {
         
        -
        -
        import org.openapitools.client.api.HealthCheckApi;
        +                          
        +
        import org.openapitools.client.api.ConfigurationApi;
         
        -public class HealthCheckApiExample {
        +public class ConfigurationApiExample {
             public static void main(String[] args) {
        -        HealthCheckApi apiInstance = new HealthCheckApi();
        +        ConfigurationApi apiInstance = new ConfigurationApi();
         
                 try {
        -            status_info_v2 result = apiInstance.getStatus();
        +            'String' result = apiInstance.getConfiguration();
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling HealthCheckApi#getStatus");
        +            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
                     e.printStackTrace();
                 }
             }
         }
        -
        +
        
         
         // Create an instance of the API class
        -HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
        +ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
         
        -// Returns status and statistics of this service
        -[apiInstance getStatusWithCompletionHandler: 
        -              ^(status_info_v2 output, NSError* error) {
        +[apiInstance getConfigurationWithCompletionHandler: 
        +              ^('String' output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -9735,11 +9143,11 @@ HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
        -var api = new A1PolicyManagementService.HealthCheckApi()
        +var api = new A1PolicyManagementService.ConfigurationApi()
         var callback = function(error, data, response) {
           if (error) {
             console.error(error);
        @@ -9747,14 +9155,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.getStatus(callback);
        +api.getConfiguration(callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -9763,20 +9171,19 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class getStatusExample
        +    public class getConfigurationExample
             {
                 public void main()
                 {
         
                     // Create an instance of the API class
        -            var apiInstance = new HealthCheckApi();
        +            var apiInstance = new ConfigurationApi();
         
                     try {
        -                // Returns status and statistics of this service
        -                status_info_v2 result = apiInstance.getStatus();
        +                'String' result = apiInstance.getConfiguration();
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
        +                Debug.Print("Exception when calling ConfigurationApi.getConfiguration: " + e.Message );
                     }
                 }
             }
        @@ -9784,40 +9191,40 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
         // Create an instance of the API class
        -$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
        +$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
         
         try {
        -    $result = $api_instance->getStatus();
        +    $result = $api_instance->getConfiguration();
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling ConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
        -use WWW::OPenAPIClient::HealthCheckApi;
        +use WWW::OPenAPIClient::ConfigurationApi;
         
         # Create an instance of the API class
        -my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
        +my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
         
         eval {
        -    my $result = $api_instance->getStatus();
        +    my $result = $api_instance->getConfiguration();
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling HealthCheckApi->getStatus: $@\n";
        +    warn "Exception when calling ConfigurationApi->getConfiguration: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -9825,23 +9232,22 @@ from openapi_client.rest import ApiException
         from pprint import pprint
         
         # Create an instance of the API class
        -api_instance = openapi_client.HealthCheckApi()
        +api_instance = openapi_client.ConfigurationApi()
         
         try:
        -    # Returns status and statistics of this service
        -    api_response = api_instance.get_status()
        +    api_response = api_instance.get_configuration()
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)
        + print("Exception when calling ConfigurationApi->getConfiguration: %s\n" % e)
        -
        -
        extern crate HealthCheckApi;
        +                            
        +
        extern crate ConfigurationApi;
         
         pub fn main() {
         
        -    let mut context = HealthCheckApi::Context::default();
        -    let result = client.getStatus(&context).wait();
        +    let mut context = ConfigurationApi::Context::default();
        +    let result = client.getConfiguration(&context).wait();
         
             println!("{:?}", result);
         }
        @@ -9862,23 +9268,23 @@ pub fn main() {
         
         
                                   

        Responses

        -

        -

        +

        +

        -

        -
        -
        +
        +
        -

        getStatusV1

        -

        Returns status and statistics of this service

        +

        putConfiguration

        +

        -

        +

        Replace the current configuration with the given configuration


        -
        /status
        +
        /a1-policy/v2/configuration

        Usage and SDK Samples

        -
        -
        curl -X GET \
        - -H "Accept: */*" \
        - "http://localhost/status"
        +                          
        +
        curl -X PUT \
        + -H "Accept: */*,application/problem+json" \
        + -H "Content-Type: application/json" \
        + "http://localhost/a1-policy/v2/configuration" \
        + -d ''
         
        -
        +
        import org.openapitools.client.*;
         import org.openapitools.client.auth.*;
         import org.openapitools.client.model.*;
        -import org.openapitools.client.api.HealthCheckApi;
        +import org.openapitools.client.api.ConfigurationApi;
         
         import java.io.File;
         import java.util.*;
         
        -public class HealthCheckApiExample {
        +public class ConfigurationApiExample {
             public static void main(String[] args) {
         
                 // Create an instance of the API class
        -        HealthCheckApi apiInstance = new HealthCheckApi();
        +        ConfigurationApi apiInstance = new ConfigurationApi();
        +        Object body = Object; // Object | 
         
                 try {
        -            'String' result = apiInstance.getStatusV1();
        +            Object result = apiInstance.putConfiguration(body);
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling HealthCheckApi#getStatusV1");
        +            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
                     e.printStackTrace();
                 }
             }
        @@ -9996,36 +9423,37 @@ public class HealthCheckApiExample {
         
        -
        -
        import org.openapitools.client.api.HealthCheckApi;
        +                          
        +
        import org.openapitools.client.api.ConfigurationApi;
         
        -public class HealthCheckApiExample {
        +public class ConfigurationApiExample {
             public static void main(String[] args) {
        -        HealthCheckApi apiInstance = new HealthCheckApi();
        +        ConfigurationApi apiInstance = new ConfigurationApi();
        +        Object body = Object; // Object | 
         
                 try {
        -            'String' result = apiInstance.getStatusV1();
        +            Object result = apiInstance.putConfiguration(body);
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling HealthCheckApi#getStatusV1");
        +            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
                     e.printStackTrace();
                 }
             }
         }
        -
        +
        
         
         // Create an instance of the API class
        -HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
        +ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
        +Object *body = Object; // 
         
        -// Returns status and statistics of this service
        -[apiInstance getStatusV1WithCompletionHandler: 
        -              ^('String' output, NSError* error) {
        +[apiInstance putConfigurationWith:body
        +              completionHandler: ^(Object output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -10036,11 +9464,13 @@ HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
        -var api = new A1PolicyManagementService.HealthCheckApi()
        +var api = new A1PolicyManagementService.ConfigurationApi()
        +var body = Object; // {Object} 
        +
         var callback = function(error, data, response) {
           if (error) {
             console.error(error);
        @@ -10048,14 +9478,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.getStatusV1(callback);
        +api.putConfiguration(body, callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -10064,20 +9494,20 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class getStatusV1Example
        +    public class putConfigurationExample
             {
                 public void main()
                 {
         
                     // Create an instance of the API class
        -            var apiInstance = new HealthCheckApi();
        +            var apiInstance = new ConfigurationApi();
        +            var body = Object;  // Object | 
         
                     try {
        -                // Returns status and statistics of this service
        -                'String' result = apiInstance.getStatusV1();
        +                Object result = apiInstance.putConfiguration(body);
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling HealthCheckApi.getStatusV1: " + e.Message );
        +                Debug.Print("Exception when calling ConfigurationApi.putConfiguration: " + e.Message );
                     }
                 }
             }
        @@ -10085,40 +9515,42 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
         // Create an instance of the API class
        -$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
        +$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
        +$body = Object; // Object | 
         
         try {
        -    $result = $api_instance->getStatusV1();
        +    $result = $api_instance->putConfiguration($body);
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling HealthCheckApi->getStatusV1: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling ConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
        -use WWW::OPenAPIClient::HealthCheckApi;
        +use WWW::OPenAPIClient::ConfigurationApi;
         
         # Create an instance of the API class
        -my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
        +my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
        +my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 
         
         eval {
        -    my $result = $api_instance->getStatusV1();
        +    my $result = $api_instance->putConfiguration(body => $body);
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling HealthCheckApi->getStatusV1: $@\n";
        +    warn "Exception when calling ConfigurationApi->putConfiguration: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -10126,23 +9558,24 @@ from openapi_client.rest import ApiException
         from pprint import pprint
         
         # Create an instance of the API class
        -api_instance = openapi_client.HealthCheckApi()
        +api_instance = openapi_client.ConfigurationApi()
        +body = Object # Object | 
         
         try:
        -    # Returns status and statistics of this service
        -    api_response = api_instance.get_status_v1()
        +    api_response = api_instance.put_configuration(body)
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling HealthCheckApi->getStatusV1: %s\n" % e)
        + print("Exception when calling ConfigurationApi->putConfiguration: %s\n" % e)
        -
        -
        extern crate HealthCheckApi;
        +                            
        +
        extern crate ConfigurationApi;
         
         pub fn main() {
        +    let body = Object; // Object
         
        -    let mut context = HealthCheckApi::Context::default();
        -    let result = client.getStatusV1(&context).wait();
        +    let mut context = ConfigurationApi::Context::default();
        +    let result = client.putConfiguration(body, &context).wait();
         
             println!("{:?}", result);
         }
        @@ -10159,27 +9592,73 @@ pub fn main() {
         
         
         
        +                            
        Body parameters
        + + + + + + + + + +
        NameDescription
        body * +

        + +
        +
        + + + +

        Responses

        +

        +

        + -

        -
        -

        ManagementOfConfiguration

        -
        -
        +
        +

        HealthCheck

        +
        +
        -

        getConfiguration

        -

        Returns the contents of the application configuration file

        +

        getStatus

        +

        -

        +

        Returns status and statistics of this service


        -
        /a1-policy/v2/configuration
        +
        /a1-policy/v2/status

        Usage and SDK Samples

        -
        +
        curl -X GET \
          -H "Accept: application/json" \
        - "http://localhost/a1-policy/v2/configuration"
        + "http://localhost/a1-policy/v2/status"
         
        -
        +
        import org.openapitools.client.*;
         import org.openapitools.client.auth.*;
         import org.openapitools.client.model.*;
        -import org.openapitools.client.api.ManagementOfConfigurationApi;
        +import org.openapitools.client.api.HealthCheckApi;
         
         import java.io.File;
         import java.util.*;
         
        -public class ManagementOfConfigurationApiExample {
        +public class HealthCheckApiExample {
             public static void main(String[] args) {
         
                 // Create an instance of the API class
        -        ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
        +        HealthCheckApi apiInstance = new HealthCheckApi();
         
                 try {
        -            Object result = apiInstance.getConfiguration();
        +            status_info result = apiInstance.getStatus();
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
        +            System.err.println("Exception when calling HealthCheckApi#getStatus");
                     e.printStackTrace();
                 }
             }
        @@ -10300,36 +9837,35 @@ public class ManagementOfConfigurationApiExample {
         
        -
        -
        import org.openapitools.client.api.ManagementOfConfigurationApi;
        +                          
        +
        import org.openapitools.client.api.HealthCheckApi;
         
        -public class ManagementOfConfigurationApiExample {
        +public class HealthCheckApiExample {
             public static void main(String[] args) {
        -        ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
        +        HealthCheckApi apiInstance = new HealthCheckApi();
         
                 try {
        -            Object result = apiInstance.getConfiguration();
        +            status_info result = apiInstance.getStatus();
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
        +            System.err.println("Exception when calling HealthCheckApi#getStatus");
                     e.printStackTrace();
                 }
             }
         }
        -
        +
        
         
         // Create an instance of the API class
        -ManagementOfConfigurationApi *apiInstance = [[ManagementOfConfigurationApi alloc] init];
        +HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
         
        -// Returns the contents of the application configuration file
        -[apiInstance getConfigurationWithCompletionHandler: 
        -              ^(Object output, NSError* error) {
        +[apiInstance getStatusWithCompletionHandler: 
        +              ^(status_info output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -10340,11 +9876,11 @@ ManagementOfConfigurationApi *apiInstance = [[ManagementOfConfigurationApi alloc
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
        -var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
        +var api = new A1PolicyManagementService.HealthCheckApi()
         var callback = function(error, data, response) {
           if (error) {
             console.error(error);
        @@ -10352,14 +9888,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.getConfiguration(callback);
        +api.getStatus(callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -10368,20 +9904,19 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class getConfigurationExample
        +    public class getStatusExample
             {
                 public void main()
                 {
         
                     // Create an instance of the API class
        -            var apiInstance = new ManagementOfConfigurationApi();
        +            var apiInstance = new HealthCheckApi();
         
                     try {
        -                // Returns the contents of the application configuration file
        -                Object result = apiInstance.getConfiguration();
        +                status_info result = apiInstance.getStatus();
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling ManagementOfConfigurationApi.getConfiguration: " + e.Message );
        +                Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
                     }
                 }
             }
        @@ -10389,40 +9924,40 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
         // Create an instance of the API class
        -$api_instance = new OpenAPITools\Client\Api\ManagementOfConfigurationApi();
        +$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
         
         try {
        -    $result = $api_instance->getConfiguration();
        +    $result = $api_instance->getStatus();
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling ManagementOfConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
        -use WWW::OPenAPIClient::ManagementOfConfigurationApi;
        +use WWW::OPenAPIClient::HealthCheckApi;
         
         # Create an instance of the API class
        -my $api_instance = WWW::OPenAPIClient::ManagementOfConfigurationApi->new();
        +my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
         
         eval {
        -    my $result = $api_instance->getConfiguration();
        +    my $result = $api_instance->getStatus();
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling ManagementOfConfigurationApi->getConfiguration: $@\n";
        +    warn "Exception when calling HealthCheckApi->getStatus: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -10430,23 +9965,22 @@ from openapi_client.rest import ApiException
         from pprint import pprint
         
         # Create an instance of the API class
        -api_instance = openapi_client.ManagementOfConfigurationApi()
        +api_instance = openapi_client.HealthCheckApi()
         
         try:
        -    # Returns the contents of the application configuration file
        -    api_response = api_instance.get_configuration()
        +    api_response = api_instance.get_status()
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling ManagementOfConfigurationApi->getConfiguration: %s\n" % e)
        + print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)
        -
        -
        extern crate ManagementOfConfigurationApi;
        +                            
        +
        extern crate HealthCheckApi;
         
         pub fn main() {
         
        -    let mut context = ManagementOfConfigurationApi::Context::default();
        -    let result = client.getConfiguration(&context).wait();
        +    let mut context = HealthCheckApi::Context::default();
        +    let result = client.getStatus(&context).wait();
         
             println!("{:?}", result);
         }
        @@ -10467,23 +10001,23 @@ pub fn main() {
         
         
                                   

        Responses

        -

        -

        +

        +

        -

        -
        -
        +
        +
        -

        putConfiguration

        -

        Replace the current configuration file with the given configuration

        +

        getStatusV1

        +

        -

        +

        Returns status and statistics of this service


        -
        /a1-policy/v2/configuration
        +
        /status

        Usage and SDK Samples

        -
        -
        curl -X PUT \
        +                          
        +
        curl -X GET \
          -H "Accept: */*" \
        - -H "Content-Type: application/json" \
        - "http://localhost/a1-policy/v2/configuration" \
        - -d ''
        + "http://localhost/status"
         
        -
        +
        import org.openapitools.client.*;
         import org.openapitools.client.auth.*;
         import org.openapitools.client.model.*;
        -import org.openapitools.client.api.ManagementOfConfigurationApi;
        +import org.openapitools.client.api.HealthCheckApi;
         
         import java.io.File;
         import java.util.*;
         
        -public class ManagementOfConfigurationApiExample {
        +public class HealthCheckApiExample {
             public static void main(String[] args) {
         
                 // Create an instance of the API class
        -        ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
        -        Object body = Object; // Object | 
        +        HealthCheckApi apiInstance = new HealthCheckApi();
         
                 try {
        -            Object result = apiInstance.putConfiguration(body);
        +            'String' result = apiInstance.getStatusV1();
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
        +            System.err.println("Exception when calling HealthCheckApi#getStatusV1");
                     e.printStackTrace();
                 }
             }
        @@ -10670,38 +10131,35 @@ public class ManagementOfConfigurationApiExample {
         
        -
        -
        import org.openapitools.client.api.ManagementOfConfigurationApi;
        -
        -public class ManagementOfConfigurationApiExample {
        +                          
        +
        import org.openapitools.client.api.HealthCheckApi;
        +
        +public class HealthCheckApiExample {
             public static void main(String[] args) {
        -        ManagementOfConfigurationApi apiInstance = new ManagementOfConfigurationApi();
        -        Object body = Object; // Object | 
        +        HealthCheckApi apiInstance = new HealthCheckApi();
         
                 try {
        -            Object result = apiInstance.putConfiguration(body);
        +            'String' result = apiInstance.getStatusV1();
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
        +            System.err.println("Exception when calling HealthCheckApi#getStatusV1");
                     e.printStackTrace();
                 }
             }
         }
        -
        +
        
         
         // Create an instance of the API class
        -ManagementOfConfigurationApi *apiInstance = [[ManagementOfConfigurationApi alloc] init];
        -Object *body = Object; // 
        +HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
         
        -// Replace the current configuration file with the given configuration
        -[apiInstance putConfigurationWith:body
        -              completionHandler: ^(Object output, NSError* error) {
        +[apiInstance getStatusV1WithCompletionHandler: 
        +              ^('String' output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -10712,13 +10170,11 @@ Object *body = Object; //
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
        -var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
        -var body = Object; // {Object} 
        -
        +var api = new A1PolicyManagementService.HealthCheckApi()
         var callback = function(error, data, response) {
           if (error) {
             console.error(error);
        @@ -10726,14 +10182,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.putConfiguration(body, callback);
        +api.getStatusV1(callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -10742,21 +10198,19 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class putConfigurationExample
        +    public class getStatusV1Example
             {
                 public void main()
                 {
         
                     // Create an instance of the API class
        -            var apiInstance = new ManagementOfConfigurationApi();
        -            var body = Object;  // Object | 
        +            var apiInstance = new HealthCheckApi();
         
                     try {
        -                // Replace the current configuration file with the given configuration
        -                Object result = apiInstance.putConfiguration(body);
        +                'String' result = apiInstance.getStatusV1();
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling ManagementOfConfigurationApi.putConfiguration: " + e.Message );
        +                Debug.Print("Exception when calling HealthCheckApi.getStatusV1: " + e.Message );
                     }
                 }
             }
        @@ -10764,42 +10218,40 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
         // Create an instance of the API class
        -$api_instance = new OpenAPITools\Client\Api\ManagementOfConfigurationApi();
        -$body = Object; // Object | 
        +$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
         
         try {
        -    $result = $api_instance->putConfiguration($body);
        +    $result = $api_instance->getStatusV1();
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling ManagementOfConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling HealthCheckApi->getStatusV1: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
        -use WWW::OPenAPIClient::ManagementOfConfigurationApi;
        +use WWW::OPenAPIClient::HealthCheckApi;
         
         # Create an instance of the API class
        -my $api_instance = WWW::OPenAPIClient::ManagementOfConfigurationApi->new();
        -my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 
        +my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
         
         eval {
        -    my $result = $api_instance->putConfiguration(body => $body);
        +    my $result = $api_instance->getStatusV1();
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling ManagementOfConfigurationApi->putConfiguration: $@\n";
        +    warn "Exception when calling HealthCheckApi->getStatusV1: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -10807,25 +10259,22 @@ from openapi_client.rest import ApiException
         from pprint import pprint
         
         # Create an instance of the API class
        -api_instance = openapi_client.ManagementOfConfigurationApi()
        -body = Object # Object | 
        +api_instance = openapi_client.HealthCheckApi()
         
         try:
        -    # Replace the current configuration file with the given configuration
        -    api_response = api_instance.put_configuration(body)
        +    api_response = api_instance.get_status_v1()
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling ManagementOfConfigurationApi->putConfiguration: %s\n" % e)
        + print("Exception when calling HealthCheckApi->getStatusV1: %s\n" % e)
        -
        -
        extern crate ManagementOfConfigurationApi;
        +                            
        +
        extern crate HealthCheckApi;
         
         pub fn main() {
        -    let body = Object; // Object
         
        -    let mut context = ManagementOfConfigurationApi::Context::default();
        -    let result = client.putConfiguration(body, &context).wait();
        +    let mut context = HealthCheckApi::Context::default();
        +    let result = client.getStatusV1(&context).wait();
         
             println!("{:?}", result);
         }
        @@ -10842,139 +10291,27 @@ pub fn main() {
         
         
         
        -                            
        Body parameters
        - - - - - - - - - -
        NameDescription
        body * -

        - -
        -

        Responses

        -

        -

        - - - - - - -
        -
        -
        - -
        - -
        -
        -

        -

        +

        +

        -
        @@ -11100,7 +10367,7 @@ $(document).ready(function() {

        getRic

        -

        Returns info for one Near-RT RIC

        +

        Returns info of Near-RT RIC queried by the ric-id and managed-element-id

        @@ -11130,7 +10397,7 @@ $(document).ready(function() {
        curl -X GET \
        - -H "Accept: application/json" \
        + -H "Accept: application/json,application/problem+json" \
          "http://localhost/a1-policy/v2/rics/ric?managed_element_id=managedElementId_example&ric_id=ricId_example"
         
        @@ -11152,7 +10419,7 @@ public class NearRTRICRepositoryApiExample { String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for. try { - ric_info_v2 result = apiInstance.getRic(managedElementId, ricId); + ric_info result = apiInstance.getRic(managedElementId, ricId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NearRTRICRepositoryApi#getRic"); @@ -11173,7 +10440,7 @@ public class NearRTRICRepositoryApiExample { String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for. try { - ric_info_v2 result = apiInstance.getRic(managedElementId, ricId); + ric_info result = apiInstance.getRic(managedElementId, ricId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NearRTRICRepositoryApi#getRic"); @@ -11191,445 +10458,13 @@ public class NearRTRICRepositoryApiExample { // Create an instance of the API class NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init]; -String *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null) -String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (optional) (default to null) - -// Returns info for one Near-RT RIC -[apiInstance getRicWith:managedElementId - ricId:ricId - completionHandler: ^(ric_info_v2 output, NSError* error) { - if (output) { - NSLog(@"%@", output); - } - if (error) { - NSLog(@"Error: %@", error); - } -}]; -
        -
        - -
        -
        var A1PolicyManagementService = require('a1_policy_management_service');
        -
        -// Create an instance of the API class
        -var api = new A1PolicyManagementService.NearRTRICRepositoryApi()
        -var opts = {
        -  'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        -  'ricId': ricId_example // {String} The identity of a Near-RT RIC to get information for.
        -};
        -
        -var callback = function(error, data, response) {
        -  if (error) {
        -    console.error(error);
        -  } else {
        -    console.log('API called successfully. Returned data: ' + data);
        -  }
        -};
        -api.getRic(opts, callback);
        -
        -
        - - -
        -
        using System;
        -using System.Diagnostics;
        -using Org.OpenAPITools.Api;
        -using Org.OpenAPITools.Client;
        -using Org.OpenAPITools.Model;
        -
        -namespace Example
        -{
        -    public class getRicExample
        -    {
        -        public void main()
        -        {
        -
        -            // Create an instance of the API class
        -            var apiInstance = new NearRTRICRepositoryApi();
        -            var managedElementId = managedElementId_example;  // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional)  (default to null)
        -            var ricId = ricId_example;  // String | The identity of a Near-RT RIC to get information for. (optional)  (default to null)
        -
        -            try {
        -                // Returns info for one Near-RT RIC
        -                ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
        -                Debug.WriteLine(result);
        -            } catch (Exception e) {
        -                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
        -            }
        -        }
        -    }
        -}
        -
        -
        - -
        -
        <?php
        -require_once(__DIR__ . '/vendor/autoload.php');
        -
        -// Create an instance of the API class
        -$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
        -$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        -$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
        -
        -try {
        -    $result = $api_instance->getRic($managedElementId, $ricId);
        -    print_r($result);
        -} catch (Exception $e) {
        -    echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
        -}
        -?>
        -
        - -
        -
        use Data::Dumper;
        -use WWW::OPenAPIClient::Configuration;
        -use WWW::OPenAPIClient::NearRTRICRepositoryApi;
        -
        -# Create an instance of the API class
        -my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
        -my $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        -my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
        -
        -eval {
        -    my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId);
        -    print Dumper($result);
        -};
        -if ($@) {
        -    warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
        -}
        -
        - -
        -
        from __future__ import print_statement
        -import time
        -import openapi_client
        -from openapi_client.rest import ApiException
        -from pprint import pprint
        -
        -# Create an instance of the API class
        -api_instance = openapi_client.NearRTRICRepositoryApi()
        -managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
        -ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
        -
        -try:
        -    # Returns info for one Near-RT RIC
        -    api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId)
        -    pprint(api_response)
        -except ApiException as e:
        -    print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)
        -
        - -
        -
        extern crate NearRTRICRepositoryApi;
        -
        -pub fn main() {
        -    let managedElementId = managedElementId_example; // String
        -    let ricId = ricId_example; // String
        -
        -    let mut context = NearRTRICRepositoryApi::Context::default();
        -    let result = client.getRic(managedElementId, ricId, &context).wait();
        -
        -    println!("{:?}", result);
        -}
        -
        -
        -
        - -

        Scopes

        - - -
        - -

        Parameters

        - - - - - -
        Query parameters
        - - - - - - - - - - - - - -
        NameDescription
        managed_element_id - - -
        -
        -
        - - String - - -
        -The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. -
        -
        -
        -
        -
        ric_id - - -
        -
        -
        - - String - - -
        -The identity of a Near-RT RIC to get information for. -
        -
        -
        -
        -
        - -

        Responses

        -

        -

        - - - - - - -
        -
        -
        - -
        - -
        -
        -

        -

        - - - - - - -
        -
        -
        - -
        - -
        -
        -
        -
        -
        -
        -
        -
        -

        getRics

        -

        Query Near-RT RIC information

        -
        -
        -
        -

        -

        The call returns all Near-RT RICs that supports a given policy type identity

        -

        -
        -
        /a1-policy/v2/rics
        -

        -

        Usage and SDK Samples

        -

        - - -
        -
        -
        curl -X GET \
        - -H "Accept: application/json" \
        - "http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
        -
        -
        -
        -
        import org.openapitools.client.*;
        -import org.openapitools.client.auth.*;
        -import org.openapitools.client.model.*;
        -import org.openapitools.client.api.NearRTRICRepositoryApi;
        -
        -import java.io.File;
        -import java.util.*;
        -
        -public class NearRTRICRepositoryApiExample {
        -    public static void main(String[] args) {
        -
        -        // Create an instance of the API class
        -        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        -        String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
        -
        -        try {
        -            ric_info_list_v2 result = apiInstance.getRics(policytypeId);
        -            System.out.println(result);
        -        } catch (ApiException e) {
        -            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
        -            e.printStackTrace();
        -        }
        -    }
        -}
        -
        -
        - -
        -
        import org.openapitools.client.api.NearRTRICRepositoryApi;
        -
        -public class NearRTRICRepositoryApiExample {
        -    public static void main(String[] args) {
        -        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        -        String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
        -
        -        try {
        -            ric_info_list_v2 result = apiInstance.getRics(policytypeId);
        -            System.out.println(result);
        -        } catch (ApiException e) {
        -            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
        -            e.printStackTrace();
        -        }
        -    }
        -}
        -
        - -
        -
        
        -
        -// Create an instance of the API class
        -NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
        -String *policytypeId = policytypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
        +String *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
        +String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (optional) (default to null)
         
        -// Query Near-RT RIC information
        -[apiInstance getRicsWith:policytypeId
        -              completionHandler: ^(ric_info_list_v2 output, NSError* error) {
        +// Returns info of Near-RT RIC queried by the ric-id and managed-element-id
        +[apiInstance getRicWith:managedElementId
        +    ricId:ricId
        +              completionHandler: ^(ric_info output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -11640,13 +10475,14 @@ String *policytypeId = policytypeId_example; // The identity of a policy type. I
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
         var api = new A1PolicyManagementService.NearRTRICRepositoryApi()
         var opts = {
        -  'policytypeId': policytypeId_example // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
        +  'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        +  'ricId': ricId_example // {String} The identity of a Near-RT RIC to get information for.
         };
         
         var callback = function(error, data, response) {
        @@ -11656,14 +10492,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.getRics(opts, callback);
        +api.getRic(opts, callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -11672,21 +10508,22 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class getRicsExample
        +    public class getRicExample
             {
                 public void main()
                 {
         
                     // Create an instance of the API class
                     var apiInstance = new NearRTRICRepositoryApi();
        -            var policytypeId = policytypeId_example;  // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional)  (default to null)
        +            var managedElementId = managedElementId_example;  // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional)  (default to null)
        +            var ricId = ricId_example;  // String | The identity of a Near-RT RIC to get information for. (optional)  (default to null)
         
                     try {
        -                // Query Near-RT RIC information
        -                ric_info_list_v2 result = apiInstance.getRics(policytypeId);
        +                // Returns info of Near-RT RIC queried by the ric-id and managed-element-id
        +                ric_info result = apiInstance.getRic(managedElementId, ricId);
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
        +                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
                     }
                 }
             }
        @@ -11694,42 +10531,44 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
         // Create an instance of the API class
         $api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
        -$policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
        +$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        +$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
         
         try {
        -    $result = $api_instance->getRics($policytypeId);
        +    $result = $api_instance->getRic($managedElementId, $ricId);
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
         use WWW::OPenAPIClient::NearRTRICRepositoryApi;
         
         # Create an instance of the API class
         my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
        -my $policytypeId = policytypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
        +my $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        +my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
         
         eval {
        -    my $result = $api_instance->getRics(policytypeId => $policytypeId);
        +    my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId);
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
        +    warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -11738,24 +10577,26 @@ from pprint import pprint
         
         # Create an instance of the API class
         api_instance = openapi_client.NearRTRICRepositoryApi()
        -policytypeId = policytypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
        +managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
        +ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
         
         try:
        -    # Query Near-RT RIC information
        -    api_response = api_instance.get_rics(policytypeId=policytypeId)
        +    # Returns info of Near-RT RIC queried by the ric-id and managed-element-id
        +    api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId)
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)
        + print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)
        -
        +
        extern crate NearRTRICRepositoryApi;
         
         pub fn main() {
        -    let policytypeId = policytypeId_example; // String
        +    let managedElementId = managedElementId_example; // String
        +    let ricId = ricId_example; // String
         
             let mut context = NearRTRICRepositoryApi::Context::default();
        -    let result = client.getRics(policytypeId, &context).wait();
        +    let result = client.getRic(managedElementId, ricId, &context).wait();
         
             println!("{:?}", result);
         }
        @@ -11780,11 +10621,11 @@ pub fn main() {
                                         Name
                                         Description
                                       
        -                                policytype_id
        +                                managed_element_id
         
         
         
        -    
        +
        @@ -11792,7 +10633,27 @@ pub fn main() {
        -The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. +
        +
        +
        +
        + + + + ric_id + + + +
        +
        +
        + + String + + +
        +The identity of a Near-RT RIC to get information for.
        @@ -11803,23 +10664,23 @@ The identity of a policy type. If given, all Near-RT RICs supporting the policy

        Responses

        -

        -

        +

        +

        -

        -
        -
        -

        ServiceCallbacks

        -
        -
        +
        +
        -

        serviceCallback

        -

        Callback for Near-RT RIC status

        +

        getRics

        +

        Query Near-RT RIC information

        -

        The URL to this call is registered at Service registration.

        +

        The call returns all Near-RT RICs that supports a given policy type identity


        -
        /r-app/near-rt-ric-status
        +
        /a1-policy/v2/rics

        Usage and SDK Samples

        -
        -
        curl -X POST \
        - -H "Accept: application/json" \
        - -H "Content-Type: application/json" \
        - "http://localhost/r-app/near-rt-ric-status" \
        - -d ''
        +                          
        +
        curl -X GET \
        + -H "Accept: application/json,application/problem+json" \
        + "http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
         
        -
        +
        import org.openapitools.client.*;
         import org.openapitools.client.auth.*;
         import org.openapitools.client.model.*;
        -import org.openapitools.client.api.ServiceCallbacksApi;
        +import org.openapitools.client.api.NearRTRICRepositoryApi;
         
         import java.io.File;
         import java.util.*;
         
        -public class ServiceCallbacksApiExample {
        +public class NearRTRICRepositoryApiExample {
             public static void main(String[] args) {
         
                 // Create an instance of the API class
        -        ServiceCallbacksApi apiInstance = new ServiceCallbacksApi();
        -        ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 | 
        +        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        +        String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
         
                 try {
        -            Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
        +            ric_info_list result = apiInstance.getRics(policytypeId);
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling ServiceCallbacksApi#serviceCallback");
        +            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
                     e.printStackTrace();
                 }
             }
        @@ -12009,38 +10817,38 @@ public class ServiceCallbacksApiExample {
         
        -
        -
        import org.openapitools.client.api.ServiceCallbacksApi;
        +                          
        +
        import org.openapitools.client.api.NearRTRICRepositoryApi;
         
        -public class ServiceCallbacksApiExample {
        +public class NearRTRICRepositoryApiExample {
             public static void main(String[] args) {
        -        ServiceCallbacksApi apiInstance = new ServiceCallbacksApi();
        -        ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 | 
        +        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        +        String policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
         
                 try {
        -            Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
        +            ric_info_list result = apiInstance.getRics(policytypeId);
                     System.out.println(result);
                 } catch (ApiException e) {
        -            System.err.println("Exception when calling ServiceCallbacksApi#serviceCallback");
        +            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
                     e.printStackTrace();
                 }
             }
         }
        -
        +
        
         
         // Create an instance of the API class
        -ServiceCallbacksApi *apiInstance = [[ServiceCallbacksApi alloc] init];
        -ServiceCallbackInfoV2 *serviceCallbackInfoV2 = ; // 
        +NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
        +String *policytypeId = policytypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
         
        -// Callback for Near-RT RIC status
        -[apiInstance serviceCallbackWith:serviceCallbackInfoV2
        -              completionHandler: ^(Object output, NSError* error) {
        +// Query Near-RT RIC information
        +[apiInstance getRicsWith:policytypeId
        +              completionHandler: ^(ric_info_list output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
             }
        @@ -12051,12 +10859,14 @@ ServiceCallbackInfoV2 *serviceCallbackInfoV2 = ; //
         
        -
        +
        var A1PolicyManagementService = require('a1_policy_management_service');
         
         // Create an instance of the API class
        -var api = new A1PolicyManagementService.ServiceCallbacksApi()
        -var serviceCallbackInfoV2 = ; // {ServiceCallbackInfoV2} 
        +var api = new A1PolicyManagementService.NearRTRICRepositoryApi()
        +var opts = {
        +  'policytypeId': policytypeId_example // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
        +};
         
         var callback = function(error, data, response) {
           if (error) {
        @@ -12065,14 +10875,14 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.serviceCallback(serviceCallbackInfoV2, callback);
        +api.getRics(opts, callback);
         
        - -
        +
        using System;
         using System.Diagnostics;
         using Org.OpenAPITools.Api;
        @@ -12081,21 +10891,21 @@ using Org.OpenAPITools.Model;
         
         namespace Example
         {
        -    public class serviceCallbackExample
        +    public class getRicsExample
             {
                 public void main()
                 {
         
                     // Create an instance of the API class
        -            var apiInstance = new ServiceCallbacksApi();
        -            var serviceCallbackInfoV2 = new ServiceCallbackInfoV2(); // ServiceCallbackInfoV2 | 
        +            var apiInstance = new NearRTRICRepositoryApi();
        +            var policytypeId = policytypeId_example;  // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional)  (default to null)
         
                     try {
        -                // Callback for Near-RT RIC status
        -                Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
        +                // Query Near-RT RIC information
        +                ric_info_list result = apiInstance.getRics(policytypeId);
                         Debug.WriteLine(result);
                     } catch (Exception e) {
        -                Debug.Print("Exception when calling ServiceCallbacksApi.serviceCallback: " + e.Message );
        +                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
                     }
                 }
             }
        @@ -12103,42 +10913,42 @@ namespace Example
         
        -
        +
        <?php
         require_once(__DIR__ . '/vendor/autoload.php');
         
         // Create an instance of the API class
        -$api_instance = new OpenAPITools\Client\Api\ServiceCallbacksApi();
        -$serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 | 
        +$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
        +$policytypeId = policytypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
         
         try {
        -    $result = $api_instance->serviceCallback($serviceCallbackInfoV2);
        +    $result = $api_instance->getRics($policytypeId);
             print_r($result);
         } catch (Exception $e) {
        -    echo 'Exception when calling ServiceCallbacksApi->serviceCallback: ', $e->getMessage(), PHP_EOL;
        +    echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
         }
         ?>
        -
        +
        use Data::Dumper;
         use WWW::OPenAPIClient::Configuration;
        -use WWW::OPenAPIClient::ServiceCallbacksApi;
        +use WWW::OPenAPIClient::NearRTRICRepositoryApi;
         
         # Create an instance of the API class
        -my $api_instance = WWW::OPenAPIClient::ServiceCallbacksApi->new();
        -my $serviceCallbackInfoV2 = WWW::OPenAPIClient::Object::ServiceCallbackInfoV2->new(); # ServiceCallbackInfoV2 | 
        +my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
        +my $policytypeId = policytypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
         
         eval {
        -    my $result = $api_instance->serviceCallback(serviceCallbackInfoV2 => $serviceCallbackInfoV2);
        +    my $result = $api_instance->getRics(policytypeId => $policytypeId);
             print Dumper($result);
         };
         if ($@) {
        -    warn "Exception when calling ServiceCallbacksApi->serviceCallback: $@\n";
        +    warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
         }
        -
        +
        from __future__ import print_statement
         import time
         import openapi_client
        @@ -12146,25 +10956,25 @@ from openapi_client.rest import ApiException
         from pprint import pprint
         
         # Create an instance of the API class
        -api_instance = openapi_client.ServiceCallbacksApi()
        -serviceCallbackInfoV2 =  # ServiceCallbackInfoV2 | 
        +api_instance = openapi_client.NearRTRICRepositoryApi()
        +policytypeId = policytypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
         
         try:
        -    # Callback for Near-RT RIC status
        -    api_response = api_instance.service_callback(serviceCallbackInfoV2)
        +    # Query Near-RT RIC information
        +    api_response = api_instance.get_rics(policytypeId=policytypeId)
             pprint(api_response)
         except ApiException as e:
        -    print("Exception when calling ServiceCallbacksApi->serviceCallback: %s\n" % e)
        + print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)
        -
        -
        extern crate ServiceCallbacksApi;
        +                            
        +
        extern crate NearRTRICRepositoryApi;
         
         pub fn main() {
        -    let serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2
        +    let policytypeId = policytypeId_example; // String
         
        -    let mut context = ServiceCallbacksApi::Context::default();
        -    let result = client.serviceCallback(serviceCallbackInfoV2, &context).wait();
        +    let mut context = NearRTRICRepositoryApi::Context::default();
        +    let result = client.getRics(policytypeId, &context).wait();
         
             println!("{:?}", result);
         }
        @@ -12181,73 +10991,54 @@ pub fn main() {
         
         
         
        -                            
        Body parameters
        + + +
        Query parameters
        - - -
        Name Description
        serviceCallbackInfoV2 * -

        - -
        +
        +
        +
        + + String + + +
        +The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +
        +
        +
        +
        - -

        Responses

        -

        -

        +

        +

        -

        @@ -12307,12 +11116,12 @@ $(document).ready(function() {

        deleteService

        -

        Unregister a service

        +

        -

        +

        Unregister a service


        /a1-policy/v2/services/{service_id}
        @@ -12337,7 +11146,7 @@ $(document).ready(function() {
        curl -X DELETE \
        - -H "Accept: */*" \
        + -H "Accept: */*,application/problem+json" \
          "http://localhost/a1-policy/v2/services/{service_id}"
         
        @@ -12398,7 +11207,6 @@ public class ServiceRegistryAndSupervisionApiExample { ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init]; String *serviceId = serviceId_example; // (default to null) -// Unregister a service [apiInstance deleteServiceWith:serviceId completionHandler: ^(Object output, NSError* error) { if (output) { @@ -12451,7 +11259,6 @@ namespace Example var serviceId = serviceId_example; // String | (default to null) try { - // Unregister a service Object result = apiInstance.deleteService(serviceId); Debug.WriteLine(result); } catch (Exception e) { @@ -12510,7 +11317,6 @@ api_instance = openapi_client.ServiceRegistryAndSupervisionApi() serviceId = serviceId_example # String | (default to null) try: - # Unregister a service api_response = api_instance.delete_service(serviceId) pprint(api_response) except ApiException as e: @@ -12572,76 +11378,10 @@ pub fn main() {

        Responses

        -

        -

        - - - - - - -
        -
        -
        - -
        - -
        -

        -
        - -
        @@ -12807,7 +11499,7 @@ pub fn main() {
        curl -X GET \
        - -H "Accept: application/json" \
        + -H "Accept: application/json,application/problem+json" \
          "http://localhost/a1-policy/v2/services?service_id=serviceId_example"
         
        @@ -12828,7 +11520,7 @@ public class ServiceRegistryAndSupervisionApiExample { String serviceId = serviceId_example; // String | The identity of the service try { - service_list_v2 result = apiInstance.getServices(serviceId); + service_status_list result = apiInstance.getServices(serviceId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices"); @@ -12848,7 +11540,7 @@ public class ServiceRegistryAndSupervisionApiExample { String serviceId = serviceId_example; // String | The identity of the service try { - service_list_v2 result = apiInstance.getServices(serviceId); + service_status_list result = apiInstance.getServices(serviceId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices"); @@ -12870,7 +11562,7 @@ String *serviceId = serviceId_example; // The identity of the service (optional) // Returns service information [apiInstance getServicesWith:serviceId - completionHandler: ^(service_list_v2 output, NSError* error) { + completionHandler: ^(service_status_list output, NSError* error) { if (output) { NSLog(@"%@", output); } @@ -12924,7 +11616,7 @@ namespace Example try { // Returns service information - service_list_v2 result = apiInstance.getServices(serviceId); + service_status_list result = apiInstance.getServices(serviceId); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.getServices: " + e.Message ); @@ -13074,22 +11766,18 @@ The identity of the service
        -
        - -
        @@ -13213,7 +11857,7 @@ The identity of the service
        curl -X PUT \
        - -H "Accept: */*" \
        + -H "Accept: */*,application/problem+json" \
          "http://localhost/a1-policy/v2/services/{service_id}/keepalive"
         
        @@ -13451,7 +12095,7 @@ pub fn main() {

        -
        - - @@ -13617,7 +12213,7 @@ pub fn main() {
        curl -X PUT \
        - -H "Accept: */*" \
        + -H "Accept: */*,application/problem+json" \
          -H "Content-Type: application/json" \
          "http://localhost/a1-policy/v2/services" \
          -d ''
        @@ -13637,10 +12233,10 @@ public class ServiceRegistryAndSupervisionApiExample {
         
                 // Create an instance of the API class
                 ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        -        ServiceRegistrationInfoV2 serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2 | 
        +        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
         
                 try {
        -            Object result = apiInstance.putService(serviceRegistrationInfoV2);
        +            Object result = apiInstance.putService(serviceRegistrationInfo);
                     System.out.println(result);
                 } catch (ApiException e) {
                     System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
        @@ -13657,10 +12253,10 @@ public class ServiceRegistryAndSupervisionApiExample {
         public class ServiceRegistryAndSupervisionApiExample {
             public static void main(String[] args) {
                 ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        -        ServiceRegistrationInfoV2 serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2 | 
        +        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
         
                 try {
        -            Object result = apiInstance.putService(serviceRegistrationInfoV2);
        +            Object result = apiInstance.putService(serviceRegistrationInfo);
                     System.out.println(result);
                 } catch (ApiException e) {
                     System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
        @@ -13678,10 +12274,10 @@ public class ServiceRegistryAndSupervisionApiExample {
         
         // Create an instance of the API class
         ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
        -ServiceRegistrationInfoV2 *serviceRegistrationInfoV2 = ; // 
        +ServiceRegistrationInfo *serviceRegistrationInfo = ; // 
         
         // Register a service
        -[apiInstance putServiceWith:serviceRegistrationInfoV2
        +[apiInstance putServiceWith:serviceRegistrationInfo
                       completionHandler: ^(Object output, NSError* error) {
             if (output) {
                 NSLog(@"%@", output);
        @@ -13698,7 +12294,7 @@ ServiceRegistrationInfoV2 *serviceRegistrationInfoV2 = ; //
         
         // Create an instance of the API class
         var api = new A1PolicyManagementService.ServiceRegistryAndSupervisionApi()
        -var serviceRegistrationInfoV2 = ; // {ServiceRegistrationInfoV2} 
        +var serviceRegistrationInfo = ; // {ServiceRegistrationInfo} 
         
         var callback = function(error, data, response) {
           if (error) {
        @@ -13707,7 +12303,7 @@ var callback = function(error, data, response) {
             console.log('API called successfully. Returned data: ' + data);
           }
         };
        -api.putService(serviceRegistrationInfoV2, callback);
        +api.putService(serviceRegistrationInfo, callback);
         
        @@ -13730,11 +12326,11 @@ namespace Example // Create an instance of the API class var apiInstance = new ServiceRegistryAndSupervisionApi(); - var serviceRegistrationInfoV2 = new ServiceRegistrationInfoV2(); // ServiceRegistrationInfoV2 | + var serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | try { // Register a service - Object result = apiInstance.putService(serviceRegistrationInfoV2); + Object result = apiInstance.putService(serviceRegistrationInfo); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.putService: " + e.Message ); @@ -13751,10 +12347,10 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi(); -$serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2 | +$serviceRegistrationInfo = ; // ServiceRegistrationInfo | try { - $result = $api_instance->putService($serviceRegistrationInfoV2); + $result = $api_instance->putService($serviceRegistrationInfo); print_r($result); } catch (Exception $e) { echo 'Exception when calling ServiceRegistryAndSupervisionApi->putService: ', $e->getMessage(), PHP_EOL; @@ -13769,10 +12365,10 @@ use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new(); -my $serviceRegistrationInfoV2 = WWW::OPenAPIClient::Object::ServiceRegistrationInfoV2->new(); # ServiceRegistrationInfoV2 | +my $serviceRegistrationInfo = WWW::OPenAPIClient::Object::ServiceRegistrationInfo->new(); # ServiceRegistrationInfo | eval { - my $result = $api_instance->putService(serviceRegistrationInfoV2 => $serviceRegistrationInfoV2); + my $result = $api_instance->putService(serviceRegistrationInfo => $serviceRegistrationInfo); print Dumper($result); }; if ($@) { @@ -13789,11 +12385,11 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.ServiceRegistryAndSupervisionApi() -serviceRegistrationInfoV2 = # ServiceRegistrationInfoV2 | +serviceRegistrationInfo = # ServiceRegistrationInfo | try: # Register a service - api_response = api_instance.put_service(serviceRegistrationInfoV2) + api_response = api_instance.put_service(serviceRegistrationInfo) pprint(api_response) except ApiException as e: print("Exception when calling ServiceRegistryAndSupervisionApi->putService: %s\n" % e)
        @@ -13803,10 +12399,10 @@ except ApiException as e:
        extern crate ServiceRegistryAndSupervisionApi;
         
         pub fn main() {
        -    let serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2
        +    let serviceRegistrationInfo = ; // ServiceRegistrationInfo
         
             let mut context = ServiceRegistryAndSupervisionApi::Context::default();
        -    let result = client.putService(serviceRegistrationInfoV2, &context).wait();
        +    let result = client.putService(serviceRegistrationInfo, &context).wait();
         
             println!("{:?}", result);
         }
        @@ -13829,20 +12425,20 @@ pub fn main() {
                                         Name
                                         Description
                                       
        -                                serviceRegistrationInfoV2 *
        +                                serviceRegistrationInfo *
         
         

        -
        +
        @@ -13876,7 +12472,7 @@ $(document).ready(function() {