Select&squash recent updates & fixes from master branch, adapted for new-delhi branch. Including:
https://gerrit.onap.org/r/c/ccsdk/oran/+/138693
Set serviceId in v2 policy_info to optional and blank by default - master
https://gerrit.onap.org/r/c/ccsdk/oran/+/138734
new onap logo
https://gerrit.onap.org/r/c/ccsdk/oran/+/138762
Improving code-coverage for the Handle non transient policy deletion bug fix - master
https://gerrit.onap.org/r/c/ccsdk/oran/+/138788
Enable springboot test for AsyncRestClientTest
https://gerrit.onap.org/r/c/ccsdk/oran/+/138787
Re-arrange application properties
*PARTIAL
https://gerrit.onap.org/r/c/ccsdk/oran/+/138772
Improve tests/issues found in Sonar report - A1 Oslo-Part2
https://gerrit.onap.org/r/c/ccsdk/oran/+/138827
Dependecy update in a1pms using spring parent 3.3.2
https://gerrit.onap.org/r/c/ccsdk/oran/+/138862
Improve tests/issues found in Sonar report - A1 Oslo/NewDelhi/Montreal/London-Part3-master
Issue-ID: CCSDK-3968
Change-Id: I40f7585e9416f03c8bec2b00d57dadb05bc624ca
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
description: "Returns a list of A1 policies matching given search criteria.\
\ <br>If several query parameters are defined, the policies matching all conditions\
\ are returned."
- operationId: getPolicyIds
+ operationId: getAllPolicies
parameters:
- description: Select policies of a given policy type identity.
explode: true
-{
- "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. <br>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 <typename_version>)",
- "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.<br>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 <typename_version>)",
- "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:<ul><li>Get callbacks about available NearRT RICs.<\/li><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. <br>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 <typename_version>)",
- "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": "<h2>General<\/h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:<\/p><ul><li>A1 Policy creation, modification and deletion.<\/li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs<\/li><li>Maintaining a view of supported Near-RT RIC policy types<\/li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.<\/li><\/ul><h2>APIs provided or defined by the service<\/h2><h3>A1 Policy Management<\/h3><p>This is an API for management of A1 Policies.<\/p><ul><li>A1 Policy retrieval, creation, modification and deletion.<\/li><li>Retrieval of supported A1 Policy types for a Near-RT RIC<\/li><li>Retrieval of status for existing A1 policies<\/li><\/ul><h3>Management of configuration<\/h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.<\/p><h3>Service callbacks<\/h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.<\/p><h3>NearRT-RIC Repository<\/h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.<\/p><h3>Health Check<\/h3><p>API used for supervision of the PMS component.<\/p><h3>Service Registry and Supervision<\/h3><p>API used for 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><h3>Authorization API<\/h3><p>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><h3>Spring Boot Actuator<\/h3><p>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/"
- }
- }
- ]
+{\r
+ "openapi" : "3.0.3",\r
+ "info" : {\r
+ "title" : "A1 Policy Management Service",\r
+ "description" : "<h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>",\r
+ "contact" : {\r
+ "url" : "https://www.onap.org/",\r
+ "email" : "discuss-list@onap.com"\r
+ },\r
+ "license" : {\r
+ "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.",\r
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0"\r
+ },\r
+ "version" : "1.3.0",\r
+ "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8",\r
+ "x-audience" : "external-public"\r
+ },\r
+ "servers" : [ {\r
+ "url" : "/"\r
+ } ],\r
+ "tags" : [ {\r
+ "name" : "A1 Policy Management",\r
+ "description" : "API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances."\r
+ }, {\r
+ "name" : "NearRT-RIC Repository",\r
+ "description" : "API used to get the NearRT-RIC for the managed element."\r
+ }, {\r
+ "name" : "Service Registry and Supervision",\r
+ "description" : "API used to keep the service Alive with in the timeout period"\r
+ }, {\r
+ "name" : "Health Check",\r
+ "description" : "API used to get the health status and statistics of this service"\r
+ }, {\r
+ "name" : "Service callbacks"\r
+ }, {\r
+ "name" : "Authorization API",\r
+ "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA). <br> Note that this API is called by PMS, it is not provided."\r
+ }, {\r
+ "name" : "Configuration",\r
+ "description" : "API used to create or fetch the application configuration."\r
+ }, {\r
+ "name" : "Actuator",\r
+ "description" : "Monitor and interact",\r
+ "externalDocs" : {\r
+ "description" : "Spring Boot Actuator Web API Documentation",\r
+ "url" : "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"\r
+ }\r
+ } ],\r
+ "paths" : {\r
+ "/a1-policy/v2/policy-instances" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "summary" : "Query for A1 policy instances",\r
+ "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",\r
+ "operationId" : "getPolicyInstances",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "query",\r
+ "description" : "Select policies with a given type identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "Select policies for a given Near-RT RIC identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "service_id",\r
+ "in" : "query",\r
+ "description" : "Select policies owned by a given service.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "type_name",\r
+ "in" : "query",\r
+ "description" : "Select policies of a given type name (type identity has the format <typename_version>)",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Returns A1 Policies which matches the criteria",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info_list"\r
+ },\r
+ "examples" : {\r
+ "policy_info_list" : {\r
+ "$ref" : "#/components/examples/policy_info_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found - Near-RT RIC, policy type or service not found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/example-authz-check" : {\r
+ "post" : {\r
+ "tags" : [ "Authorization API" ],\r
+ "summary" : "Request for access authorization.",\r
+ "description" : "The authorization function decides if access is granted.",\r
+ "operationId" : "performAccessControl",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_authorization"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/authorization_result"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "403" : {\r
+ "description" : "Forbidden",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 403,\r
+ "title" : "Forbidden",\r
+ "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/threaddump" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'threaddump'",\r
+ "operationId" : "threaddump",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "text/plain;charset=UTF-8" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/status" : {\r
+ "get" : {\r
+ "tags" : [ "Health Check" ],\r
+ "description" : "Returns status and statistics of this service",\r
+ "operationId" : "getStatus",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK- Service is living Ok",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/status_info"\r
+ },\r
+ "examples" : {\r
+ "status_info" : {\r
+ "$ref" : "#/components/examples/status_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/loggers" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'loggers'",\r
+ "operationId" : "loggers",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator/health/**" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'health-path'",\r
+ "operationId" : "health-path",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/rics/ric" : {\r
+ "get" : {\r
+ "tags" : [ "NearRT-RIC Repository" ],\r
+ "summary" : "Returns info of Near-RT RIC queried by the ric-id and managed-element-id",\r
+ "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).",\r
+ "operationId" : "getRic",\r
+ "parameters" : [ {\r
+ "name" : "managed_element_id",\r
+ "in" : "query",\r
+ "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "The identity of a Near-RT RIC to get information for.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Near-RT RIC is found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/ric_info"\r
+ },\r
+ "examples" : {\r
+ "ric_info" : {\r
+ "$ref" : "#/components/examples/ric_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/shutdown" : {\r
+ "post" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'shutdown'",\r
+ "operationId" : "shutdown",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/policy-types" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Query policy type identities",\r
+ "operationId" : "getPolicyTypes",\r
+ "parameters" : [ {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "Select types for the given Near-RT RIC identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "type_name",\r
+ "in" : "query",\r
+ "description" : "Select types with the given type name (type identity has the format <typename_version>)",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "compatible_with_version",\r
+ "in" : "query",\r
+ "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.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy Type IDs Found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_type_id_list"\r
+ },\r
+ "examples" : {\r
+ "policy_type_id_list" : {\r
+ "$ref" : "#/components/examples/policy_type_id_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/policies/{policy_id}" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Returns a policy",\r
+ "operationId" : "getPolicy",\r
+ "parameters" : [ {\r
+ "name" : "policy_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ },\r
+ "examples" : {\r
+ "policy_info" : {\r
+ "$ref" : "#/components/examples/policy_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "delete" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "summary" : "Delete a policy",\r
+ "description" : "Deleting the policy using the Policy's Policy ID.",\r
+ "operationId" : "deletePolicy",\r
+ "parameters" : [ {\r
+ "name" : "policy_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy deleted",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "423" : {\r
+ "description" : "Locked - HTTP Status code which can be used when the state is Locked",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 423,\r
+ "title" : "Locked",\r
+ "detail" : "Requested resource is in a locked state."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/metrics/{requiredMetricName}" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'metrics-requiredMetricName'",\r
+ "operationId" : "metrics-requiredMetricName",\r
+ "parameters" : [ {\r
+ "name" : "requiredMetricName",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/configuration" : {\r
+ "get" : {\r
+ "tags" : [ "Configuration" ],\r
+ "description" : "Returns the contents of the application configuration file",\r
+ "operationId" : "getConfiguration",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Configuration",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ },\r
+ "put" : {\r
+ "tags" : [ "Configuration" ],\r
+ "description" : "Replace the current configuration with the given configuration",\r
+ "operationId" : "putConfiguration",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Configuration updated",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "400" : {\r
+ "description" : "Bad Request",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 400,\r
+ "title" : "Bad Request",\r
+ "detail" : "The provided request is not valid."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator root web endpoint",\r
+ "operationId" : "links",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "$ref" : "#/components/schemas/Link"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "$ref" : "#/components/schemas/Link"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "$ref" : "#/components/schemas/Link"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator/loggers/{name}" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'loggers-name'",\r
+ "operationId" : "loggers-name",\r
+ "parameters" : [ {\r
+ "name" : "name",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ },\r
+ "post" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'loggers-name'",\r
+ "operationId" : "loggers-name_2",\r
+ "parameters" : [ {\r
+ "name" : "name",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "string",\r
+ "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/services/{service_id}/keepalive" : {\r
+ "put" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "summary" : "Heartbeat indicates that the service is running",\r
+ "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)",\r
+ "operationId" : "keepAliveService",\r
+ "parameters" : [ {\r
+ "name" : "service_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Service supervision timer refreshed, OK",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/metrics" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'metrics'",\r
+ "operationId" : "metrics",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/rics" : {\r
+ "get" : {\r
+ "tags" : [ "NearRT-RIC Repository" ],\r
+ "summary" : "Query Near-RT RIC information",\r
+ "description" : "The call returns all Near-RT RICs that supports a given policy type identity",\r
+ "operationId" : "getRics",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "query",\r
+ "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/ric_info_list"\r
+ },\r
+ "examples" : {\r
+ "ric_info_list" : {\r
+ "$ref" : "#/components/examples/ric_info_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/services" : {\r
+ "get" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "summary" : "Returns service information",\r
+ "description" : "Either information about a registered service with given identity or all registered services are returned.",\r
+ "operationId" : "getServices",\r
+ "parameters" : [ {\r
+ "name" : "service_id",\r
+ "in" : "query",\r
+ "description" : "The identity of the service",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_status_list"\r
+ },\r
+ "examples" : {\r
+ "service_status_list" : {\r
+ "$ref" : "#/components/examples/service_status_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "put" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "summary" : "Register a service",\r
+ "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><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.",\r
+ "operationId" : "putService",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_registration_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Service updated",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "201" : {\r
+ "description" : "Created - Service created",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "400" : {\r
+ "description" : "Bad Request",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 400,\r
+ "title" : "Bad Request",\r
+ "detail" : "The provided request is not valid."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "callbacks" : {\r
+ "RICStatus" : {\r
+ "{$request.body#/callback_url}" : {\r
+ "post" : {\r
+ "tags" : [ "Service callbacks" ],\r
+ "summary" : "Callback for Near-RT RIC status",\r
+ "description" : "The URL to this call is registered at Service registration.",\r
+ "operationId" : "serviceCallback",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_callback_info_v2"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/info" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'info'",\r
+ "operationId" : "info",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/status" : {\r
+ "get" : {\r
+ "tags" : [ "Health Check" ],\r
+ "description" : "Returns status and statistics of this service",\r
+ "operationId" : "getStatusV1",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Service is living",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/policy-types/{policytype_id}" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Returns a policy type definition",\r
+ "operationId" : "getPolicyTypeDefinition",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - schema of the given policy type",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_type_definition"\r
+ },\r
+ "examples" : {\r
+ "policy_type_definition" : {\r
+ "$ref" : "#/components/examples/policy_type_definition"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/logfile" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'logfile'",\r
+ "operationId" : "logfile",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "text/plain;charset=UTF-8" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator/health" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'health'",\r
+ "operationId" : "health",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/policies" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "summary" : "Query policy identities",\r
+ "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",\r
+ "operationId" : "getPolicyIds",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "query",\r
+ "description" : "Select policies of a given policy type identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "Select policies of a given Near-RT RIC identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "service_id",\r
+ "in" : "query",\r
+ "description" : "Select policies owned by a given service.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "type_name",\r
+ "in" : "query",\r
+ "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy identities",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_id_list"\r
+ },\r
+ "examples" : {\r
+ "policy_id_list" : {\r
+ "$ref" : "#/components/examples/policy_id_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "put" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Create or update a policy",\r
+ "operationId" : "putPolicy",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy updated",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "201" : {\r
+ "description" : "Created - Policy created",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "423" : {\r
+ "description" : "Locked - HTTP Status code which can be used when the state is Locked",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 423,\r
+ "title" : "Locked",\r
+ "detail" : "Requested resource is in a locked state."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/services/{service_id}" : {\r
+ "delete" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "description" : "Unregister a service",\r
+ "operationId" : "deleteService",\r
+ "parameters" : [ {\r
+ "name" : "service_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "204" : {\r
+ "description" : "No Content - Service unregistered",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/heapdump" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'heapdump'",\r
+ "operationId" : "heapdump",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/octet-stream" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/policies/{policy_id}/status" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Returns a policy status",\r
+ "operationId" : "getPolicyStatus",\r
+ "parameters" : [ {\r
+ "name" : "policy_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy status",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_status_info"\r
+ },\r
+ "examples" : {\r
+ "policy_status_info" : {\r
+ "$ref" : "#/components/examples/policy_status_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "components" : {\r
+ "schemas" : {\r
+ "policy_type_definition" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_schema" : {\r
+ "type" : "object",\r
+ "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema"\r
+ }\r
+ },\r
+ "description" : "Contains policy type schema definition"\r
+ },\r
+ "error_information" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "detail" : {\r
+ "type" : "string",\r
+ "description" : " A human-readable explanation specific to this occurrence of the problem.",\r
+ "example" : "Policy type not found"\r
+ },\r
+ "title" : {\r
+ "type" : "string",\r
+ "description" : "A specific error name",\r
+ "example" : "Not Found"\r
+ },\r
+ "status" : {\r
+ "type" : "integer",\r
+ "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ",\r
+ "format" : "int32",\r
+ "example" : 404\r
+ }\r
+ },\r
+ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807"\r
+ },\r
+ "void" : {\r
+ "type" : "object",\r
+ "description" : "Void/empty"\r
+ },\r
+ "status_info" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "status" : {\r
+ "type" : "string",\r
+ "description" : "status text"\r
+ }\r
+ }\r
+ },\r
+ "authorization_result" : {\r
+ "required" : [ "result" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "result" : {\r
+ "type" : "boolean",\r
+ "description" : "If true, the access is granted"\r
+ }\r
+ },\r
+ "description" : "Result of authorization",\r
+ "example" : {\r
+ "result" : true\r
+ }\r
+ },\r
+ "ric_info" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the Near-RT RIC"\r
+ },\r
+ "managed_element_ids" : {\r
+ "type" : "array",\r
+ "description" : "O1 identities for managed entities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "O1 identities for managed entities"\r
+ }\r
+ },\r
+ "state" : {\r
+ "type" : "string",\r
+ "description" : "Represents the states for a Near-RT RIC",\r
+ "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ]\r
+ },\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "supported policy types",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "supported policy types"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information for a Near-RT RIC"\r
+ },\r
+ "service_registration_info" : {\r
+ "required" : [ "service_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of Near-RT RIC state changes"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "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.",\r
+ "format" : "int64"\r
+ }\r
+ },\r
+ "description" : "Information for one service"\r
+ },\r
+ "policy_info_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policies" : {\r
+ "type" : "array",\r
+ "description" : "List of policy information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of policy information"\r
+ },\r
+ "policy_status_info" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "last_modified" : {\r
+ "type" : "string",\r
+ "description" : "timestamp, last modification time"\r
+ },\r
+ "status" : {\r
+ "type" : "object",\r
+ "description" : "the Policy status"\r
+ }\r
+ },\r
+ "description" : "Status for one A1-P Policy"\r
+ },\r
+ "service_status" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of RIC synchronization"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "policy keep alive timeout",\r
+ "format" : "int64"\r
+ },\r
+ "time_since_last_activity_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "time since last invocation by the service",\r
+ "format" : "int64"\r
+ }\r
+ }\r
+ },\r
+ "ric_info_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "rics" : {\r
+ "type" : "array",\r
+ "description" : "List of Near-RT RIC information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/ric_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of Near-RT RIC information"\r
+ },\r
+ "input" : {\r
+ "required" : [ "access_type", "auth_token", "policy_type_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "access_type" : {\r
+ "type" : "string",\r
+ "description" : "Access type",\r
+ "enum" : [ "READ", "WRITE", "DELETE" ]\r
+ },\r
+ "auth_token" : {\r
+ "type" : "string",\r
+ "description" : "Authorization token"\r
+ },\r
+ "policy_type_id" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identifier"\r
+ }\r
+ },\r
+ "description" : "input"\r
+ },\r
+ "policy_authorization" : {\r
+ "required" : [ "input" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "input" : {\r
+ "$ref" : "#/components/schemas/input"\r
+ }\r
+ },\r
+ "description" : "Authorization request for A1 policy requests"\r
+ },\r
+ "policy_type_id_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy type identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information about policy types"\r
+ },\r
+ "policy_info" : {\r
+ "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the target Near-RT RIC"\r
+ },\r
+ "policy_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy"\r
+ },\r
+ "transient" : {\r
+ "type" : "boolean",\r
+ "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",\r
+ "nullable" : false,\r
+ "example" : false,\r
+ "default" : false\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "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.",\r
+ "default" : ""\r
+ },\r
+ "policy_data" : {\r
+ "type" : "object",\r
+ "description" : "the configuration of the policy"\r
+ },\r
+ "status_notification_uri" : {\r
+ "type" : "string",\r
+ "description" : "Callback URI for policy status updates"\r
+ },\r
+ "policytype_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy type"\r
+ }\r
+ },\r
+ "description" : "Information for one A1-P Policy"\r
+ },\r
+ "policy_id_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "A list of policy identities",\r
+ "example" : {\r
+ "policy_ids" : [ "policy_ids", "policy_ids" ]\r
+ }\r
+ },\r
+ "service_status_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "service_list" : {\r
+ "type" : "array",\r
+ "description" : "List of service information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/service_status"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "service_callback_info_v2" : {\r
+ "required" : [ "event_type", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of a Near-RT RIC"\r
+ },\r
+ "event_type" : {\r
+ "type" : "string",\r
+ "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",\r
+ "enum" : [ "AVAILABLE" ]\r
+ }\r
+ },\r
+ "description" : "Information transferred as in Service callbacks (callback_url)"\r
+ },\r
+ "Link" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "templated" : {\r
+ "type" : "boolean"\r
+ },\r
+ "href" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "responses" : {\r
+ "Locked" : {\r
+ "description" : "Locked - HTTP Status code which can be used when the state is Locked",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 423,\r
+ "title" : "Locked",\r
+ "detail" : "Requested resource is in a locked state."\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "BadRequest" : {\r
+ "description" : "Bad Request",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 400,\r
+ "title" : "Bad Request",\r
+ "detail" : "The provided request is not valid."\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "Forbidden" : {\r
+ "description" : "Forbidden",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 403,\r
+ "title" : "Forbidden",\r
+ "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights."\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "NotFound" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "examples" : {\r
+ "service_status" : {\r
+ "description" : "List of service information",\r
+ "value" : {\r
+ "callback_url" : "callback_url",\r
+ "service_id" : "service_id",\r
+ "keep_alive_interval_seconds" : 0,\r
+ "time_since_last_activity_seconds" : 6\r
+ }\r
+ },\r
+ "service_status_list" : {\r
+ "description" : "List of service information",\r
+ "value" : {\r
+ "service_list" : [ {\r
+ "callback_url" : "callback_url",\r
+ "service_id" : "service_id",\r
+ "keep_alive_interval_seconds" : 0,\r
+ "time_since_last_activity_seconds" : 6\r
+ }, {\r
+ "callback_url" : "callback_url",\r
+ "service_id" : "service_id",\r
+ "keep_alive_interval_seconds" : 0,\r
+ "time_since_last_activity_seconds" : 6\r
+ } ]\r
+ }\r
+ },\r
+ "policy_type_definition" : {\r
+ "description" : "Schema of the given Policy type",\r
+ "value" : {\r
+ "policy_schema" : "{}"\r
+ }\r
+ },\r
+ "policy_type_id_list" : {\r
+ "description" : "Array of policy type id's",\r
+ "value" : {\r
+ "policy_type_id_list" : [ "policytype_id", "policytype_id" ]\r
+ }\r
+ },\r
+ "policy_info" : {\r
+ "description" : "Policy information of one A1-P policy",\r
+ "value" : {\r
+ "ric_id" : "ric_id",\r
+ "policy_id" : "policy_id",\r
+ "transient" : false,\r
+ "service_id" : "service_id",\r
+ "policy_data" : "{}",\r
+ "status_notification_uri" : "status_notification_uri",\r
+ "policytype_id" : "policytype_id"\r
+ }\r
+ },\r
+ "policy_info_list" : {\r
+ "description" : "List of policy information",\r
+ "value" : {\r
+ "policies" : [ {\r
+ "ric_id" : "ric_id",\r
+ "policy_id" : "policy_id",\r
+ "transient" : false,\r
+ "service_id" : "service_id",\r
+ "policy_data" : "{}",\r
+ "status_notification_uri" : "status_notification_uri",\r
+ "policytype_id" : "policytype_id"\r
+ }, {\r
+ "ric_id" : "ric_id",\r
+ "policy_id" : "policy_id",\r
+ "transient" : false,\r
+ "service_id" : "service_id",\r
+ "policy_data" : "{}",\r
+ "status_notification_uri" : "status_notification_uri",\r
+ "policytype_id" : "policytype_id"\r
+ } ]\r
+ }\r
+ },\r
+ "policy_id_list" : {\r
+ "description" : "A list of policy identities",\r
+ "value" : {\r
+ "policy_ids" : [ "some_policy_id", "some_policy_id" ]\r
+ }\r
+ },\r
+ "policy_status_info" : {\r
+ "description" : "Status for one A1-P Policy",\r
+ "value" : {\r
+ "last_modified" : "last_modified",\r
+ "status" : {\r
+ "value" : {\r
+ "status" : "status"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "status_info" : {\r
+ "value" : {\r
+ "status" : "status"\r
+ }\r
+ },\r
+ "ric_info" : {\r
+ "value" : {\r
+ "ric_id" : "ric_id",\r
+ "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ],\r
+ "state" : "UNAVAILABLE",\r
+ "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ]\r
+ }\r
+ },\r
+ "ric_info_list" : {\r
+ "value" : {\r
+ "rics" : [ {\r
+ "ric_id" : "ric_id",\r
+ "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ],\r
+ "state" : "UNAVAILABLE",\r
+ "policytype_ids" : [ "policytype_id", "policytype_id" ]\r
+ }, {\r
+ "ric_id" : "ric_id",\r
+ "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ],\r
+ "state" : "UNAVAILABLE",\r
+ "policytype_ids" : [ "policytype_ids", "policytype_ids" ]\r
+ } ]\r
+ }\r
+ }\r
+ }\r
+ }\r
}
\ No newline at end of file
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
required:
- ric_id
- policy_id
- - service_id
- policy_data
- policytype_id
type: object
<script>
// Script section to load models into a JS Var
var defs = {}
- defs["authorization_result"] = {
- "required" : [ "result" ],
- "type" : "object",
- "properties" : {
- "result" : {
- "type" : "boolean",
- "description" : "If true, the access is granted"
- }
- },
- "description" : "Result of authorization"
-};
- defs["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"
- },
- "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"
-};
- defs["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"
-};
- defs["Link"] = {
- "type" : "object",
- "properties" : {
- "templated" : {
- "type" : "boolean"
- },
- "href" : {
- "type" : "string"
- }
- }
-};
- defs["policy_authorization"] = {
- "required" : [ "input" ],
- "type" : "object",
- "properties" : {
- "input" : {
- "$ref" : "#/components/schemas/input"
- }
- },
- "description" : "Authorization request for A1 policy requests"
-};
- defs["policy_id_list_v2"] = {
- "type" : "object",
- "properties" : {
- "policy_ids" : {
- "type" : "array",
- "description" : "Policy identities",
- "items" : {
- "type" : "string",
- "description" : "Policy identities"
- }
- }
- },
- "description" : "A list of policy identities"
-};
- defs["policy_info_list_v2"] = {
- "type" : "object",
- "properties" : {
- "policies" : {
- "type" : "array",
- "description" : "List of policy information",
- "items" : {
- "$ref" : "#/components/schemas/policy_info_v2"
- }
- }
- },
- "description" : "List of policy information"
-};
- defs["policy_info_v2"] = {
- "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.",
- "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."
- },
- "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"
-};
- defs["policy_status_info_v2"] = {
- "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"
-};
- defs["policytype_id_list_v2"] = {
- "type" : "object",
- "properties" : {
- "policytype_ids" : {
- "type" : "array",
- "description" : "Policy type identities",
- "items" : {
- "type" : "string",
- "description" : "Policy type identities"
- }
- }
- },
- "description" : "Information about policy types"
-};
- defs["policytype_v2"] = {
- "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" : "Policy type"
-};
- defs["ric_info_list_v2"] = {
- "type" : "object",
- "properties" : {
- "rics" : {
- "type" : "array",
- "description" : "List of Near-RT RIC information",
- "items" : {
- "$ref" : "#/components/schemas/ric_info_v2"
- }
- }
- },
- "description" : "List of Near-RT RIC information"
-};
- defs["ric_info_v2"] = {
- "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"
-};
- defs["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)"
-};
- defs["service_list_v2"] = {
- "type" : "object",
- "properties" : {
- "service_list" : {
- "type" : "array",
- "description" : "List of service information",
- "items" : {
- "$ref" : "#/components/schemas/service_status_v2"
- }
- }
- },
- "description" : "List of service information"
-};
- defs["service_registration_info_v2"] = {
- "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"
-};
- defs["service_status_v2"] = {
- "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"
- }
- },
- "description" : "List of service information"
-};
- defs["status_info_v2"] = {
- "type" : "object",
- "properties" : {
- "status" : {
- "type" : "string",
- "description" : "status text"
- }
- }
+ defs["authorization_result"] = {\r
+ "required" : [ "result" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "result" : {\r
+ "type" : "boolean",\r
+ "description" : "If true, the access is granted"\r
+ }\r
+ },\r
+ "description" : "Result of authorization",\r
+ "example" : {\r
+ "result" : true\r
+ }\r
+};
+ defs["error_information"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "detail" : {\r
+ "type" : "string",\r
+ "description" : " A human-readable explanation specific to this occurrence of the problem.",\r
+ "example" : "Policy type not found"\r
+ },\r
+ "title" : {\r
+ "type" : "string",\r
+ "description" : "A specific error name",\r
+ "example" : "Not Found"\r
+ },\r
+ "status" : {\r
+ "type" : "integer",\r
+ "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ",\r
+ "format" : "int32",\r
+ "example" : 404\r
+ }\r
+ },\r
+ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807"\r
+};
+ defs["input"] = {\r
+ "required" : [ "access_type", "auth_token", "policy_type_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "access_type" : {\r
+ "type" : "string",\r
+ "description" : "Access type",\r
+ "enum" : [ "READ", "WRITE", "DELETE" ]\r
+ },\r
+ "auth_token" : {\r
+ "type" : "string",\r
+ "description" : "Authorization token"\r
+ },\r
+ "policy_type_id" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identifier"\r
+ }\r
+ },\r
+ "description" : "input"\r
+};
+ defs["Link"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "templated" : {\r
+ "type" : "boolean"\r
+ },\r
+ "href" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+};
+ defs["policy_authorization"] = {\r
+ "required" : [ "input" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "input" : {\r
+ "$ref" : "#/components/schemas/input"\r
+ }\r
+ },\r
+ "description" : "Authorization request for A1 policy requests"\r
+};
+ defs["policy_id_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "A list of policy identities",\r
+ "example" : {\r
+ "policy_ids" : [ "policy_ids", "policy_ids" ]\r
+ }\r
+};
+ defs["policy_info"] = {\r
+ "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the target Near-RT RIC"\r
+ },\r
+ "policy_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy"\r
+ },\r
+ "transient" : {\r
+ "type" : "boolean",\r
+ "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",\r
+ "nullable" : false,\r
+ "example" : false,\r
+ "default" : false\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "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.",\r
+ "default" : ""\r
+ },\r
+ "policy_data" : {\r
+ "type" : "object",\r
+ "description" : "the configuration of the policy"\r
+ },\r
+ "status_notification_uri" : {\r
+ "type" : "string",\r
+ "description" : "Callback URI for policy status updates"\r
+ },\r
+ "policytype_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy type"\r
+ }\r
+ },\r
+ "description" : "Information for one A1-P Policy"\r
+};
+ defs["policy_info_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policies" : {\r
+ "type" : "array",\r
+ "description" : "List of policy information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of policy information"\r
+};
+ defs["policy_status_info"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "last_modified" : {\r
+ "type" : "string",\r
+ "description" : "timestamp, last modification time"\r
+ },\r
+ "status" : {\r
+ "type" : "object",\r
+ "description" : "the Policy status"\r
+ }\r
+ },\r
+ "description" : "Status for one A1-P Policy"\r
+};
+ defs["policy_type_definition"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_schema" : {\r
+ "type" : "object",\r
+ "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema"\r
+ }\r
+ },\r
+ "description" : "Contains policy type schema definition"\r
+};
+ defs["policy_type_id_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy type identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information about policy types"\r
+};
+ defs["ric_info"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the Near-RT RIC"\r
+ },\r
+ "managed_element_ids" : {\r
+ "type" : "array",\r
+ "description" : "O1 identities for managed entities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "O1 identities for managed entities"\r
+ }\r
+ },\r
+ "state" : {\r
+ "type" : "string",\r
+ "description" : "Represents the states for a Near-RT RIC",\r
+ "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ]\r
+ },\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "supported policy types",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "supported policy types"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information for a Near-RT RIC"\r
+};
+ defs["ric_info_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "rics" : {\r
+ "type" : "array",\r
+ "description" : "List of Near-RT RIC information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/ric_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of Near-RT RIC information"\r
+};
+ defs["service_callback_info_v2"] = {\r
+ "required" : [ "event_type", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of a Near-RT RIC"\r
+ },\r
+ "event_type" : {\r
+ "type" : "string",\r
+ "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",\r
+ "enum" : [ "AVAILABLE" ]\r
+ }\r
+ },\r
+ "description" : "Information transferred as in Service callbacks (callback_url)"\r
+};
+ defs["service_registration_info"] = {\r
+ "required" : [ "service_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of Near-RT RIC state changes"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "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.",\r
+ "format" : "int64"\r
+ }\r
+ },\r
+ "description" : "Information for one service"\r
+};
+ defs["service_status"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of RIC synchronization"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "policy keep alive timeout",\r
+ "format" : "int64"\r
+ },\r
+ "time_since_last_activity_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "time since last invocation by the service",\r
+ "format" : "int64"\r
+ }\r
+ }\r
+};
+ defs["service_status_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "service_list" : {\r
+ "type" : "array",\r
+ "description" : "List of service information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/service_status"\r
+ }\r
+ }\r
+ }\r
+};
+ defs["status_info"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "status" : {\r
+ "type" : "string",\r
+ "description" : "status text"\r
+ }\r
+ }\r
};
var errs = {};
<li data-group="A1PolicyManagement" data-name="getPolicyStatus" class="">
<a href="#api-A1PolicyManagement-getPolicyStatus">getPolicyStatus</a>
</li>
- <li data-group="A1PolicyManagement" data-name="getPolicyType" class="">
- <a href="#api-A1PolicyManagement-getPolicyType">getPolicyType</a>
+ <li data-group="A1PolicyManagement" data-name="getPolicyTypeDefinition" class="">
+ <a href="#api-A1PolicyManagement-getPolicyTypeDefinition">getPolicyTypeDefinition</a>
</li>
<li data-group="A1PolicyManagement" data-name="getPolicyTypes" class="">
<a href="#api-A1PolicyManagement-getPolicyTypes">getPolicyTypes</a>
<li data-group="AuthorizationAPI" data-name="performAccessControl" class="">
<a href="#api-AuthorizationAPI-performAccessControl">performAccessControl</a>
</li>
+ <li class="nav-header" data-group="Configuration"><a href="#api-Configuration">API Methods - Configuration</a></li>
+ <li data-group="Configuration" data-name="getConfiguration" class="">
+ <a href="#api-Configuration-getConfiguration">getConfiguration</a>
+ </li>
+ <li data-group="Configuration" data-name="putConfiguration" class="">
+ <a href="#api-Configuration-putConfiguration">putConfiguration</a>
+ </li>
<li class="nav-header" data-group="HealthCheck"><a href="#api-HealthCheck">API Methods - HealthCheck</a></li>
<li data-group="HealthCheck" data-name="getStatus" class="">
<a href="#api-HealthCheck-getStatus">getStatus</a>
<li data-group="HealthCheck" data-name="getStatusV1" class="">
<a href="#api-HealthCheck-getStatusV1">getStatusV1</a>
</li>
- <li class="nav-header" data-group="ManagementOfConfiguration"><a href="#api-ManagementOfConfiguration">API Methods - ManagementOfConfiguration</a></li>
- <li data-group="ManagementOfConfiguration" data-name="getConfiguration" class="">
- <a href="#api-ManagementOfConfiguration-getConfiguration">getConfiguration</a>
- </li>
- <li data-group="ManagementOfConfiguration" data-name="putConfiguration" class="">
- <a href="#api-ManagementOfConfiguration-putConfiguration">putConfiguration</a>
- </li>
<li class="nav-header" data-group="NearRTRICRepository"><a href="#api-NearRTRICRepository">API Methods - NearRTRICRepository</a></li>
<li data-group="NearRTRICRepository" data-name="getRic" class="">
<a href="#api-NearRTRICRepository-getRic">getRic</a>
<li data-group="NearRTRICRepository" data-name="getRics" class="">
<a href="#api-NearRTRICRepository-getRics">getRics</a>
</li>
- <li class="nav-header" data-group="ServiceCallbacks"><a href="#api-ServiceCallbacks">API Methods - ServiceCallbacks</a></li>
- <li data-group="ServiceCallbacks" data-name="serviceCallback" class="">
- <a href="#api-ServiceCallbacks-serviceCallback">serviceCallback</a>
- </li>
<li class="nav-header" data-group="ServiceRegistryAndSupervision"><a href="#api-ServiceRegistryAndSupervision">API Methods - ServiceRegistryAndSupervision</a></li>
<li data-group="ServiceRegistryAndSupervision" data-name="deleteService" class="">
<a href="#api-ServiceRegistryAndSupervision-deleteService">deleteService</a>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
- <div class="app-desc">Version: 1.2.0</div>
+ <div class="app-desc">Version: 1.3.0</div>
<hr>
<div id="app-description" class="app-desc">
- <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>
+ <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for manageme
cnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>
</div>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Deleting the policy using the Policy's Policy ID.</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/a1-policy/v2/policies/{policy_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-deletePolicy-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
"http://localhost/a1-policy/v2/policies/{policy_id}"
</code></pre>
</div>
<h3 id="examples-A1PolicyManagement-deletePolicy-title-200"></h3>
<p id="examples-A1PolicyManagement-deletePolicy-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Not used`;
+ var responseA1PolicyManagement200_description = `OK - Policy deleted`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-deletePolicy-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-deletePolicy-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Not used",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-deletePolicy-title-423"></h3>
<p id="examples-A1PolicyManagement-deletePolicy-description-423" class="marked"></p>
<script>
- var responseA1PolicyManagement423_description = `Near-RT RIC is not operational`;
+ var responseA1PolicyManagement423_description = `Locked - HTTP Status code which can be used when the state is Locked`;
var responseA1PolicyManagement423_description_break = responseA1PolicyManagement423_description.indexOf('\n');
if (responseA1PolicyManagement423_description_break == -1) {
$("#examples-A1PolicyManagement-deletePolicy-title-423").text("Status: 423 - " + responseA1PolicyManagement423_description);
<div id="responses-A1PolicyManagement-deletePolicy-schema-423" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC is not operational",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<input id='responses-A1PolicyManagement-deletePolicy-423-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-A1PolicyManagement-deletePolicy-title-204"></h3>
- <p id="examples-A1PolicyManagement-deletePolicy-description-204" class="marked"></p>
- <script>
- var responseA1PolicyManagement204_description = `Policy deleted`;
- var responseA1PolicyManagement204_description_break = responseA1PolicyManagement204_description.indexOf('\n');
- if (responseA1PolicyManagement204_description_break == -1) {
- $("#examples-A1PolicyManagement-deletePolicy-title-204").text("Status: 204 - " + responseA1PolicyManagement204_description);
- } else {
- $("#examples-A1PolicyManagement-deletePolicy-title-204").text("Status: 204 - " + responseA1PolicyManagement204_description.substring(0, responseA1PolicyManagement204_description_break));
- $("#examples-A1PolicyManagement-deletePolicy-description-204").html(responseA1PolicyManagement204_description.substring(responseA1PolicyManagement204_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-A1PolicyManagement-deletePolicy-204" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-deletePolicy-204-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-A1PolicyManagement-deletePolicy-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-deletePolicy-204-schema">
- <div id="responses-A1PolicyManagement-deletePolicy-schema-204" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy deleted",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-deletePolicy-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-deletePolicy-schema-204');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-deletePolicy-204-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-A1PolicyManagement-deletePolicy-title-404"></h3>
- <p id="examples-A1PolicyManagement-deletePolicy-description-404" class="marked"></p>
- <script>
- var responseA1PolicyManagement404_description = `Policy is not found`;
- var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
- if (responseA1PolicyManagement404_description_break == -1) {
- $("#examples-A1PolicyManagement-deletePolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
- } else {
- $("#examples-A1PolicyManagement-deletePolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description.substring(0, responseA1PolicyManagement404_description_break));
- $("#examples-A1PolicyManagement-deletePolicy-description-404").html(responseA1PolicyManagement404_description.substring(responseA1PolicyManagement404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-A1PolicyManagement-deletePolicy-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-deletePolicy-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-A1PolicyManagement-deletePolicy-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-deletePolicy-404-schema">
- <div id="responses-A1PolicyManagement-deletePolicy-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy is not found",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-deletePolicy-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-deletePolicy-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-deletePolicy-404-schema-data' type='hidden' value=''></input>
- </div>
- </div>
</article>
</div>
<hr>
<article id="api-A1PolicyManagement-getPolicy-0" data-group="User" data-name="getPolicy" data-version="0">
<div class="pull-left">
<h1>getPolicy</h1>
- <p>Returns a policy</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns a policy</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policies/{policy_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicy-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/policies/{policy_id}"
</code></pre>
</div>
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");
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");
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);
}
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 );
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:
<h3 id="examples-A1PolicyManagement-getPolicy-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicy-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy found`;
+ var responseA1PolicyManagement200_description = `OK - Policy found`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicy-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-getPolicy-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-getPolicy-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicy-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Policy is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicy-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicy-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicy-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicy-404-schema">
- <div id="responses-A1PolicyManagement-getPolicy-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicy-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicy-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicy-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyIds-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format <typename_version>)
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");
String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format <typename_version>)
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");
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);
}
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 );
<h3 id="examples-A1PolicyManagement-getPolicyIds-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyIds-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy identities`;
+ var responseA1PolicyManagement200_description = `OK - Policy identities`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyIds-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-getPolicyIds-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy identities",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_id_list_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-getPolicyIds-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyIds-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Near-RT RIC or type not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyIds-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyIds-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyIds-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyIds-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyIds-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyIds-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC or type not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyIds-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyIds-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyIds-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
String typeName = typeName_example; // String | Select policies of a given type name (type identity has the format <typename_version>)
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");
String typeName = typeName_example; // String | Select policies of a given type name (type identity has the format <typename_version>)
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");
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);
}
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 );
<h3 id="examples-A1PolicyManagement-getPolicyInstances-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyInstances-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policies`;
+ var responseA1PolicyManagement200_description = `OK - Returns A1 Policies which matches the criteria`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyInstances-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-getPolicyInstances-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policies",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info_list_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-getPolicyInstances-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyInstances-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Near-RT RIC, policy type or service not found`;
+ var responseA1PolicyManagement404_description = `Not Found - Near-RT RIC, policy type or service not found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyInstances-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<div id="responses-A1PolicyManagement-getPolicyInstances-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC, policy type or service not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<article id="api-A1PolicyManagement-getPolicyStatus-0" data-group="User" data-name="getPolicyStatus" data-version="0">
<div class="pull-left">
<h1>getPolicyStatus</h1>
- <p>Returns a policy status</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns a policy status</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policies/{policy_id}/status</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyStatus-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/policies/{policy_id}/status"
</code></pre>
</div>
String policyId = policyId_example; // String |
try {
- policy_status_info_v2 result = apiInstance.getPolicyStatus(policyId);
+ policy_status_info result = apiInstance.getPolicyStatus(policyId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling A1PolicyManagementApi#getPolicyStatus");
String policyId = policyId_example; // String |
try {
- policy_status_info_v2 result = apiInstance.getPolicyStatus(policyId);
+ policy_status_info result = apiInstance.getPolicyStatus(policyId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling A1PolicyManagementApi#getPolicyStatus");
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; // (default to null)
-// Returns a policy status
[apiInstance getPolicyStatusWith:policyId
- completionHandler: ^(policy_status_info_v2 output, NSError* error) {
+ completionHandler: ^(policy_status_info output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
var policyId = policyId_example; // String | (default to null)
try {
- // Returns a policy status
- policy_status_info_v2 result = apiInstance.getPolicyStatus(policyId);
+ policy_status_info result = apiInstance.getPolicyStatus(policyId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyStatus: " + e.Message );
policyId = policyId_example # String | (default to null)
try:
- # Returns a policy status
api_response = api_instance.get_policy_status(policyId)
pprint(api_response)
except ApiException as e:
<h3 id="examples-A1PolicyManagement-getPolicyStatus-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyStatus-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy status`;
+ var responseA1PolicyManagement200_description = `OK - Policy status`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyStatus-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-getPolicyStatus-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy status",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_status_info_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-getPolicyStatus-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyStatus-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Policy is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyStatus-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyStatus-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyStatus-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyStatus-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyStatus-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyStatus-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyStatus-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyStatus-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyStatus-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<hr>
- <div id="api-A1PolicyManagement-getPolicyType">
- <article id="api-A1PolicyManagement-getPolicyType-0" data-group="User" data-name="getPolicyType" data-version="0">
+ <div id="api-A1PolicyManagement-getPolicyTypeDefinition">
+ <article id="api-A1PolicyManagement-getPolicyTypeDefinition-0" data-group="User" data-name="getPolicyTypeDefinition" data-version="0">
<div class="pull-left">
- <h1>getPolicyType</h1>
- <p>Returns a policy type definition</p>
+ <h1>getPolicyTypeDefinition</h1>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns a policy type definition</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policy-types/{policytype_id}</span></code></pre>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-A1PolicyManagement-getPolicyType-0-curl">Curl</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-java">Java</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-csharp">C#</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-php">PHP</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-perl">Perl</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-python">Python</a></li>
- <li class=""><a href="#examples-A1PolicyManagement-getPolicyType-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-java">Java</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-php">PHP</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-python">Python</a></li>
+ <li class=""><a href="#examples-A1PolicyManagement-getPolicyTypeDefinition-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyType-0-curl">
+ <div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: */*" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/policy-types/{policytype_id}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-java">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-android">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.A1PolicyManagementApi;
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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-groovy">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-objc">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-javascript">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-javascript">
<pre class="prettyprint"><code class="language-js">var A1PolicyManagementService = require('a1_policy_management_service');
// Create an instance of the API class
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getPolicyType(policytypeId, callback);
+api.getPolicyTypeDefinition(policytypeId, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-angular">
+ <!--<div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-csharp">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getPolicyTypeExample
+ public class getPolicyTypeDefinitionExample
{
public void main()
{
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-php">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
$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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-perl">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;
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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-python">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyType-0-rust">
+ <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-rust">
<pre class="prettyprint"><code class="language-rust">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);
}
<td>
- <div id="d2e199_getPolicyType_policytypeId">
+ <div id="d2e199_getPolicyTypeDefinition_policytypeId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<h2>Responses</h2>
- <h3 id="examples-A1PolicyManagement-getPolicyType-title-200"></h3>
- <p id="examples-A1PolicyManagement-getPolicyType-description-200" class="marked"></p>
+ <h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-200"></h3>
+ <p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy type`;
+ var responseA1PolicyManagement200_description = `OK - schema of the given policy type`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
- $("#examples-A1PolicyManagement-getPolicyType-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
+ $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
} else {
- $("#examples-A1PolicyManagement-getPolicyType-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description.substring(0, responseA1PolicyManagement200_description_break));
- $("#examples-A1PolicyManagement-getPolicyType-description-200").html(responseA1PolicyManagement200_description.substring(responseA1PolicyManagement200_description_break));
+ $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description.substring(0, responseA1PolicyManagement200_description_break));
+ $("#examples-A1PolicyManagement-getPolicyTypeDefinition-description-200").html(responseA1PolicyManagement200_description.substring(responseA1PolicyManagement200_description_break));
}
</script>
- <ul id="responses-detail-A1PolicyManagement-getPolicyType-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-A1PolicyManagement-getPolicyTypeDefinition-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyType-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyTypeDefinition-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-A1PolicyManagement-getPolicyType-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyType-200-schema">
- <div id="responses-A1PolicyManagement-getPolicyType-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-A1PolicyManagement-getPolicyTypeDefinition-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyTypeDefinition-200-schema">
+ <div id="responses-A1PolicyManagement-getPolicyTypeDefinition-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy type",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/policytype_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyType-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyType-schema-200');
+ $('#responses-A1PolicyManagement-getPolicyTypeDefinition-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-A1PolicyManagement-getPolicyTypeDefinition-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-A1PolicyManagement-getPolicyType-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-A1PolicyManagement-getPolicyTypeDefinition-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-A1PolicyManagement-getPolicyType-title-404"></h3>
- <p id="examples-A1PolicyManagement-getPolicyType-description-404" class="marked"></p>
+ <h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-404"></h3>
+ <p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Policy type is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
- $("#examples-A1PolicyManagement-getPolicyType-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
+ $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
} else {
- $("#examples-A1PolicyManagement-getPolicyType-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description.substring(0, responseA1PolicyManagement404_description_break));
- $("#examples-A1PolicyManagement-getPolicyType-description-404").html(responseA1PolicyManagement404_description.substring(responseA1PolicyManagement404_description_break));
+ $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description.substring(0, responseA1PolicyManagement404_description_break));
+ $("#examples-A1PolicyManagement-getPolicyTypeDefinition-description-404").html(responseA1PolicyManagement404_description.substring(responseA1PolicyManagement404_description_break));
}
</script>
- <ul id="responses-detail-A1PolicyManagement-getPolicyType-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyType-404-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-A1PolicyManagement-getPolicyTypeDefinition-404" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-A1PolicyManagement-getPolicyType-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyType-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyType-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy type is not found",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyType-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyType-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyType-404-schema-data' type='hidden' value=''></input>
- </div>
+ <div class="tab-content" id="responses-A1PolicyManagement-getPolicyTypeDefinition-404-wrapper" style='margin-bottom: 10px;'>
</div>
</article>
</div>
<article id="api-A1PolicyManagement-getPolicyTypes-0" data-group="User" data-name="getPolicyTypes" data-version="0">
<div class="pull-left">
<h1>getPolicyTypes</h1>
- <p>Query policy type identities</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Query policy type identities</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policy-types</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyTypes-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
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");
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");
String *typeName = typeName_example; // Select types with the given type name (type identity has the format <typename_version>) (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);
}
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 );
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:
<h3 id="examples-A1PolicyManagement-getPolicyTypes-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyTypes-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy type IDs`;
+ var responseA1PolicyManagement200_description = `OK - Policy Type IDs Found`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyTypes-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-getPolicyTypes-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy type IDs",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policytype_id_list_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-getPolicyTypes-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyTypes-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Near-RT RIC is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyTypes-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyTypes-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyTypes-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyTypes-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyTypes-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyTypes-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyTypes-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyTypes-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyTypes-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<article id="api-A1PolicyManagement-putPolicy-0" data-group="User" data-name="putPolicy" data-version="0">
<div class="pull-left">
<h1>putPolicy</h1>
- <p>Create or update a policy</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Create or update a policy</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/policies</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-putPolicy-0-curl">
<pre class="prettyprint"><code class="language-bsh">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 ''
// 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");
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");
// 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);
// 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) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.putPolicy(policyInfoV2, callback);
+api.putPolicy(policyInfo, callback);
</code></pre>
</div>
// 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 );
// 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;
# 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 ($@) {
# 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)</code></pre>
<pre class="prettyprint"><code class="language-rust">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);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">policyInfoV2 <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">policyInfo <span style="color:red;">*</span></td>
<td>
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info_v2"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_putPolicy_policyInfoV2');
+ var result = $('#d2e199_putPolicy_policyInfo');
result.empty();
result.append(view.render());
});
</script>
-<div id="d2e199_putPolicy_policyInfoV2"></div>
+<div id="d2e199_putPolicy_policyInfo"></div>
</td>
</tr>
<h3 id="examples-A1PolicyManagement-putPolicy-title-200"></h3>
<p id="examples-A1PolicyManagement-putPolicy-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy updated`;
+ var responseA1PolicyManagement200_description = `OK - Policy updated`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-putPolicy-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<div id="responses-A1PolicyManagement-putPolicy-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy updated",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-putPolicy-title-201"></h3>
<p id="examples-A1PolicyManagement-putPolicy-description-201" class="marked"></p>
<script>
- var responseA1PolicyManagement201_description = `Policy created`;
+ var responseA1PolicyManagement201_description = `Created - Policy created`;
var responseA1PolicyManagement201_description_break = responseA1PolicyManagement201_description.indexOf('\n');
if (responseA1PolicyManagement201_description_break == -1) {
$("#examples-A1PolicyManagement-putPolicy-title-201").text("Status: 201 - " + responseA1PolicyManagement201_description);
<div id="responses-A1PolicyManagement-putPolicy-schema-201" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy created",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-A1PolicyManagement-putPolicy-title-423"></h3>
<p id="examples-A1PolicyManagement-putPolicy-description-423" class="marked"></p>
<script>
- var responseA1PolicyManagement423_description = `Near-RT RIC is not operational`;
+ var responseA1PolicyManagement423_description = `Locked - HTTP Status code which can be used when the state is Locked`;
var responseA1PolicyManagement423_description_break = responseA1PolicyManagement423_description.indexOf('\n');
if (responseA1PolicyManagement423_description_break == -1) {
$("#examples-A1PolicyManagement-putPolicy-title-423").text("Status: 423 - " + responseA1PolicyManagement423_description);
<div id="responses-A1PolicyManagement-putPolicy-schema-423" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC is not operational",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<input id='responses-A1PolicyManagement-putPolicy-423-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-A1PolicyManagement-putPolicy-title-404"></h3>
- <p id="examples-A1PolicyManagement-putPolicy-description-404" class="marked"></p>
- <script>
- var responseA1PolicyManagement404_description = `Near-RT RIC or policy type is not found`;
- var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
- if (responseA1PolicyManagement404_description_break == -1) {
- $("#examples-A1PolicyManagement-putPolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
- } else {
- $("#examples-A1PolicyManagement-putPolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description.substring(0, responseA1PolicyManagement404_description_break));
- $("#examples-A1PolicyManagement-putPolicy-description-404").html(responseA1PolicyManagement404_description.substring(responseA1PolicyManagement404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-A1PolicyManagement-putPolicy-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-putPolicy-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-A1PolicyManagement-putPolicy-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-putPolicy-404-schema">
- <div id="responses-A1PolicyManagement-putPolicy-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC or policy type is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-putPolicy-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-putPolicy-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-putPolicy-404-schema-data' type='hidden' value=''></input>
- </div>
- </div>
</article>
</div>
<hr>
<div id="responses-Actuator-health-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-healthPath-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-heapdump-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/octet-stream" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-info-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-links-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-logfile-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "text/plain;charset=UTF-8" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-loggers-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-loggersName-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string",
- "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]
- }
- }
- }
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "string",\r
+ "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]\r
+ }\r
+ }\r
+ }\r
};
var schema = findNode('schema',schemaWrapper).schema;
<div id="responses-Actuator-loggersName2-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-metrics-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-metricsRequiredMetricName-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-shutdown-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="responses-Actuator-threaddump-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "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"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div class="tab-content">
<div class="tab-pane active" id="examples-AuthorizationAPI-performAccessControl-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
-H "Content-Type: application/json" \
"http://localhost/example-authz-check" \
-d ''
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_authorization"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_authorization"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
<div id="responses-AuthorizationAPI-performAccessControl-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/authorization_result"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<input id='responses-AuthorizationAPI-performAccessControl-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- </article>
- </div>
+ <h3 id="examples-AuthorizationAPI-performAccessControl-title-403"></h3>
+ <p id="examples-AuthorizationAPI-performAccessControl-description-403" class="marked"></p>
+ <script>
+ var responseAuthorizationAPI403_description = `Forbidden`;
+ var responseAuthorizationAPI403_description_break = responseAuthorizationAPI403_description.indexOf('\n');
+ if (responseAuthorizationAPI403_description_break == -1) {
+ $("#examples-AuthorizationAPI-performAccessControl-title-403").text("Status: 403 - " + responseAuthorizationAPI403_description);
+ } else {
+ $("#examples-AuthorizationAPI-performAccessControl-title-403").text("Status: 403 - " + responseAuthorizationAPI403_description.substring(0, responseAuthorizationAPI403_description_break));
+ $("#examples-AuthorizationAPI-performAccessControl-description-403").html(responseAuthorizationAPI403_description.substring(responseAuthorizationAPI403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-AuthorizationAPI-performAccessControl-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-AuthorizationAPI-performAccessControl-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-AuthorizationAPI-performAccessControl-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-AuthorizationAPI-performAccessControl-403-schema">
+ <div id="responses-AuthorizationAPI-performAccessControl-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = ;
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-AuthorizationAPI-performAccessControl-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-AuthorizationAPI-performAccessControl-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-AuthorizationAPI-performAccessControl-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ </article>
+ </div>
<hr>
</section>
- <section id="api-HealthCheck">
- <h1>HealthCheck</h1>
- <div id="api-HealthCheck-getStatus">
- <article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0">
+ <section id="api-Configuration">
+ <h1>Configuration</h1>
+ <div id="api-Configuration-getConfiguration">
+ <article id="api-Configuration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0">
<div class="pull-left">
- <h1>getStatus</h1>
- <p>Returns status and statistics of this service</p>
+ <h1>getConfiguration</h1>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns the contents of the application configuration file</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/status</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-HealthCheck-getStatus-0-curl">Curl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-java">Java</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatus-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatus-0-csharp">C#</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-php">PHP</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-perl">Perl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-python">Python</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatus-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Configuration-getConfiguration-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-java">Java</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Configuration-getConfiguration-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Configuration-getConfiguration-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-python">Python</a></li>
+ <li class=""><a href="#examples-Configuration-getConfiguration-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-HealthCheck-getStatus-0-curl">
+ <div class="tab-pane active" id="examples-Configuration-getConfiguration-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-java">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.HealthCheckApi;
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-groovy">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-objc">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-javascript">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-javascript">
<pre class="prettyprint"><code class="language-js">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);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getStatus(callback);
+api.getConfiguration(callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-HealthCheck-getStatus-0-angular">
+ <!--<div class="tab-pane" id="examples-Configuration-getConfiguration-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-csharp">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-php">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-perl">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-python">
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling ConfigurationApi->getConfiguration: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatus-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate HealthCheckApi;
+ <div class="tab-pane" id="examples-Configuration-getConfiguration-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<h2>Responses</h2>
- <h3 id="examples-HealthCheck-getStatus-title-200"></h3>
- <p id="examples-HealthCheck-getStatus-description-200" class="marked"></p>
+ <h3 id="examples-Configuration-getConfiguration-title-200"></h3>
+ <p id="examples-Configuration-getConfiguration-description-200" class="marked"></p>
<script>
- var responseHealthCheck200_description = `Service is living`;
- var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
- if (responseHealthCheck200_description_break == -1) {
- $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description);
+ var responseConfiguration200_description = `OK - Configuration`;
+ var responseConfiguration200_description_break = responseConfiguration200_description.indexOf('\n');
+ if (responseConfiguration200_description_break == -1) {
+ $("#examples-Configuration-getConfiguration-title-200").text("Status: 200 - " + responseConfiguration200_description);
} else {
- $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
- $("#examples-HealthCheck-getStatus-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
+ $("#examples-Configuration-getConfiguration-title-200").text("Status: 200 - " + responseConfiguration200_description.substring(0, responseConfiguration200_description_break));
+ $("#examples-Configuration-getConfiguration-description-200").html(responseConfiguration200_description.substring(responseConfiguration200_description_break));
}
</script>
- <ul id="responses-detail-HealthCheck-getStatus-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Configuration-getConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-HealthCheck-getStatus-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Configuration-getConfiguration-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-HealthCheck-getStatus-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-HealthCheck-getStatus-200-schema">
- <div id="responses-HealthCheck-getStatus-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Configuration-getConfiguration-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Configuration-getConfiguration-200-schema">
+ <div id="responses-Configuration-getConfiguration-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service is living",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/status_info_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-HealthCheck-getStatus-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-HealthCheck-getStatus-schema-200');
+ $('#responses-Configuration-getConfiguration-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Configuration-getConfiguration-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-HealthCheck-getStatus-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Configuration-getConfiguration-200-schema-data' type='hidden' value=''></input>
</div>
</div>
+ <h3 id="examples-Configuration-getConfiguration-title-404"></h3>
+ <p id="examples-Configuration-getConfiguration-description-404" class="marked"></p>
+ <script>
+ var responseConfiguration404_description = `Not Found`;
+ var responseConfiguration404_description_break = responseConfiguration404_description.indexOf('\n');
+ if (responseConfiguration404_description_break == -1) {
+ $("#examples-Configuration-getConfiguration-title-404").text("Status: 404 - " + responseConfiguration404_description);
+ } else {
+ $("#examples-Configuration-getConfiguration-title-404").text("Status: 404 - " + responseConfiguration404_description.substring(0, responseConfiguration404_description_break));
+ $("#examples-Configuration-getConfiguration-description-404").html(responseConfiguration404_description.substring(responseConfiguration404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Configuration-getConfiguration-404" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Configuration-getConfiguration-404-wrapper" style='margin-bottom: 10px;'>
+ </div>
</article>
</div>
<hr>
- <div id="api-HealthCheck-getStatusV1">
- <article id="api-HealthCheck-getStatusV1-0" data-group="User" data-name="getStatusV1" data-version="0">
+ <div id="api-Configuration-putConfiguration">
+ <article id="api-Configuration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0">
<div class="pull-left">
- <h1>getStatusV1</h1>
- <p>Returns status and statistics of this service</p>
+ <h1>putConfiguration</h1>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Replace the current configuration with the given configuration</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/status</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-HealthCheck-getStatusV1-0-curl">Curl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-java">Java</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-csharp">C#</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-php">PHP</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-perl">Perl</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-python">Python</a></li>
- <li class=""><a href="#examples-HealthCheck-getStatusV1-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Configuration-putConfiguration-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-java">Java</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Configuration-putConfiguration-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Configuration-putConfiguration-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-python">Python</a></li>
+ <li class=""><a href="#examples-Configuration-putConfiguration-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-HealthCheck-getStatusV1-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: */*" \
- "http://localhost/status"
+ <div class="tab-pane active" id="examples-Configuration-putConfiguration-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "http://localhost/a1-policy/v2/configuration" \
+ -d ''
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-java">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.HealthCheckApi;
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-groovy">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-objc">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-javascript">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-javascript">
<pre class="prettyprint"><code class="language-js">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);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getStatusV1(callback);
+api.putConfiguration(body, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-angular">
+ <!--<div class="tab-pane" id="examples-Configuration-putConfiguration-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-csharp">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-php">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-perl">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-python">
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling ConfigurationApi->putConfiguration: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate HealthCheckApi;
+ <div class="tab-pane" id="examples-Configuration-putConfiguration-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">body <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+};
-
-
- <h2>Responses</h2>
- <h3 id="examples-HealthCheck-getStatusV1-title-200"></h3>
- <p id="examples-HealthCheck-getStatusV1-description-200" class="marked"></p>
- <script>
- var responseHealthCheck200_description = `Service is living`;
- var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
- if (responseHealthCheck200_description_break == -1) {
- $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description);
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema,2,{isBodyParam: true});
+ var result = $('#d2e199_putConfiguration_body');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_putConfiguration_body"></div>
+</td>
+</tr>
+
+ </table>
+
+
+
+ <h2>Responses</h2>
+ <h3 id="examples-Configuration-putConfiguration-title-200"></h3>
+ <p id="examples-Configuration-putConfiguration-description-200" class="marked"></p>
+ <script>
+ var responseConfiguration200_description = `OK - Configuration updated`;
+ var responseConfiguration200_description_break = responseConfiguration200_description.indexOf('\n');
+ if (responseConfiguration200_description_break == -1) {
+ $("#examples-Configuration-putConfiguration-title-200").text("Status: 200 - " + responseConfiguration200_description);
} else {
- $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
- $("#examples-HealthCheck-getStatusV1-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
+ $("#examples-Configuration-putConfiguration-title-200").text("Status: 200 - " + responseConfiguration200_description.substring(0, responseConfiguration200_description_break));
+ $("#examples-Configuration-putConfiguration-description-200").html(responseConfiguration200_description.substring(responseConfiguration200_description_break));
}
</script>
- <ul id="responses-detail-HealthCheck-getStatusV1-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Configuration-putConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-HealthCheck-getStatusV1-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Configuration-putConfiguration-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-HealthCheck-getStatusV1-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-HealthCheck-getStatusV1-200-schema">
- <div id="responses-HealthCheck-getStatusV1-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Configuration-putConfiguration-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Configuration-putConfiguration-200-schema">
+ <div id="responses-Configuration-putConfiguration-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service is living",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "string"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-HealthCheck-getStatusV1-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-HealthCheck-getStatusV1-schema-200');
+ $('#responses-Configuration-putConfiguration-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Configuration-putConfiguration-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-HealthCheck-getStatusV1-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Configuration-putConfiguration-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Configuration-putConfiguration-title-400"></h3>
+ <p id="examples-Configuration-putConfiguration-description-400" class="marked"></p>
+ <script>
+ var responseConfiguration400_description = `Bad Request`;
+ var responseConfiguration400_description_break = responseConfiguration400_description.indexOf('\n');
+ if (responseConfiguration400_description_break == -1) {
+ $("#examples-Configuration-putConfiguration-title-400").text("Status: 400 - " + responseConfiguration400_description);
+ } else {
+ $("#examples-Configuration-putConfiguration-title-400").text("Status: 400 - " + responseConfiguration400_description.substring(0, responseConfiguration400_description_break));
+ $("#examples-Configuration-putConfiguration-description-400").html(responseConfiguration400_description.substring(responseConfiguration400_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-Configuration-putConfiguration-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Configuration-putConfiguration-400-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-Configuration-putConfiguration-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Configuration-putConfiguration-400-schema">
+ <div id="responses-Configuration-putConfiguration-schema-400" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = ;
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Configuration-putConfiguration-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Configuration-putConfiguration-schema-400');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Configuration-putConfiguration-400-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
</section>
- <section id="api-ManagementOfConfiguration">
- <h1>ManagementOfConfiguration</h1>
- <div id="api-ManagementOfConfiguration-getConfiguration">
- <article id="api-ManagementOfConfiguration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0">
+ <section id="api-HealthCheck">
+ <h1>HealthCheck</h1>
+ <div id="api-HealthCheck-getStatus">
+ <article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0">
<div class="pull-left">
- <h1>getConfiguration</h1>
- <p>Returns the contents of the application configuration file</p>
+ <h1>getStatus</h1>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns status and statistics of this service</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/status</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-ManagementOfConfiguration-getConfiguration-0-curl">Curl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-java">Java</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-csharp">C#</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-php">PHP</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-perl">Perl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-python">Python</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-getConfiguration-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-HealthCheck-getStatus-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-java">Java</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatus-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-php">PHP</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-python">Python</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatus-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-ManagementOfConfiguration-getConfiguration-0-curl">
+ <div class="tab-pane active" id="examples-HealthCheck-getStatus-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json" \
- "http://localhost/a1-policy/v2/configuration"
+ "http://localhost/a1-policy/v2/status"
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-java">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ManagementOfConfigurationApi;
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-groovy">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-objc">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-javascript">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-javascript">
<pre class="prettyprint"><code class="language-js">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);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getConfiguration(callback);
+api.getStatus(callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-angular">
+ <!--<div class="tab-pane" id="examples-HealthCheck-getStatus-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-csharp">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-php">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-perl">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-python">
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-getConfiguration-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate ManagementOfConfigurationApi;
+ <div class="tab-pane" id="examples-HealthCheck-getStatus-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<h2>Responses</h2>
- <h3 id="examples-ManagementOfConfiguration-getConfiguration-title-200"></h3>
- <p id="examples-ManagementOfConfiguration-getConfiguration-description-200" class="marked"></p>
+ <h3 id="examples-HealthCheck-getStatus-title-200"></h3>
+ <p id="examples-HealthCheck-getStatus-description-200" class="marked"></p>
<script>
- var responseManagementOfConfiguration200_description = `Configuration`;
- var responseManagementOfConfiguration200_description_break = responseManagementOfConfiguration200_description.indexOf('\n');
- if (responseManagementOfConfiguration200_description_break == -1) {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description);
+ var responseHealthCheck200_description = `OK- Service is living Ok`;
+ var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
+ if (responseHealthCheck200_description_break == -1) {
+ $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description);
} else {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description.substring(0, responseManagementOfConfiguration200_description_break));
- $("#examples-ManagementOfConfiguration-getConfiguration-description-200").html(responseManagementOfConfiguration200_description.substring(responseManagementOfConfiguration200_description_break));
+ $("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
+ $("#examples-HealthCheck-getStatus-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
}
</script>
- <ul id="responses-detail-ManagementOfConfiguration-getConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-HealthCheck-getStatus-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-getConfiguration-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-HealthCheck-getStatus-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ManagementOfConfiguration-getConfiguration-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-getConfiguration-200-schema">
- <div id="responses-ManagementOfConfiguration-getConfiguration-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-HealthCheck-getStatus-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-HealthCheck-getStatus-200-schema">
+ <div id="responses-HealthCheck-getStatus-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Configuration",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
});
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-getConfiguration-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-getConfiguration-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ManagementOfConfiguration-getConfiguration-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-ManagementOfConfiguration-getConfiguration-title-404"></h3>
- <p id="examples-ManagementOfConfiguration-getConfiguration-description-404" class="marked"></p>
- <script>
- var responseManagementOfConfiguration404_description = `File is not found or readable`;
- var responseManagementOfConfiguration404_description_break = responseManagementOfConfiguration404_description.indexOf('\n');
- if (responseManagementOfConfiguration404_description_break == -1) {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-404").text("Status: 404 - " + responseManagementOfConfiguration404_description);
- } else {
- $("#examples-ManagementOfConfiguration-getConfiguration-title-404").text("Status: 404 - " + responseManagementOfConfiguration404_description.substring(0, responseManagementOfConfiguration404_description_break));
- $("#examples-ManagementOfConfiguration-getConfiguration-description-404").html(responseManagementOfConfiguration404_description.substring(responseManagementOfConfiguration404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-ManagementOfConfiguration-getConfiguration-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-getConfiguration-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-ManagementOfConfiguration-getConfiguration-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-getConfiguration-404-schema">
- <div id="responses-ManagementOfConfiguration-getConfiguration-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "File is not found or readable",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-getConfiguration-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-getConfiguration-schema-404');
+ $('#responses-HealthCheck-getStatus-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-HealthCheck-getStatus-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ManagementOfConfiguration-getConfiguration-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-HealthCheck-getStatus-200-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-ManagementOfConfiguration-putConfiguration">
- <article id="api-ManagementOfConfiguration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0">
+ <div id="api-HealthCheck-getStatusV1">
+ <article id="api-HealthCheck-getStatusV1-0" data-group="User" data-name="getStatusV1" data-version="0">
<div class="pull-left">
- <h1>putConfiguration</h1>
- <p>Replace the current configuration file with the given configuration</p>
+ <h1>getStatusV1</h1>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns status and statistics of this service</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/status</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-ManagementOfConfiguration-putConfiguration-0-curl">Curl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-java">Java</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-csharp">C#</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-php">PHP</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-perl">Perl</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-python">Python</a></li>
- <li class=""><a href="#examples-ManagementOfConfiguration-putConfiguration-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-HealthCheck-getStatusV1-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-java">Java</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-HealthCheck-getStatusV1-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-php">PHP</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-python">Python</a></li>
+ <li class=""><a href="#examples-HealthCheck-getStatusV1-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-ManagementOfConfiguration-putConfiguration-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
+ <div class="tab-pane active" id="examples-HealthCheck-getStatusV1-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: */*" \
- -H "Content-Type: application/json" \
- "http://localhost/a1-policy/v2/configuration" \
- -d ''
+ "http://localhost/status"
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-java">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ManagementOfConfigurationApi;
-
-public class ManagementOfConfigurationApiExample {
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-groovy">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-objc">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-javascript">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-javascript">
<pre class="prettyprint"><code class="language-js">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);
console.log('API called successfully. Returned data: ' + data);
}
};
-api.putConfiguration(body, callback);
+api.getStatusV1(callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-angular">
+ <!--<div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-csharp">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-php">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-perl">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-python">
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling HealthCheckApi->getStatusV1: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-ManagementOfConfiguration-putConfiguration-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate ManagementOfConfigurationApi;
+ <div class="tab-pane" id="examples-HealthCheck-getStatusV1-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
- <div class="methodsubtabletitle">Body parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">body <span style="color:red;">*</span></td>
-<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object"
- }
- }
- },
- "required" : true
-};
-
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_putConfiguration_body');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_putConfiguration_body"></div>
-</td>
-</tr>
-
- </table>
<h2>Responses</h2>
- <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-200"></h3>
- <p id="examples-ManagementOfConfiguration-putConfiguration-description-200" class="marked"></p>
- <script>
- var responseManagementOfConfiguration200_description = `Configuration updated`;
- var responseManagementOfConfiguration200_description_break = responseManagementOfConfiguration200_description.indexOf('\n');
- if (responseManagementOfConfiguration200_description_break == -1) {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description);
- } else {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-200").text("Status: 200 - " + responseManagementOfConfiguration200_description.substring(0, responseManagementOfConfiguration200_description_break));
- $("#examples-ManagementOfConfiguration-putConfiguration-description-200").html(responseManagementOfConfiguration200_description.substring(responseManagementOfConfiguration200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-200-schema">
- <div id="responses-ManagementOfConfiguration-putConfiguration-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Configuration updated",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-putConfiguration-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ManagementOfConfiguration-putConfiguration-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-400"></h3>
- <p id="examples-ManagementOfConfiguration-putConfiguration-description-400" class="marked"></p>
+ <h3 id="examples-HealthCheck-getStatusV1-title-200"></h3>
+ <p id="examples-HealthCheck-getStatusV1-description-200" class="marked"></p>
<script>
- var responseManagementOfConfiguration400_description = `Invalid configuration provided`;
- var responseManagementOfConfiguration400_description_break = responseManagementOfConfiguration400_description.indexOf('\n');
- if (responseManagementOfConfiguration400_description_break == -1) {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-400").text("Status: 400 - " + responseManagementOfConfiguration400_description);
+ var responseHealthCheck200_description = `OK - Service is living`;
+ var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
+ if (responseHealthCheck200_description_break == -1) {
+ $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description);
} else {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-400").text("Status: 400 - " + responseManagementOfConfiguration400_description.substring(0, responseManagementOfConfiguration400_description_break));
- $("#examples-ManagementOfConfiguration-putConfiguration-description-400").html(responseManagementOfConfiguration400_description.substring(responseManagementOfConfiguration400_description_break));
+ $("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description.substring(0, responseHealthCheck200_description_break));
+ $("#examples-HealthCheck-getStatusV1-description-200").html(responseHealthCheck200_description.substring(responseHealthCheck200_description_break));
}
</script>
- <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-HealthCheck-getStatusV1-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-HealthCheck-getStatusV1-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-400-schema">
- <div id="responses-ManagementOfConfiguration-putConfiguration-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-HealthCheck-getStatusV1-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-HealthCheck-getStatusV1-200-schema">
+ <div id="responses-HealthCheck-getStatusV1-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Invalid configuration provided",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
});
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-putConfiguration-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ManagementOfConfiguration-putConfiguration-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-ManagementOfConfiguration-putConfiguration-title-500"></h3>
- <p id="examples-ManagementOfConfiguration-putConfiguration-description-500" class="marked"></p>
- <script>
- var responseManagementOfConfiguration500_description = `Something went wrong when replacing the configuration. Try again.`;
- var responseManagementOfConfiguration500_description_break = responseManagementOfConfiguration500_description.indexOf('\n');
- if (responseManagementOfConfiguration500_description_break == -1) {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-500").text("Status: 500 - " + responseManagementOfConfiguration500_description);
- } else {
- $("#examples-ManagementOfConfiguration-putConfiguration-title-500").text("Status: 500 - " + responseManagementOfConfiguration500_description.substring(0, responseManagementOfConfiguration500_description_break));
- $("#examples-ManagementOfConfiguration-putConfiguration-description-500").html(responseManagementOfConfiguration500_description.substring(responseManagementOfConfiguration500_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-ManagementOfConfiguration-putConfiguration-500" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ManagementOfConfiguration-putConfiguration-500-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-ManagementOfConfiguration-putConfiguration-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ManagementOfConfiguration-putConfiguration-500-schema">
- <div id="responses-ManagementOfConfiguration-putConfiguration-schema-500" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Something went wrong when replacing the configuration. Try again.",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ManagementOfConfiguration-putConfiguration-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ManagementOfConfiguration-putConfiguration-schema-500');
+ $('#responses-HealthCheck-getStatusV1-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-HealthCheck-getStatusV1-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ManagementOfConfiguration-putConfiguration-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-HealthCheck-getStatusV1-200-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
<article id="api-NearRTRICRepository-getRic-0" data-group="User" data-name="getRic" data-version="0">
<div class="pull-left">
<h1>getRic</h1>
- <p>Returns info for one Near-RT RIC</p>
+ <p>Returns info of Near-RT RIC queried by the ric-id and managed-element-id</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<div class="tab-content">
<div class="tab-pane active" id="examples-NearRTRICRepository-getRic-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
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");
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");
// 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);
- }
-}];
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-javascript">
- <pre class="prettyprint"><code class="language-js">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);
-</code></pre>
- </div>
-
- <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-angular">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div>-->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-csharp">
- <pre class="prettyprint"><code class="language-cs">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 );
- }
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-php">
- <pre class="prettyprint"><code class="language-php"><?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;
-}
-?></code></pre>
- </div>
-
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-perl">
- <pre class="prettyprint"><code class="language-perl">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";
-}</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-python">
- <pre class="prettyprint"><code class="language-python">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)</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-rust">
- <pre class="prettyprint"><code class="language-rust">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);
-}
-</code></pre>
- </div>
- </div>
-
- <h2>Scopes</h2>
- <table>
-
- </table>
-
- <h2>Parameters</h2>
-
-
-
-
-
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">managed_element_id</td>
-<td>
-
-
- <div id="d2e199_getRic_managedElementId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">ric_id</td>
-<td>
-
-
- <div id="d2e199_getRic_ricId">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-The identity of a Near-RT RIC to get information for.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <h2>Responses</h2>
- <h3 id="examples-NearRTRICRepository-getRic-title-200"></h3>
- <p id="examples-NearRTRICRepository-getRic-description-200" class="marked"></p>
- <script>
- var responseNearRTRICRepository200_description = `Near-RT RIC is found`;
- var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
- if (responseNearRTRICRepository200_description_break == -1) {
- $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
- } else {
- $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
- $("#examples-NearRTRICRepository-getRic-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-NearRTRICRepository-getRic-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-NearRTRICRepository-getRic-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-200-schema">
- <div id="responses-NearRTRICRepository-getRic-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC is found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ric_info_v2"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRic-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRic-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-NearRTRICRepository-getRic-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-NearRTRICRepository-getRic-title-404"></h3>
- <p id="examples-NearRTRICRepository-getRic-description-404" class="marked"></p>
- <script>
- var responseNearRTRICRepository404_description = `Near-RT RIC is not found`;
- var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
- if (responseNearRTRICRepository404_description_break == -1) {
- $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
- } else {
- $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
- $("#examples-NearRTRICRepository-getRic-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-NearRTRICRepository-getRic-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-NearRTRICRepository-getRic-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-404-schema">
- <div id="responses-NearRTRICRepository-getRic-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Near-RT RIC is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRic-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRic-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-NearRTRICRepository-getRic-404-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- </article>
- </div>
- <hr>
- <div id="api-NearRTRICRepository-getRics">
- <article id="api-NearRTRICRepository-getRics-0" data-group="User" data-name="getRics" data-version="0">
- <div class="pull-left">
- <h1>getRics</h1>
- <p>Query Near-RT RIC information</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">The call returns all Near-RT RICs that supports a given policy type identity</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/rics</span></code></pre>
- <p>
- <h3>Usage and SDK Samples</h3>
- </p>
- <ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-NearRTRICRepository-getRics-0-curl">Curl</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-java">Java</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-csharp">C#</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-php">PHP</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-perl">Perl</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-python">Python</a></li>
- <li class=""><a href="#examples-NearRTRICRepository-getRics-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-NearRTRICRepository-getRics-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
- "http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-java">
- <pre class="prettyprint"><code class="language-java">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();
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-android">
- <pre class="prettyprint"><code class="language-java">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();
- }
- }
-}</code></pre>
- </div>
- <!--
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-groovy">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div> -->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-objc">
- <pre class="prettyprint"><code class="language-cpp">
-
-// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-javascript">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-javascript">
<pre class="prettyprint"><code class="language-js">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) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getRics(opts, callback);
+api.getRic(opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-angular">
+ <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-csharp">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-php">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-perl">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-python">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
# 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)</code></pre>
+ print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-rust">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-rust">
<pre class="prettyprint"><code class="language-rust">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);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">policytype_id</td>
+ <tr><td style="width:150px;">managed_element_id</td>
<td>
- <div id="d2e199_getRics_policytypeId">
+ <div id="d2e199_getRic_managedElementId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</span>
<div class="inner description marked">
-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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">ric_id</td>
+<td>
+
+
+ <div id="d2e199_getRic_ricId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+The identity of a Near-RT RIC to get information for.
</div>
</div>
</div>
</table>
<h2>Responses</h2>
- <h3 id="examples-NearRTRICRepository-getRics-title-200"></h3>
- <p id="examples-NearRTRICRepository-getRics-description-200" class="marked"></p>
+ <h3 id="examples-NearRTRICRepository-getRic-title-200"></h3>
+ <p id="examples-NearRTRICRepository-getRic-description-200" class="marked"></p>
<script>
- var responseNearRTRICRepository200_description = `OK`;
+ var responseNearRTRICRepository200_description = `OK - Near-RT RIC is found`;
var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
if (responseNearRTRICRepository200_description_break == -1) {
- $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
+ $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
} else {
- $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
- $("#examples-NearRTRICRepository-getRics-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
+ $("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
+ $("#examples-NearRTRICRepository-getRic-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
}
</script>
- <ul id="responses-detail-NearRTRICRepository-getRics-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-NearRTRICRepository-getRic-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-NearRTRICRepository-getRics-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-200-schema">
- <div id="responses-NearRTRICRepository-getRics-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-NearRTRICRepository-getRic-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-200-schema">
+ <div id="responses-NearRTRICRepository-getRic-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ric_info_list_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRics-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRics-schema-200');
+ $('#responses-NearRTRICRepository-getRic-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-NearRTRICRepository-getRic-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-NearRTRICRepository-getRics-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-NearRTRICRepository-getRic-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-NearRTRICRepository-getRics-title-404"></h3>
- <p id="examples-NearRTRICRepository-getRics-description-404" class="marked"></p>
+ <h3 id="examples-NearRTRICRepository-getRic-title-404"></h3>
+ <p id="examples-NearRTRICRepository-getRic-description-404" class="marked"></p>
<script>
- var responseNearRTRICRepository404_description = `Policy type is not found`;
+ var responseNearRTRICRepository404_description = `Not Found`;
var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
if (responseNearRTRICRepository404_description_break == -1) {
- $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
+ $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
} else {
- $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
- $("#examples-NearRTRICRepository-getRics-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
+ $("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
+ $("#examples-NearRTRICRepository-getRic-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
}
</script>
- <ul id="responses-detail-NearRTRICRepository-getRics-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-404-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-NearRTRICRepository-getRic-404" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-NearRTRICRepository-getRics-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-404-schema">
- <div id="responses-NearRTRICRepository-getRics-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Policy type is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRics-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRics-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-NearRTRICRepository-getRics-404-schema-data' type='hidden' value=''></input>
- </div>
+ <div class="tab-content" id="responses-NearRTRICRepository-getRic-404-wrapper" style='margin-bottom: 10px;'>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-ServiceCallbacks">
- <h1>ServiceCallbacks</h1>
- <div id="api-ServiceCallbacks-serviceCallback">
- <article id="api-ServiceCallbacks-serviceCallback-0" data-group="User" data-name="serviceCallback" data-version="0">
+ <div id="api-NearRTRICRepository-getRics">
+ <article id="api-NearRTRICRepository-getRics-0" data-group="User" data-name="getRics" data-version="0">
<div class="pull-left">
- <h1>serviceCallback</h1>
- <p>Callback for Near-RT RIC status</p>
+ <h1>getRics</h1>
+ <p>Query Near-RT RIC information</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">The URL to this call is registered at Service registration.</p>
+ <p class="marked">The call returns all Near-RT RICs that supports a given policy type identity</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/r-app/near-rt-ric-status</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/rics</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-ServiceCallbacks-serviceCallback-0-curl">Curl</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-java">Java</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-csharp">C#</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-php">PHP</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-perl">Perl</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-python">Python</a></li>
- <li class=""><a href="#examples-ServiceCallbacks-serviceCallback-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-NearRTRICRepository-getRics-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-java">Java</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-NearRTRICRepository-getRics-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-php">PHP</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-python">Python</a></li>
+ <li class=""><a href="#examples-NearRTRICRepository-getRics-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-ServiceCallbacks-serviceCallback-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/json" \
- -H "Content-Type: application/json" \
- "http://localhost/r-app/near-rt-ric-status" \
- -d ''
+ <div class="tab-pane active" id="examples-NearRTRICRepository-getRics-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
</code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-java">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.ServiceCallbacksApi;
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-groovy">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-objc">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-javascript">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-javascript">
<pre class="prettyprint"><code class="language-js">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) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.serviceCallback(serviceCallbackInfoV2, callback);
+api.getRics(opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-angular">
+ <!--<div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-csharp">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-php">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-perl">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-python">
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-ServiceCallbacks-serviceCallback-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate ServiceCallbacksApi;
+ <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
- <div class="methodsubtabletitle">Body parameters</div>
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
- </tr>
- <tr><td style="width:150px;">serviceCallbackInfoV2 <span style="color:red;">*</span></td>
-<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/service_callback_info_v2"
- }
- }
- },
- "required" : true
-};
+ </tr>
+ <tr><td style="width:150px;">policytype_id</td>
+<td>
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
- var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_serviceCallback_serviceCallbackInfoV2');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_serviceCallback_serviceCallbackInfoV2"></div>
+ <div id="d2e199_getRics_policytypeId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+ </div>
+ </div>
+ </div>
+ </div>
</td>
</tr>
</table>
-
-
<h2>Responses</h2>
- <h3 id="examples-ServiceCallbacks-serviceCallback-title-200"></h3>
- <p id="examples-ServiceCallbacks-serviceCallback-description-200" class="marked"></p>
+ <h3 id="examples-NearRTRICRepository-getRics-title-200"></h3>
+ <p id="examples-NearRTRICRepository-getRics-description-200" class="marked"></p>
<script>
- var responseServiceCallbacks200_description = `OK`;
- var responseServiceCallbacks200_description_break = responseServiceCallbacks200_description.indexOf('\n');
- if (responseServiceCallbacks200_description_break == -1) {
- $("#examples-ServiceCallbacks-serviceCallback-title-200").text("Status: 200 - " + responseServiceCallbacks200_description);
+ var responseNearRTRICRepository200_description = `OK`;
+ var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
+ if (responseNearRTRICRepository200_description_break == -1) {
+ $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
} else {
- $("#examples-ServiceCallbacks-serviceCallback-title-200").text("Status: 200 - " + responseServiceCallbacks200_description.substring(0, responseServiceCallbacks200_description_break));
- $("#examples-ServiceCallbacks-serviceCallback-description-200").html(responseServiceCallbacks200_description.substring(responseServiceCallbacks200_description_break));
+ $("#examples-NearRTRICRepository-getRics-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description.substring(0, responseNearRTRICRepository200_description_break));
+ $("#examples-NearRTRICRepository-getRics-description-200").html(responseNearRTRICRepository200_description.substring(responseNearRTRICRepository200_description_break));
}
</script>
- <ul id="responses-detail-ServiceCallbacks-serviceCallback-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-NearRTRICRepository-getRics-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-ServiceCallbacks-serviceCallback-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-ServiceCallbacks-serviceCallback-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceCallbacks-serviceCallback-200-schema">
- <div id="responses-ServiceCallbacks-serviceCallback-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-NearRTRICRepository-getRics-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-200-schema">
+ <div id="responses-NearRTRICRepository-getRics-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceCallbacks-serviceCallback-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceCallbacks-serviceCallback-schema-200');
+ $('#responses-NearRTRICRepository-getRics-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-NearRTRICRepository-getRics-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-ServiceCallbacks-serviceCallback-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-NearRTRICRepository-getRics-200-schema-data' type='hidden' value=''></input>
</div>
</div>
+ <h3 id="examples-NearRTRICRepository-getRics-title-404"></h3>
+ <p id="examples-NearRTRICRepository-getRics-description-404" class="marked"></p>
+ <script>
+ var responseNearRTRICRepository404_description = `Not Found`;
+ var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
+ if (responseNearRTRICRepository404_description_break == -1) {
+ $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
+ } else {
+ $("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description.substring(0, responseNearRTRICRepository404_description_break));
+ $("#examples-NearRTRICRepository-getRics-description-404").html(responseNearRTRICRepository404_description.substring(responseNearRTRICRepository404_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-NearRTRICRepository-getRics-404" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-NearRTRICRepository-getRics-404-wrapper" style='margin-bottom: 10px;'>
+ </div>
</article>
</div>
<hr>
<article id="api-ServiceRegistryAndSupervision-deleteService-0" data-group="User" data-name="deleteService" data-version="0">
<div class="pull-left">
<h1>deleteService</h1>
- <p>Unregister a service</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Unregister a service</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/a1-policy/v2/services/{service_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-deleteService-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
"http://localhost/a1-policy/v2/services/{service_id}"
</code></pre>
</div>
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) {
var serviceId = serviceId_example; // String | (default to null)
try {
- // Unregister a service
Object result = apiInstance.deleteService(serviceId);
Debug.WriteLine(result);
} catch (Exception e) {
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:
<h2>Responses</h2>
- <h3 id="examples-ServiceRegistryAndSupervision-deleteService-title-200"></h3>
- <p id="examples-ServiceRegistryAndSupervision-deleteService-description-200" class="marked"></p>
- <script>
- var responseServiceRegistryAndSupervision200_description = `Not used`;
- var responseServiceRegistryAndSupervision200_description_break = responseServiceRegistryAndSupervision200_description.indexOf('\n');
- if (responseServiceRegistryAndSupervision200_description_break == -1) {
- $("#examples-ServiceRegistryAndSupervision-deleteService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description);
- } else {
- $("#examples-ServiceRegistryAndSupervision-deleteService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description.substring(0, responseServiceRegistryAndSupervision200_description_break));
- $("#examples-ServiceRegistryAndSupervision-deleteService-description-200").html(responseServiceRegistryAndSupervision200_description.substring(responseServiceRegistryAndSupervision200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-ServiceRegistryAndSupervision-deleteService-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-deleteService-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-ServiceRegistryAndSupervision-deleteService-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-deleteService-200-schema">
- <div id="responses-ServiceRegistryAndSupervision-deleteService-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Not used",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/void"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-deleteService-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-deleteService-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-deleteService-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
<h3 id="examples-ServiceRegistryAndSupervision-deleteService-title-204"></h3>
<p id="examples-ServiceRegistryAndSupervision-deleteService-description-204" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision204_description = `Service unregistered`;
+ var responseServiceRegistryAndSupervision204_description = `No Content - Service unregistered`;
var responseServiceRegistryAndSupervision204_description_break = responseServiceRegistryAndSupervision204_description.indexOf('\n');
if (responseServiceRegistryAndSupervision204_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-deleteService-title-204").text("Status: 204 - " + responseServiceRegistryAndSupervision204_description);
<div id="responses-ServiceRegistryAndSupervision-deleteService-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service unregistered",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-ServiceRegistryAndSupervision-deleteService-title-404"></h3>
<p id="examples-ServiceRegistryAndSupervision-deleteService-description-404" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision404_description = `Service not found`;
+ var responseServiceRegistryAndSupervision404_description = `Not Found`;
var responseServiceRegistryAndSupervision404_description_break = responseServiceRegistryAndSupervision404_description.indexOf('\n');
if (responseServiceRegistryAndSupervision404_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-deleteService-title-404").text("Status: 404 - " + responseServiceRegistryAndSupervision404_description);
<ul id="responses-detail-ServiceRegistryAndSupervision-deleteService-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-deleteService-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-ServiceRegistryAndSupervision-deleteService-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-deleteService-404-schema">
- <div id="responses-ServiceRegistryAndSupervision-deleteService-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service not found",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-deleteService-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-deleteService-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-deleteService-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-getServices-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/services?service_id=serviceId_example"
</code></pre>
</div>
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");
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");
// Returns service information
[apiInstance getServicesWith:serviceId
- completionHandler: ^(service_list_v2 output, NSError* error) {
+ completionHandler: ^(service_status_list output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
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 );
<div id="responses-ServiceRegistryAndSupervision-getServices-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/service_list_v2"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-ServiceRegistryAndSupervision-getServices-title-404"></h3>
<p id="examples-ServiceRegistryAndSupervision-getServices-description-404" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision404_description = `Service is not found`;
+ var responseServiceRegistryAndSupervision404_description = `Not Found`;
var responseServiceRegistryAndSupervision404_description_break = responseServiceRegistryAndSupervision404_description.indexOf('\n');
if (responseServiceRegistryAndSupervision404_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-getServices-title-404").text("Status: 404 - " + responseServiceRegistryAndSupervision404_description);
<ul id="responses-detail-ServiceRegistryAndSupervision-getServices-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-getServices-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-ServiceRegistryAndSupervision-getServices-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-getServices-404-schema">
- <div id="responses-ServiceRegistryAndSupervision-getServices-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-getServices-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-getServices-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-getServices-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-keepAliveService-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
"http://localhost/a1-policy/v2/services/{service_id}/keepalive"
</code></pre>
</div>
<h3 id="examples-ServiceRegistryAndSupervision-keepAliveService-title-200"></h3>
<p id="examples-ServiceRegistryAndSupervision-keepAliveService-description-200" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision200_description = `Service supervision timer refreshed, OK`;
+ var responseServiceRegistryAndSupervision200_description = `OK - Service supervision timer refreshed, OK`;
var responseServiceRegistryAndSupervision200_description_break = responseServiceRegistryAndSupervision200_description.indexOf('\n');
if (responseServiceRegistryAndSupervision200_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-keepAliveService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description);
<div id="responses-ServiceRegistryAndSupervision-keepAliveService-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service supervision timer refreshed, OK",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-ServiceRegistryAndSupervision-keepAliveService-title-404"></h3>
<p id="examples-ServiceRegistryAndSupervision-keepAliveService-description-404" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision404_description = `The service is not found, needs re-registration`;
+ var responseServiceRegistryAndSupervision404_description = `Not Found`;
var responseServiceRegistryAndSupervision404_description_break = responseServiceRegistryAndSupervision404_description.indexOf('\n');
if (responseServiceRegistryAndSupervision404_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-keepAliveService-title-404").text("Status: 404 - " + responseServiceRegistryAndSupervision404_description);
<ul id="responses-detail-ServiceRegistryAndSupervision-keepAliveService-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-keepAliveService-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-ServiceRegistryAndSupervision-keepAliveService-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-keepAliveService-404-schema">
- <div id="responses-ServiceRegistryAndSupervision-keepAliveService-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "The service is not found, needs re-registration",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-keepAliveService-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-keepAliveService-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-keepAliveService-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-putService-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
-H "Content-Type: application/json" \
"http://localhost/a1-policy/v2/services" \
-d ''
// 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");
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");
// 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);
// 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) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.putService(serviceRegistrationInfoV2, callback);
+api.putService(serviceRegistrationInfo, callback);
</code></pre>
</div>
// 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 );
// 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;
# 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 ($@) {
# 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)</code></pre>
<pre class="prettyprint"><code class="language-rust">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);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">serviceRegistrationInfoV2 <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">serviceRegistrationInfo <span style="color:red;">*</span></td>
<td>
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/service_registration_info_v2"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_registration_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_putService_serviceRegistrationInfoV2');
+ var result = $('#d2e199_putService_serviceRegistrationInfo');
result.empty();
result.append(view.render());
});
</script>
-<div id="d2e199_putService_serviceRegistrationInfoV2"></div>
+<div id="d2e199_putService_serviceRegistrationInfo"></div>
</td>
</tr>
<h3 id="examples-ServiceRegistryAndSupervision-putService-title-200"></h3>
<p id="examples-ServiceRegistryAndSupervision-putService-description-200" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision200_description = `Service updated`;
+ var responseServiceRegistryAndSupervision200_description = `OK - Service updated`;
var responseServiceRegistryAndSupervision200_description_break = responseServiceRegistryAndSupervision200_description.indexOf('\n');
if (responseServiceRegistryAndSupervision200_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-putService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description);
<div id="responses-ServiceRegistryAndSupervision-putService-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service updated",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-ServiceRegistryAndSupervision-putService-title-201"></h3>
<p id="examples-ServiceRegistryAndSupervision-putService-description-201" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision201_description = `Service created`;
+ var responseServiceRegistryAndSupervision201_description = `Created - Service created`;
var responseServiceRegistryAndSupervision201_description_break = responseServiceRegistryAndSupervision201_description.indexOf('\n');
if (responseServiceRegistryAndSupervision201_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-putService-title-201").text("Status: 201 - " + responseServiceRegistryAndSupervision201_description);
<div id="responses-ServiceRegistryAndSupervision-putService-schema-201" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "Service created",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<h3 id="examples-ServiceRegistryAndSupervision-putService-title-400"></h3>
<p id="examples-ServiceRegistryAndSupervision-putService-description-400" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision400_description = `The ServiceRegistrationInfo is not accepted`;
+ var responseServiceRegistryAndSupervision400_description = `Bad Request`;
var responseServiceRegistryAndSupervision400_description_break = responseServiceRegistryAndSupervision400_description.indexOf('\n');
if (responseServiceRegistryAndSupervision400_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-putService-title-400").text("Status: 400 - " + responseServiceRegistryAndSupervision400_description);
<div id="responses-ServiceRegistryAndSupervision-putService-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "description" : "The ServiceRegistrationInfo is not accepted",
- "content" : {
- "*/*" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
-};
+ var schemaWrapper = ;
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
schema = schemaWrapper.schema;
}
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
} else if (schema.items != null && schema.items.$ref != null) {
schema.items = defsParser.$refs.get(schema.items.$ref);
} else {
<div id="footer">
<div id="api-_footer">
<p>Suggestions, contact, support and error reporting;
- <div class="app-desc">Information URL: <a href="https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP">https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP</a></div>
- <div class="app-desc">Contact Info: <a href="team@openapitools.org">team@openapitools.org</a></div>
+ <div class="app-desc">Information URL: <a href="https://www.onap.org/">https://www.onap.org/</a></div>
+ <div class="app-desc">Contact Info: <a href="discuss-list@onap.com">discuss-list@onap.com</a></div>
</p>
<div class="license-info">Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.</div>
<div class="license-url">http://www.apache.org/licenses/LICENSE-2.0</div>
# ONAP : ccsdk oran
# ================================================================================
# Copyright (C) 2020-2023 Nordix Foundation. All rights reserved.
+# Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
#
-spring:
- application:
- name: a1-pms
- profiles:
- active: prod
- main:
- allow-bean-definition-overriding: true
- aop:
- auto: false
-management:
- tracing:
- propagation:
- produce: ${ONAP_PROPAGATOR_PRODUCE:[W3C]}
- sampling:
- probability: 1.0
- endpoints:
- web:
- exposure:
- # Enabling of springboot actuator features. See springboot documentation.
- include: "loggers,logfile,health,info,metrics,threaddump,heapdump,shutdown"
- endpoint:
- shutdown:
- enabled: true
-lifecycle:
- timeout-per-shutdown-phase: "20s"
-springdoc:
- show-actuator: true
-logging:
- # Configuration of logging
- level:
- ROOT: ERROR
- org.springframework: ERROR
- org.springframework.data: ERROR
- org.springframework.web.reactive.function.client.ExchangeFunctions: ERROR
- org.springframework.web.servlet.DispatcherServlet: ERROR
- org.onap.ccsdk.oran.a1policymanagementservice: INFO
- pattern:
- console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger{20} - %msg%n"
- file: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger{20} - %msg%n"
- file:
- name: /var/log/policy-agent/application.log
-server:
- # Configuration of the HTTP/REST server. The parameters are defined and handeled by the springboot framework.
- # See springboot documentation.
- port : 8433
- http-port: 8081
- shutdown: "graceful"
- ssl:
- key-store-type: JKS
- key-store-password: policy_agent
- key-store: /opt/app/policy-agent/etc/cert/keystore.jks
- key-password: policy_agent
- key-alias: policy_agent
- # trust-store-password:
- # trust-store:
+
app:
- # Location of the component configuration file.
- filepath: /opt/app/policy-agent/data/application_configuration.json
- webclient:
- # Configuration of the trust store used for the HTTP client (outgoing requests)
- # The file location and the password for the truststore is only relevant if trust-store-used == true
- # Note that the same keystore as for the server is used.
- trust-store-used: false
- trust-store-password: policy_agent
- trust-store: /opt/app/policy-agent/etc/cert/truststore.jks
- # Configuration of usage of HTTP Proxy for the southbound accesses.
- # The HTTP proxy (if configured) will only be used for accessing NearRT RIC:s
- # proxy-type can be either HTTP, SOCKS4 or SOCKS5
- http.proxy-host:
- http.proxy-port: 0
- http.proxy-type: HTTP
- # path where the service can store data. This parameter is not relevant if S3 Object store is configured.
- vardata-directory: /var/policy-management-service
- # the config-file-schema-path referres to a location in the jar file. If this property is empty or missing,
- # no schema validation will be executed.
- config-file-schema-path: /application_configuration_schema.json
# A file containing an authorization token, which shall be inserted in each HTTP header (authorization).
# If the file name is empty, no authorization token is sent.
auth-token-file:
# A URL to authorization provider such as OPA. Each time an A1 Policy is accessed, a call to this
# authorization provider is done for access control. If this is empty, no fine grained access control is done.
authorization-provider:
+ # the config-file-schema-path referres to a location in the jar file. If this property is empty or missing,
+ # no schema validation will be executed.
+ config-file-schema-path: /application_configuration_schema.json
+ # Location of the component configuration file.
+ filepath: /opt/app/policy-agent/data/application_configuration.json
# S3 object store usage is enabled by defining the bucket to use. This will override the vardata-directory parameter.
s3:
endpointOverride: http://localhost:9000
accessKeyId: minio
secretAccessKey: miniostorage
bucket:
+ webclient:
+ # Configuration of usage of HTTP Proxy for the southbound accesses.
+ # The HTTP proxy (if configured) will only be used for accessing NearRT RIC:s
+ # proxy-type can be either HTTP, SOCKS4 or SOCKS5
+ http.proxy-host:
+ http.proxy-port: 0
+ http.proxy-type: HTTP
+ # Configuration of the trust store used for the HTTP client (outgoing requests)
+ # The file location and the password for the truststore is only relevant if trust-store-used == true
+ # Note that the same keystore as for the server is used.
+ trust-store-used: false
+ trust-store-password: policy_agent
+ trust-store: /opt/app/policy-agent/etc/cert/truststore.jks
+ # path where the service can store data. This parameter is not relevant if S3 Object store is configured.
+ vardata-directory: /var/policy-management-service
+lifecycle:
+ timeout-per-shutdown-phase: "20s"
+logging:
+ # Configuration of logging
+ file:
+ name: /var/log/policy-agent/application.log
+ level:
+ ROOT: ERROR
+ org.onap.ccsdk.oran.a1policymanagementservice: INFO
+ org.springframework: ERROR
+ org.springframework.data: ERROR
+ org.springframework.web.reactive.function.client.ExchangeFunctions: ERROR
+ org.springframework.web.servlet.DispatcherServlet: ERROR
+ pattern:
+ console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger{20} - %msg%n"
+ file: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger{20} - %msg%n"
+management:
+ endpoint:
+ shutdown:
+ enabled: true
+ endpoints:
+ web:
+ exposure:
+ # Enabling of springboot actuator features. See springboot documentation.
+ include: "loggers,logfile,health,info,metrics,threaddump,heapdump,shutdown"
+ tracing:
+ propagation:
+ produce: ${ONAP_PROPAGATOR_PRODUCE:[W3C]}
+ sampling:
+ probability: 1.0
otel:
+ exporter:
+ otlp:
+ traces:
+ endpoint: ${ONAP_OTEL_EXPORTER_ENDPOINT:http://jaeger:4317}
+ protocol: ${ONAP_OTEL_EXPORTER_PROTOCOL:grpc}
+ logs:
+ exporter: none
+ metrics:
+ exporter: none
sdk:
disabled: ${ONAP_SDK_DISABLED:true}
south: ${ONAP_TRACING_SOUTHBOUND:true}
sampler:
jaeger_remote:
endpoint: ${ONAP_OTEL_SAMPLER_JAEGER_REMOTE_ENDPOINT:http://jaeger:14250}
- exporter:
- otlp:
- traces:
- protocol: ${ONAP_OTEL_EXPORTER_PROTOCOL:grpc}
- endpoint: ${ONAP_OTEL_EXPORTER_ENDPOINT:http://jaeger:4317}
- metrics:
- exporter: none
- logs:
- exporter: none
+server:
+ # Configuration of the HTTP/REST server. The parameters are defined and handeled by the springboot framework.
+ # See springboot documentation.
+ port : 8433
+ http-port: 8081
+ shutdown: "graceful"
+ ssl:
+ key-store-type: JKS
+ key-store-password: policy_agent
+ key-store: /opt/app/policy-agent/etc/cert/keystore.jks
+ key-password: policy_agent
+ key-alias: policy_agent
+ # trust-store-password:
+ # trust-store:
+spring:
+ aop:
+ auto: false
+ application:
+ name: a1-pms
+ main:
+ allow-bean-definition-overriding: true
+ profiles:
+ active: prod
+springdoc:
+ show-actuator: true
\ No newline at end of file
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.onap.ccsdk.parent</groupId>
- <artifactId>spring-boot-31-starter-parent</artifactId>
- <version>2.6.1</version>
+ <artifactId>spring-boot-33-starter-parent</artifactId>
+ <version>2.8.0-SNAPSHOT</version>
<relativePath/>
</parent>
<groupId>org.onap.ccsdk.oran</groupId>
<java.version.source>17</java.version.source>
<java.version.target>17</java.version.target>
<gson.version>2.10.1</gson.version>
- <json.version>20231013</json.version>
+ <json.version>20240303</json.version>
+ <localstack.version>1.20.1</localstack.version>
+ <junit.jupiter.version>1.20.1</junit.jupiter.version>
+ <javax.annotation-api.version>1.3.2</javax.annotation-api.version>
+ <everit-json-schema.version>1.14.4</everit-json-schema.version>
+ <jackson-databind-nullable.version>0.2.6</jackson-databind-nullable.version>
+ <validation-api.version>2.0.1.Final</validation-api.version>
+ <swagger-annotations.version>2.2.15</swagger-annotations.version>
+ <spring-boot-actuator-autoconfigure.version>3.1.0</spring-boot-actuator-autoconfigure.version>
<formatter-maven-plugin.version>2.22.0</formatter-maven-plugin.version>
<spotless-maven-plugin.version>2.35.0</spotless-maven-plugin.version>
- <commons-io.version>2.14.0</commons-io.version>
- <guava.version>32.0.1-jre</guava.version>
+ <commons-io.version>2.16.1</commons-io.version>
+ <guava.version>33.3.0-jre</guava.version>
<springdoc.version>2.0.2</springdoc.version>
<docker-maven-plugin>0.30.0</docker-maven-plugin>
<surefire-maven-plugin.version>3.0.0-M8</surefire-maven-plugin.version>
<surefire-report-plugin.version>3.0.0-M8</surefire-report-plugin.version>
<jacoco-maven-plugin.version>0.8.8</jacoco-maven-plugin.version>
<ccsdk.project.version>${project.version}</ccsdk.project.version>
- <software.amazon.awssdk.version>2.20.12</software.amazon.awssdk.version>
+ <software.amazon.awssdk.version>2.27.8</software.amazon.awssdk.version>
+ <mapstruct.version>1.6.0</mapstruct.version>
<allowskiptests>false</allowskiptests>
</properties>
<dependencies>
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
- <version>2.0.1.Final</version>
+ <version>${validation-api.version}</version>
</dependency>
<dependency>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
- <version>1.3.2</version>
+ <version>${javax.annotation-api.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
- <version>2.2.15</version>
+ <version>${swagger-annotations.version}</version>
</dependency>
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>jackson-databind-nullable</artifactId>
- <version>0.2.4</version>
- </dependency>
- <dependency>
- <!-- Temporary until version 2 is included by the parent spring-boot-starter-parent -->
- <groupId>org.yaml</groupId>
- <artifactId>snakeyaml</artifactId>
- <version>2.0</version>
+ <version>${jackson-databind-nullable.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
- <dependency>
- <!-- May be possible to remove this later when ccsdk parent bom stabilizes -->
- <groupId>javax.servlet</groupId>
- <artifactId>javax.servlet-api</artifactId>
- <version>3.1.0</version>
- </dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
- <version>1.5.5.Final</version>
+ <version>${mapstruct.version}</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
- <version>1.5.5.Final</version>
+ <version>${mapstruct.version}</version>
</dependency>
<!-- Actuator dependencies -->
<dependency>
<optional>true</optional>
<scope>runtime</scope>
</dependency>
+ <dependency>
+ <groupId>org.testcontainers</groupId>
+ <artifactId>junit-jupiter</artifactId>
+ <version>${junit.jupiter.version}</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.testcontainers</groupId>
+ <artifactId>localstack</artifactId>
+ <version>${localstack.version}</version>
+ <scope>test</scope>
+ </dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<dependency>
<groupId>com.github.erosb</groupId>
<artifactId>everit-json-schema</artifactId>
- <version>1.14.0</version>
+ <version>${everit-json-schema.version}</version>
</dependency>
<!-- For Tracing -->
<dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-actuator-autoconfigure</artifactId>
- <version>3.1.0</version>
</dependency>
</dependencies>
<dependencyManagement>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
- <version>1.38.0</version>
+ <version>1.41.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-instrumentation-bom-alpha</artifactId>
- <version>2.4.0-alpha</version>
+ <version>2.7.0-alpha</version>
<type>pom</type>
<scope>import</scope>
</dependency>
import org.onap.ccsdk.oran.a1policymanagementservice.tasks.RefreshConfigTask;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
return Mono.error(ex);
}
}
-
- public static Mono<String> getValueFromResponse(String response, String key) {
- return getOutput(response) //
- .map(responseParams -> {
- if (!responseParams.has(key)) {
- return "";
- }
- return responseParams.get(key).toString();
- });
- }
-
- public static Mono<String> extractPolicySchema(String inputString) {
- try {
- JSONObject jsonObject = new JSONObject(inputString);
- JSONObject schemaObject = jsonObject.getJSONObject("policySchema");
- String schemaString = schemaObject.toString();
- return Mono.just(schemaString);
- } catch (Exception ex) { // invalid json
- logger.debug("Invalid json {}", ex.getMessage());
- return Mono.error(ex);
- }
- }
}
package org.onap.ccsdk.oran.a1policymanagementservice.clients;
-import java.lang.invoke.MethodHandles;
-import java.lang.reflect.Constructor;
-
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client.A1ProtocolType;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ControllerConfig;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
import reactor.core.publisher.Mono;
+import java.lang.invoke.MethodHandles;
+import java.lang.reflect.Constructor;
+
/**
* Factory for A1 clients that supports four different protocol versions of the
* A1 api.
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private final ApplicationConfig appConfig;
-
private final AsyncRestClientFactory restClientFactory;
public A1ClientFactory(ApplicationConfig appConfig, SecurityContext securityContext) {
- this.appConfig = appConfig;
this.restClientFactory = new AsyncRestClientFactory(appConfig.getWebClientConfig(), securityContext);
}
}
}
- private ControllerConfig getControllerConfig(Ric ric) throws ServiceException {
- ControllerConfig controllerConfig = ric.getConfig().getControllerConfig();
- if (controllerConfig == null) {
- ric.setProtocolVersion(A1ProtocolType.UNKNOWN);
- throw new ServiceException("No controller configured for Near-RT RIC: " + ric.id());
- }
- return controllerConfig;
- }
-
private A1Client createCustomAdapter(Ric ric) throws ServiceException {
try {
if (ric.getConfig().getCustomAdapterClass() != null && !ric.getConfig().getCustomAdapterClass().isEmpty()) {
Class<?> clazz = Class.forName(ric.getConfig().getCustomAdapterClass());
if (A1Client.class.isAssignableFrom(clazz)) {
Constructor<?> constructor = clazz.getConstructor(RicConfig.class, AsyncRestClientFactory.class);
- logger.debug("A1Client (" + clazz.getTypeName() + ") being created for ric: {}",
- ric.getConfig().getRicId());
+ logger.debug("A1Client \"{}\" being created for ric: {}",
+ clazz.getTypeName(), ric.getConfig().getRicId());
return (A1Client) constructor.newInstance(ric.getConfig(), this.restClientFactory);
} else if (A1Client.Factory.class.isAssignableFrom(clazz)) {
A1Client.Factory factory = (A1Client.Factory) clazz.getDeclaredConstructor().newInstance();
- logger.debug("A1Client (" + clazz.getTypeName() + ") factory creating client for ric: {}",
- ric.getConfig().getRicId());
+ logger.debug("A1Client \"{}\" factory creating client for ric: {}",
+ clazz.getTypeName(), ric.getConfig().getRicId());
return factory.create(ric.getConfig(), this.restClientFactory);
} else {
throw new ServiceException("The custom class must either implement A1Client.Factory or A1Client");
* CCSDK_A1_ADAPTER_STD_V2_0_0 with
* @param ricConfig the configuration of the Near-RT RIC to communicate
* with
- * @param controllerConfig the configuration of the CCSDK A1 Adapter to use
*
* @throws IllegalArgumentException when the protocolType is wrong.
*/
* CCSDK_A1_ADAPTER_STD_V2_0_0 with
* @param ricConfig the configuration of the Near-RT RIC to communicate
* with
- * @param controllerConfig the configuration of the CCSDK A1 Adapter to use
* @param restClient the REST client to use
*
* @throws IllegalArgumentException when the protocolType is illegal.
this.restClient = restClient;
this.ricConfig = ricConfig;
this.protocolType = protocolType;
- logger.debug("A1Client (" + getClass().getTypeName() + ") created for ric: {}, a1Controller: {}",
- ricConfig.getRicId(), ricConfig.getControllerConfig());
+ logger.debug("A1Client \"{}\" created for ric: {}, a1Controller: {}",
+ getClass().getTypeName(), ricConfig.getRicId(), ricConfig.getControllerConfig());
} else {
logger.error("Not supported protocoltype: {}", protocolType);
public OscA1Client(RicConfig ricConfig, AsyncRestClient restClient) {
this.restClient = restClient;
uri = new UriBuilder(ricConfig);
- logger.debug("A1Client (" + getClass().getTypeName() + ") created for ric: {}", ricConfig.getRicId());
+ logger.debug("A1Client \"{}\" created for ric: {}", getClass().getTypeName(), ricConfig.getRicId());
}
public static Mono<String> extractCreateSchema(String policyTypeResponse, String policyTypeId) {
public StdA1ClientVersion1(AsyncRestClient restClient, RicConfig ricConfig) {
this.restClient = restClient;
this.uri = new UriBuilder(ricConfig);
- logger.debug("A1Client (" + getClass().getTypeName() + ") created for ric: {}", ricConfig.getRicId());
+ logger.debug("A1Client \"{}\" created for ric: {}", getClass().getTypeName(), ricConfig.getRicId());
}
@Override
public StdA1ClientVersion2(RicConfig ricConfig, AsyncRestClient restClient) {
this.restClient = restClient;
uriBuiler = new OranV2UriBuilder(ricConfig);
- logger.debug("A1Client (" + getClass().getTypeName() + ") created for ric: {}", ricConfig.getRicId());
+ logger.debug("A1Client \"{}\" created for ric: {}", getClass().getTypeName(), ricConfig.getRicId());
}
public static Mono<String> extractPolicySchema(String policyTypeResponse, String policyTypeId) {
Map<String, ControllerConfig> controllerConfigs = parseControllerConfigs(pmsConfigJson);
List<RicConfig> ricConfigs = parseRics(pmsConfigJson, controllerConfigs);
- checkConfigurationConsistency(ricConfigs, controllerConfigs);
+ checkConfigurationConsistency(ricConfigs);
return ConfigParserResult.builder() //
.ricConfigs(ricConfigs) //
return CharStreams.toString(new InputStreamReader(in, StandardCharsets.UTF_8));
}
- private void checkConfigurationConsistency(List<RicConfig> ricConfigs,
- Map<String, ControllerConfig> controllerConfigs) throws ServiceException {
+ private void checkConfigurationConsistency(List<RicConfig> ricConfigs) throws ServiceException {
Set<String> ricUrls = new HashSet<>();
Set<String> ricNames = new HashSet<>();
for (RicConfig ric : ricConfigs) {
private JsonArray getAsJsonArray(JsonObject obj, String memberName) throws ServiceException {
return get(obj, memberName).getAsJsonArray();
}
-
- private static String getAsString(JsonObject obj, String memberName) throws ServiceException {
- return get(obj, memberName).getAsString();
- }
}
@Builder
public class AuthorizationResult {
- @Schema(name = "result", description = "If true, the access is granted", required = true)
+ @Schema(name = "result", description = "If true, the access is granted", requiredMode = Schema.RequiredMode.REQUIRED)
@JsonProperty(value = "result", required = true)
@SerializedName("result")
@Getter
READ, WRITE, DELETE
}
- @Schema(name = "access_type", description = "Access type", required = true)
+ @Schema(name = "access_type", description = "Access type", requiredMode = Schema.RequiredMode.REQUIRED)
@JsonProperty(value = "access_type", required = true)
@SerializedName("access_type")
@Getter
private AccessType accessType;
- @Schema(name = "policy_type_id", description = "Policy type identifier", required = true)
+ @Schema(name = "policy_type_id", description = "Policy type identifier", requiredMode = Schema.RequiredMode.REQUIRED)
@SerializedName("policy_type_id")
@JsonProperty(value = "policy_type_id", required = true)
private String policyTypeId;
- @Schema(name = "auth_token", description = "Authorization token", required = true)
+ @Schema(name = "auth_token", description = "Authorization token", requiredMode = Schema.RequiredMode.REQUIRED)
@SerializedName("auth_token")
@JsonProperty(value = "auth_token", required = true)
private String authToken;
}
- @Schema(name = "input", description = "Input", required = true)
+ @Schema(name = "input", description = "Input", requiredMode = Schema.RequiredMode.REQUIRED)
@JsonProperty(value = "input", required = true)
@SerializedName("input")
private Input input;
import java.io.IOException;
import java.util.Optional;
-@RestController("ConfigurationControllerV2")
+@RestController("configurationControllerV2")
@Tag( //
name = ConfigurationController.API_NAME, //
description = ConfigurationController.API_DESCRIPTION //
import lombok.Getter;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v2.A1PolicyManagementApi;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.authorization.AuthorizationCheck;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
-@RestController("PolicyControllerV2")
+@RestController("policyControllerV2")
+@RequiredArgsConstructor
@Tag(//
name = PolicyController.API_NAME, //
description = PolicyController.API_DESCRIPTION //
public static final String API_NAME = "A1 Policy Management";
public static final String API_DESCRIPTION = "";
-
public static class RejectionException extends Exception {
private static final long serialVersionUID = 1L;
}
}
- @Autowired
- private Rics rics;
- @Autowired
- private PolicyTypes policyTypes;
- @Autowired
- private Policies policies;
- @Autowired
- private A1ClientFactory a1ClientFactory;
- @Autowired
- private Services services;
- @Autowired
- private ObjectMapper objectMapper;
- @Autowired
- private AuthorizationCheck authorization;
+ private final Rics rics;
+ private final PolicyTypes policyTypes;
+ private final Policies policies;
+ private final A1ClientFactory a1ClientFactory;
+ private final Services services;
+ private final ObjectMapper objectMapper;
+ private final AuthorizationCheck authorization;
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private static Gson gson = new GsonBuilder() //
- .create(); //
+ private static final Gson gson = new GsonBuilder().create();
@Override
public Mono<ResponseEntity<PolicyTypeDefinition>> getPolicyTypeDefinition(String policyTypeId, ServerWebExchange exchange)
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v2.NearRtRicRepositoryApi;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.InvalidRequestException;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RestController;
import java.util.ArrayList;
import java.util.List;
-@RestController("RicRepositoryControllerV2")
+@RestController("ricRepositoryControllerV2")
+@RequiredArgsConstructor
@Tag( //
name = RicRepositoryController.API_NAME, //
description = RicRepositoryController.API_DESCRIPTION //
public static final String API_NAME = "NearRT-RIC Repository";
public static final String API_DESCRIPTION = "";
- @Autowired
- private Rics rics;
+ private final Rics rics;
+ final PolicyTypes types;
+ final ObjectMapper objectMapper;
- @Autowired
- PolicyTypes types;
-
- @Autowired
- ObjectMapper objectMapper;
-
- private static Gson gson = new GsonBuilder() //
- .create(); //
+ private static final Gson gson = new GsonBuilder().create();
private static final String GET_RIC_BRIEF = "Returns info for one Near-RT RIC";
private static final String GET_RIC_DETAILS =
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v2.ServiceRegistryAndSupervisionApi;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v2.ServiceRegistrationInfo;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RestController;
import java.util.Collection;
import java.util.List;
-@RestController("ServiceControllerV2")
+@RestController("serviceControllerV2")
+@RequiredArgsConstructor
@Tag( //
name = ServiceController.API_NAME, //
description = ServiceController.API_DESCRIPTION //
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- @Autowired
- private PolicyController policyController;
-
- ServiceController(Services services, Policies policies) {
- this.services = services;
- this.policies = policies;
- }
+ private final PolicyController policyController;
private static final String GET_SERVICE_DETAILS =
"Either information about a registered service with given identity or all registered services are returned.";
Service service = removeService(serviceId);
removePolicies(service, exchange);
return Mono.just(new ResponseEntity<>(HttpStatus.NO_CONTENT));
- } catch (ServiceException | NullPointerException e) {
+ } catch (ServiceException e) {
logger.warn("Exception caught during service deletion while deleting service {}: {}", serviceId,
e.getMessage());
return ErrorResponse.createMono(e, HttpStatus.NOT_FOUND);
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
-@RestController("StatusControllerV2")
+@RestController("statusControllerV2")
@Tag( name = StatusController.API_NAME,
description = StatusController.API_DESCRIPTION
)
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v3;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v3.ConfigurationApi;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.ConfigurationController;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
-@RestController("ConfigurationControllerV3")
+@RestController("configurationControllerV3")
+@RequiredArgsConstructor
@Tag( //
name = ConfigurationControllerV3.API_NAME, //
description = ConfigurationControllerV3.API_DESCRIPTION //
public static final String API_NAME = "Management of configuration";
public static final String API_DESCRIPTION = "API used to create or fetch the application configuration";
-
- @Autowired
- private ConfigurationController configurationController;
+ private final ConfigurationController configurationController;
@Override
public Mono<ResponseEntity<String>> getConfiguration(ServerWebExchange exchange) throws Exception {
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v3;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v3.A1PolicyManagementApi;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.PolicyController;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.PolicyTypeInformation;
import org.onap.ccsdk.oran.a1policymanagementservice.service.v3.ErrorHandlingService;
import org.onap.ccsdk.oran.a1policymanagementservice.service.v3.PolicyService;
-import org.onap.ccsdk.oran.a1policymanagementservice.util.v3.Helper;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
-@RestController("PolicyControllerV3")
+@RestController("policyControllerV3")
+@RequiredArgsConstructor
@Tag(//
name = PolicyController.API_NAME, //
description = PolicyController.API_DESCRIPTION //
public class PolicyControllerV3 implements A1PolicyManagementApi {
public static final String API_NAME = "A1 Policy Management";
public static final String API_DESCRIPTION = "API to create,update and get policies or policy definitions";
- @Autowired
- private PolicyService policyService;
- @Autowired
- private Helper helper;
-
- @Autowired
- private ErrorHandlingService errorHandlingService;
+ private final PolicyService policyService;
+ private final ErrorHandlingService errorHandlingService;
@Override
public Mono<ResponseEntity<PolicyObjectInformation>> createPolicy(Mono<PolicyObjectInformation> policyObjectInformation, ServerWebExchange exchange) {
return policyObjectInformation.flatMap(policyObjectInfo -> policyService.createPolicyService(policyObjectInfo, exchange)
- .doOnError(error -> errorHandlingService.handleError(error)));
+ .doOnError(errorHandlingService::handleError));
}
@Override
public Mono<ResponseEntity<Void>> deletePolicy(String policyId, String accept, ServerWebExchange exchange) throws Exception {
return policyService.deletePolicyService(policyId, exchange)
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
public Mono<ResponseEntity<Object>> getPolicy(String policyId, String accept, ServerWebExchange exchange) throws Exception {
return policyService.getPolicyService(policyId, exchange)
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
- public Mono<ResponseEntity<Flux<PolicyInformation>>> getPolicyIds(String policyTypeId, String nearRtRicId, String serviceId, String typeName, String accept, ServerWebExchange exchange) throws Exception {
+ public Mono<ResponseEntity<Flux<PolicyInformation>>> getAllPolicies(String policyTypeId, String nearRtRicId, String serviceId, String typeName, String accept, ServerWebExchange exchange) throws Exception {
return policyService.getPolicyIdsService(policyTypeId, nearRtRicId, serviceId, typeName, exchange)
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
public Mono<ResponseEntity<Object>> getPolicyTypeDefinition(String policyTypeId, String accept, ServerWebExchange exchange) throws Exception {
return policyService.getPolicyTypeDefinitionService(policyTypeId)
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
public Mono<ResponseEntity<Flux<PolicyTypeInformation>>> getPolicyTypes(String nearRtRicId, String typeName, String compatibleWithVersion, String accept, ServerWebExchange exchange) throws Exception {
return policyService.getPolicyTypesService(nearRtRicId, typeName, compatibleWithVersion, exchange)
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
public Mono<ResponseEntity<Object>> putPolicy(String policyId, Mono<Object> body, ServerWebExchange exchange) throws Exception {
return body.flatMap(payload -> policyService.putPolicyService(policyId, payload, exchange))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
}
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v3;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v3.NearRtRicRepositoryApi;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts;
import org.onap.ccsdk.oran.a1policymanagementservice.mappers.v3.RicRepositoryMapper;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.RicInfo;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.RicInfoList;
import org.onap.ccsdk.oran.a1policymanagementservice.service.v3.ErrorHandlingService;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
-@RestController("RicRepositoryControllerV3")
+@RestController("ricRepositoryControllerV3")
+@RequiredArgsConstructor
@Tag(
name = RicRepositoryControllerV3.API_NAME,
description = RicRepositoryControllerV3.API_DESCRIPTION
public static final String API_NAME = "NearRT-RIC Repository V3";
public static final String API_DESCRIPTION = "API used to get the NearRT-RIC for the managed element";
- @Autowired
- private RicRepositoryController ricRepositoryController;
- @Autowired
- private RicRepositoryMapper ricRepositoryMapper;
+ private final RicRepositoryController ricRepositoryController;
- @Autowired
- ErrorHandlingService errorHandlingService;
+ private final RicRepositoryMapper ricRepositoryMapper;
+
+ private final ErrorHandlingService errorHandlingService;
@Override
public Mono<ResponseEntity<RicInfo>> getRic(String managedElementId, String ricId, String accept, ServerWebExchange exchange) throws Exception {
return ricRepositoryController.getRic(managedElementId, ricId, exchange)
.map(responseEntity -> new ResponseEntity<>(ricRepositoryMapper.toRicInfoV3(responseEntity.getBody()), responseEntity.getStatusCode()))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
public Mono<ResponseEntity<RicInfoList>> getRics(String policyTypeId, String accept, ServerWebExchange exchange) throws Exception {
return ricRepositoryController.getRics(policyTypeId, exchange)
.map(responseEntity -> new ResponseEntity<>(ricRepositoryMapper.toRicInfoListV3(responseEntity.getBody()), responseEntity.getStatusCode()))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
}
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v3;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v3.ServiceRegistryAndSupervisionApi;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.ServiceController;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.ServiceRegistrationInfo;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.ServiceStatusList;
import org.onap.ccsdk.oran.a1policymanagementservice.service.v3.ErrorHandlingService;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
-@RestController("ServiceControllerV3")
+@RestController("serviceControllerV3")
+@RequiredArgsConstructor
@Tag( //
name = ServiceControllerV3.API_NAME, //
description = ServiceControllerV3.API_DESCRIPTION //
public static final String API_NAME = "Service Registry and Supervision";
public static final String API_DESCRIPTION = "API used to keep the service Alive with in the timeout period";
- @Autowired
- private ServiceController serviceController;
+ private final ServiceController serviceController;
- @Autowired
- private ServiceControllerMapper serviceControllerMapper;
+ private final ServiceControllerMapper serviceControllerMapper;
- @Autowired
- ErrorHandlingService errorHandlingService;
+ private final ErrorHandlingService errorHandlingService;
@Override
public Mono<ResponseEntity<Object>> deleteService(String serviceId, String accept, ServerWebExchange exchange) throws Exception {
return serviceController.getServices(serviceId, exchange)
.map(responseEntity -> new ResponseEntity<>(serviceControllerMapper.toServiceStatusListV3(
responseEntity.getBody()), responseEntity.getStatusCode()))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
@Override
@Override
public Mono<ResponseEntity<Object>> putService(Mono<ServiceRegistrationInfo> serviceRegistrationInfo, ServerWebExchange exchange) throws Exception {
- return serviceController.putService(serviceRegistrationInfo.map(serviceRegistrationInfoV2 ->
- serviceControllerMapper.toServiceRegistrationInfoV2(serviceRegistrationInfoV2)), exchange)
- .doOnError(error -> errorHandlingService.handleError(error));
+ return serviceController.putService(serviceRegistrationInfo.map(serviceControllerMapper::toServiceRegistrationInfoV2), exchange)
+ .doOnError(errorHandlingService::handleError);
}
}
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v3;
import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.api.v3.HealthCheckApi;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts;
-import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.RicRepositoryController;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.StatusController;
import org.onap.ccsdk.oran.a1policymanagementservice.mappers.v3.StatusControllerMapper;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.StatusInfo;
import org.onap.ccsdk.oran.a1policymanagementservice.service.v3.ErrorHandlingService;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
-@RestController("StatusControllerV3")
+@RestController("statusControllerV3")
+@RequiredArgsConstructor
@Tag( //
name = StatusControllerV3.API_NAME, //
description = StatusControllerV3.API_DESCRIPTION //
public static final String API_NAME = "Health Check";
public static final String API_DESCRIPTION = "API used to get the health status and statistics of this service";
- @Autowired
- private StatusController statusController;
- @Autowired
- private StatusControllerMapper statusControllerMapper;
+ private final StatusController statusController;
- @Autowired
- ErrorHandlingService errorHandlingService;
+ private final StatusControllerMapper statusControllerMapper;
+
+ private final ErrorHandlingService errorHandlingService;
@Override
public Mono<ResponseEntity<StatusInfo>> getStatus(ServerWebExchange exchange) throws Exception {
return statusController.getStatus(exchange)
.map(statusInfoResponseEntity -> new ResponseEntity<>(statusControllerMapper.toStatusInfoV3
(statusInfoResponseEntity.getBody()), statusInfoResponseEntity.getStatusCode()))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
}
return Mono.fromFuture(future) //
.map(f -> s3Bucket) //
.doOnError(t -> logger.debug("Could not create S3 bucket: {}", t.getMessage()))
- .onErrorResume(t -> Mono.just(s3Bucket));
+ .onErrorResume(t -> Mono.just("Not Created"));
}
@Override
package org.onap.ccsdk.oran.a1policymanagementservice.service.v3;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.authorization.AuthorizationCheck;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.authorization.PolicyAuthorizationRequest.Input.AccessType;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Service
+@RequiredArgsConstructor
public class AuthorizationService {
- @Autowired
- private AuthorizationCheck authorization;
+ private final AuthorizationCheck authorization;
public Mono<Policy> authCheck (ServerWebExchange serverWebExchange, Policy policy, AccessType accessType){
return authorization.doAccessControl(serverWebExchange.getRequest().getHeaders().toSingleValueMap(),
package org.onap.ccsdk.oran.a1policymanagementservice.service.v3;
-import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.PolicyController;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.ProblemDetails;
import org.slf4j.Logger;
package org.onap.ccsdk.oran.a1policymanagementservice.service.v3;
import com.google.gson.Gson;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.authorization.PolicyAuthorizationRequest.Input.AccessType;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts;
import org.onap.ccsdk.oran.a1policymanagementservice.util.v3.Helper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import java.util.Map;
@Service
+@RequiredArgsConstructor
public class PolicyService {
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- @Autowired
- private Helper helper;
-
- @Autowired
- private Rics rics;
-
- @Autowired
- private PolicyTypes policyTypes;
-
- @Autowired
- private Policies policies;
-
- @Autowired
- private AuthorizationService authorizationService;
-
- @Autowired
- private A1ClientFactory a1ClientFactory;
-
- @Autowired
- private ErrorHandlingService errorHandlingService;
-
- @Autowired
- private Gson gson;
+ private final Helper helper;
+ private final Rics rics;
+ private final PolicyTypes policyTypes;
+ private final Policies policies;
+ private final AuthorizationService authorizationService;
+ private final A1ClientFactory a1ClientFactory;
+ private final ErrorHandlingService errorHandlingService;
+ private final Gson gson;
public Mono<ResponseEntity<PolicyObjectInformation>> createPolicyService
(PolicyObjectInformation policyObjectInfo, ServerWebExchange serverWebExchange) {
PolicyType policyType = policyTypes.getType(policyObjectInfo.getPolicyTypeId());
Policy policy = helper.buildPolicy(policyObjectInfo, policyType, ric, helper.policyIdGeneration(policyObjectInfo));
return helper.isPolicyAlreadyCreated(policy,policies)
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(policyBuilt -> authorizationService.authCheck(serverWebExchange, policy, AccessType.WRITE)
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(policyNotUsed -> ric.getLock().lock(Lock.LockType.SHARED, "createPolicy"))
.flatMap(grant -> postPolicy(policy, grant))
.map(locationHeaderValue ->
new ResponseEntity<PolicyObjectInformation>(policyObjectInfo,helper.createHttpHeaders(
"location",helper.buildURI(policy.getId(), serverWebExchange)), HttpStatus.CREATED))
- .doOnError(error -> errorHandlingService.handleError(error)));
+ .doOnError(errorHandlingService::handleError));
} catch (Exception ex) {
return Mono.error(ex);
}
private Mono<String> postPolicy(Policy policy, Lock.Grant grant) {
return helper.checkRicStateIdle(policy.getRic())
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(ric -> helper.checkSupportedType(ric, policy.getType()))
- .doOnError(error -> errorHandlingService.handleError(error))
- .flatMap(ric -> a1ClientFactory.createA1Client(ric))
+ .doOnError(errorHandlingService::handleError)
+ .flatMap(a1ClientFactory::createA1Client)
.flatMap(a1Client -> a1Client.putPolicy(policy))
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.doOnNext(policyString -> policies.put(policy))
.doFinally(releaseLock -> grant.unlockBlocking())
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
public Mono<ResponseEntity<Object>> putPolicyService(String policyId, Object body, ServerWebExchange exchange) {
Policy updatedPolicy = helper.buildPolicy(pos, existingPolicy.getType(), existingPolicy.getRic(), policyId);
Ric ric = existingPolicy.getRic();
return authorizationService.authCheck(exchange, updatedPolicy, AccessType.WRITE)
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(policy -> ric.getLock().lock(Lock.LockType.SHARED, "updatePolicy"))
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(grant -> postPolicy(updatedPolicy, grant))
.map(header -> new ResponseEntity<Object>(policies.get(updatedPolicy.getId()).getJson(), HttpStatus.OK))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
} catch(Exception ex) {
return Mono.error(ex);
}
Policy policy = policies.getPolicy(policyId);
return authorizationService.authCheck(serverWebExchange, policy, AccessType.READ)
.map(x -> new ResponseEntity<Object>(policy.getJson(), HttpStatus.OK))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
public Mono<ResponseEntity<Object>> getPolicyTypeDefinitionService(String policyTypeId)
throws EntityNotFoundException {
Policy singlePolicy = policies.getPolicy(policyId);
return authorizationService.authCheck(serverWebExchange, singlePolicy, AccessType.WRITE)
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(policy -> policy.getRic().getLock().lock(Lock.LockType.SHARED, "deletePolicy"))
.flatMap(grant -> deletePolicy(singlePolicy, grant))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
private Mono<ResponseEntity<Void>> deletePolicy(Policy policy, Lock.Grant grant) {
return helper.checkRicStateIdle(policy.getRic())
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.flatMap(ric -> helper.checkSupportedType(ric, policy.getType()))
- .doOnError(error -> errorHandlingService.handleError(error))
- .flatMap(ric -> a1ClientFactory.createA1Client(ric))
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
+ .flatMap(a1ClientFactory::createA1Client)
+ .doOnError(errorHandlingService::handleError)
.flatMap(a1Client -> a1Client.deletePolicy(policy))
- .doOnError(error -> errorHandlingService.handleError(error))
+ .doOnError(errorHandlingService::handleError)
.doOnNext(policyString -> policies.remove(policy))
.doFinally(releaseLock -> grant.unlockBlocking())
.map(successResponse -> new ResponseEntity<Void>(HttpStatus.NO_CONTENT))
- .doOnError(error -> errorHandlingService.handleError(error));
+ .doOnError(errorHandlingService::handleError);
}
}
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
+import lombok.RequiredArgsConstructor;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.PolicyInformation;
import org.onap.ccsdk.oran.a1policymanagementservice.models.v3.PolicyObjectInformation;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import java.util.stream.Collectors;
@Component
+@RequiredArgsConstructor
public class Helper {
- @Autowired
- private Services services;
+ private final Services services;
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private static Gson gson = new GsonBuilder().create();
+ private static final Gson gson = new GsonBuilder().create();
+
public void keepServiceAlive(String name) {
Service s = this.services.get(name);
if (s != null) {
package org.onap.ccsdk.oran.a1policymanagementservice.clients;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
@DisplayName("test Custom Adapter Creation")
void testCustomAdapterCreation() {
- Ric ric = new Ric(ricConfig("", CustomA1AdapterFactory.class.getName()));
- A1Client client = factoryUnderTest.createA1Client(ric).block();
-
+ Ric ricLocal = new Ric(ricConfig("", CustomA1AdapterFactory.class.getName()));
+ A1Client client = factoryUnderTest.createA1Client(ricLocal).block();
+ assertNotNull(client);
assertEquals(client.getClass(), StdA1ClientVersion2.class);
- ric = new Ric(ricConfig("", "org.onap.ccsdk.oran.a1policymanagementservice.clients.StdA1ClientVersion2"));
- client = factoryUnderTest.createA1Client(ric).block();
-
+ ricLocal = new Ric(ricConfig("", "org.onap.ccsdk.oran.a1policymanagementservice.clients.StdA1ClientVersion2"));
+ client = factoryUnderTest.createA1Client(ricLocal).block();
+ assertNotNull(client);
assertEquals(client.getClass(), StdA1ClientVersion2.class);
- ric = new Ric(
+ ricLocal = new Ric(
ricConfig("", "org.onap.ccsdk.oran.a1policymanagementservice.clients.StdA1ClientVersion2$Factory"));
- client = factoryUnderTest.createA1Client(ric).block();
-
+ client = factoryUnderTest.createA1Client(ricLocal).block();
+ assertNotNull(client);
assertEquals(client.getClass(), StdA1ClientVersion2.class);
Exception e = Assertions.assertThrows(Exception.class, () -> {
import static org.assertj.core.api.Assertions.assertThat;
-import io.micrometer.prometheus.PrometheusConfig;
-import io.micrometer.prometheus.PrometheusMeterRegistry;
+import io.micrometer.prometheusmetrics.PrometheusConfig;
+import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
import java.time.Instant;
import java.util.Arrays;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
import java.lang.invoke.MethodHandles;
import java.nio.charset.StandardCharsets;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.TestPropertySource;
import org.springframework.util.FileSystemUtils;
-import org.springframework.web.reactive.function.client.WebClientRequestException;
import org.springframework.web.reactive.function.client.WebClientResponseException;
import reactor.core.publisher.Mono;
@Autowired
OpenPolicyAgentSimulatorController openPolicyAgentSimulatorController;
- private static Gson gson = new GsonBuilder().create();
-
/**
* Overrides the BeanFactory.
*/
}
@Test
- @SuppressWarnings("squid:S2925") // "Thread.sleep" should not be used in tests.
@DisplayName("test ZZ Actuator")
void testZZActuator() throws Exception {
// The test must be run last, hence the "ZZ" in the name. All succeeding tests
client.post("/actuator/loggers/org.springframework.boot.actuate", "{\"configuredLevel\":\"trace\"}").block();
// This will stop the web server and all coming tests will fail.
- client.post("/actuator/shutdown", "").block();
-
- Thread.sleep(1000);
-
- StepVerifier.create(restClient().get("/rics")) // Any call
- .expectSubscription() //
- .expectErrorMatches(t -> t instanceof WebClientRequestException) //
- .verify();
-
+ ResponseEntity<String> entity = client.postForEntity("/actuator/shutdown", "").block();
+ assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
+ assertThat(((String) entity.getBody())).contains("Shutting down");
}
@Test
waitforS3();
{
- Policies policies = new Policies(this.applicationConfig);
- policies.restoreFromDatabase(ric, this.policyTypes).blockLast();
- assertThat(policies.size()).isEqualTo(noOfPolicies);
+ Policies policiesLocal = new Policies(this.applicationConfig);
+ policiesLocal.restoreFromDatabase(ric, this.policyTypes).blockLast();
+ assertThat(policiesLocal.size()).isEqualTo(noOfPolicies);
}
{
restClient().delete("/policies/id2").block();
- Policies policies = new Policies(this.applicationConfig);
- policies.restoreFromDatabase(ric, this.policyTypes).blockLast();
- assertThat(policies.size()).isEqualTo(noOfPolicies - 1);
+ Policies policiesAfterDelete = new Policies(this.applicationConfig);
+ policiesAfterDelete.restoreFromDatabase(ric, this.policyTypes).blockLast();
+ assertThat(policiesAfterDelete.size()).isEqualTo(noOfPolicies - 1);
}
}
@Test
@DisplayName("test Get Rics")
- void testGetRics() throws Exception {
+ void testGetRics() throws JsonProcessingException {
addRic("ric1");
this.addPolicyType("type1", "ric1");
String url = "/rics?policytype_id=type1";
@Test
@DisplayName("test Get Policy Types")
- void testGetPolicyTypes() throws Exception {
+ void testGetPolicyTypes() throws JsonProcessingException {
String TYPE_ID_1 = "A_type1_1.9.0";
String TYPE_ID_2 = "A_type1_2.0.0";
String TYPE_ID_3 = "A_type1_1.5.0";
assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
// DELETE service
+ addPolicy("id1", "type1", serviceName);
assertThat(services.size()).isEqualTo(1);
url = "/services/" + serviceName;
restClient().delete(url).block();
testErrorCode(restClient().get("/services?service_id=XXX"), HttpStatus.NOT_FOUND);
}
+ @Test
+ @DisplayName("test delete Service with no authorization")
+ void testDeleteServiceWithNoAuth() throws Exception {
+ // PUT service
+ String serviceName = "ac.dc";
+ putService(serviceName, 0, HttpStatus.CREATED);
+
+ // No Authorization to Delete
+ this.applicationConfig
+ .setAuthProviderUrl(baseUrl() + OpenPolicyAgentSimulatorController.ACCESS_CONTROL_URL_REJECT);
+ addPolicy("id1", "type1", serviceName);
+ assertThat(services.size()).isEqualTo(1);
+ String url = "/services/" + serviceName;
+ restClient().delete(url).block();
+ assertThat(services.size()).isZero();
+ assertThat(policies.size()).isEqualTo(1);
+ testErrorCode(restClient().get("/policies/id1"), HttpStatus.UNAUTHORIZED);
+ }
+
+ @Test
+ @DisplayName("test delete Service with no service")
+ void testDeleteServiceWithNoService() {
+ String url = "/services/" + "NoService";
+ testErrorCode(restClient().delete(url), HttpStatus.NOT_FOUND);
+ }
+
@Test
@DisplayName("test Service Supervision")
- void testServiceSupervision() throws Exception {
+ void testServiceSupervision() throws JsonProcessingException {
putService("service1", 2, HttpStatus.CREATED);
addPolicyType("type1", "ric1");
assertThat(test.isFailed()).isFalse();
}
assertThat(policies.size()).isZero();
- logger.info("Concurrency test took " + Duration.between(startTime, Instant.now()));
+ logger.info("Concurrency test took: {}", Duration.between(startTime, Instant.now()));
assertThat(nonRespondingRic.getState()).isEqualTo(RicState.UNAVAILABLE);
nonRespondingRic.setState(RicState.AVAILABLE);
System.out.println(Thread.currentThread() + result.getBody());
} catch (Exception e) {
- logger.error(Thread.currentThread() + "Concurrency test printStatusInfo exception " + e.toString());
+ logger.error("{} Concurrency test printStatusInfo exception {}", Thread.currentThread(), e.toString());
}
}
deletePolicy(name + "-");
}
} catch (Exception e) {
- logger.error("Concurrency test exception " + e.toString());
+ logger.error("Concurrency test exception {}", e.toString());
printStatusInfo();
failed = true;
}
}
private String configAsString() throws Exception {
- File configFile =
+ File configFileLocal =
new File(getClass().getClassLoader().getResource("test_application_configuration.json").getFile());
- return FileUtils.readFileToString(configFile, "UTF-8");
+ return FileUtils.readFileToString(configFileLocal, "UTF-8");
}
@Test
@DisplayName("put Invalid Configuration should Return Error 400")
- void putInvalidConfiguration_shouldReturnError400() throws Exception {
+ void putInvalidConfiguration_shouldReturnError400() {
String url = "a1-policy/v2/configuration";
// Valid JSON but invalid configuration.
testHelper.testSuccessResponse(responseMonoGet, HttpStatus.OK, responseBody ->
responseBody.contains("{\"scope\":{\"ueId\":\"ue5100\",\"qosId\":\"qos5100\"},\"qosObjectives\":{\"priorityLevel\":5100.0}}"));
}
+
+ @Test
+ @DisplayName("test get all Policies")
+ void testGetAllPolicies() throws Exception {
+ String nonRtRicIdOne = "ric.11";
+ String nonRtRicIdTwo = "ric.22";
+ String policyTypeName = "type1_1.2.3";
+ String url = "/policies";
+ testHelper.addPolicyType(policyTypeName, nonRtRicIdOne);
+ String policyBodyOne = testHelper.postPolicyBody(nonRtRicIdOne, policyTypeName, "policyOne");
+ testHelper.addPolicyType(policyTypeName, nonRtRicIdTwo);
+ String policyBodyTwo = testHelper.postPolicyBody(nonRtRicIdTwo, policyTypeName, "policyTwo");
+ testHelper.restClientV3().postForEntity(url, policyBodyOne).block();
+ testHelper.restClientV3().postForEntity(url, policyBodyTwo).block();
+ Mono<ResponseEntity<String>> responseMonoGet = testHelper.restClientV3().getForEntity(url);
+ testHelper.testSuccessResponse(responseMonoGet, HttpStatus.OK, responseBody ->
+ responseBody.contains("[{\"policyId\":\"policyTwo\",\"nearRtRicId\":\"ric.22\"},{\"policyId\":\"policyOne\",\"nearRtRicId\":\"ric.11\"}]"));
}
+
+ @Test
+ @DisplayName("test get PolicyType")
+ void testGetPolicyType() throws Exception {
+ String nonRtRicId = "ric.1";
+ String policyTypeName = "type1_1.2.3";
+ String url = "/policy-types";
+ testHelper.addPolicyType(policyTypeName, nonRtRicId);
+ Mono<ResponseEntity<String>> responseMonoGet = testHelper.restClientV3().getForEntity(url+"/" +policyTypeName);
+ testHelper.testSuccessResponse(responseMonoGet, HttpStatus.OK, responseBody -> !(responseBody.isEmpty()));
+ }
+
+ @Test
+ @DisplayName("test get All PolicyTypes")
+ void testGetAllPolicyTypes() throws Exception {
+ String nonRtRicId = "ric.1";
+ String policyTypeName = "type1_1.2.3";
+ String url = "/policy-types";
+ testHelper.addPolicyType(policyTypeName, nonRtRicId);
+ Mono<ResponseEntity<String>> responseMonoGet = testHelper.restClientV3().getForEntity(url);
+ testHelper.testSuccessResponse(responseMonoGet, HttpStatus.OK, responseBody -> responseBody.contains(
+ "{\"policyTypeId\":\"type1_1.2.3\",\"nearRtRicId\":\"ric.1\"}]"
+ ));
+ }
+
+ @Test
+ @DisplayName("test update Policy")
+ void testUpdatePolicy() throws Exception {
+ String nonRtRicId = "ric.1";
+ String policyTypeName = "type1_1.2.3";
+ String url = "/policies";
+ testHelper.addPolicyType(policyTypeName, nonRtRicId);
+ String policyBodyForPost = testHelper.postPolicyBody(nonRtRicId, policyTypeName, "policyOne");
+ testHelper.restClientV3().postForEntity(url, policyBodyForPost).block();
+ String policyBodyForPut = testHelper.putPolicyBody(nonRtRicId, policyTypeName, "policyOne", "ue5200",
+ "qos5200", "5200.0");
+ testHelper.restClientV3().putForEntity(url+"/policyOne", policyBodyForPut).block();
+ Mono<ResponseEntity<String>> responseMonoGet = testHelper.restClientV3().getForEntity(url+"/policyOne");
+ testHelper.testSuccessResponse(responseMonoGet, HttpStatus.OK, responseBody ->
+ responseBody.contains("{\"scope\":{\"ueId\":\"ue5200\",\"qosId\":\"qos5200\"},\"qosObjectives\":{\"priorityLevel\":5200.0}"));
+ }
+}
\ No newline at end of file
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.ccsdk.oran.a1policymanagementservice.datastore;
+
+import org.junit.jupiter.api.*;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.reactivestreams.Publisher;
+import org.springframework.boot.test.system.CapturedOutput;
+import org.springframework.boot.test.system.OutputCaptureExtension;
+import org.testcontainers.containers.localstack.LocalStackContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.DockerImageName;
+import reactor.test.StepVerifier;
+
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
+import java.util.function.Predicate;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@Testcontainers
+@ExtendWith({MockitoExtension.class, OutputCaptureExtension.class})
+@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
+class S3ObjectStoreTest {
+
+ static ApplicationConfig appConfig;
+ private static S3ObjectStore s3ObjectStore;
+ private static final String bucketName = "s3bucket";
+
+ @Container
+ private static final LocalStackContainer localstack =
+ new LocalStackContainer(DockerImageName.parse("localstack/localstack:0.11.3"))
+ .withServices(LocalStackContainer.Service.S3);
+
+ @BeforeAll
+ static void init() {
+ appConfig = mock(ApplicationConfig.class);
+ when(appConfig.isS3Enabled()).thenReturn(Boolean.TRUE);
+ when(appConfig.getS3EndpointOverride()).thenReturn(localstack.getEndpoint().toString());
+ when(appConfig.getS3AccessKeyId()).thenReturn(localstack.getAccessKey());
+ when(appConfig.getS3SecretAccessKey()).thenReturn(localstack.getSecretKey());
+ when(appConfig.getS3Bucket()).thenReturn(bucketName);
+ s3ObjectStore = new S3ObjectStore(appConfig, "location");
+ }
+ @Test
+ @Order(1)
+ void testGetS3AsynchClient() {
+ assertNotNull(s3ObjectStore);
+ }
+
+ @Test
+ @Order(2)
+ void testCreateAndDeleteS3BucketSuccess(CapturedOutput capturedOutput) {
+
+ testSuccess(s3ObjectStore.createDataStore(), actual -> actual.equals(bucketName));
+ assertFalse(capturedOutput.getOut().contains("Could not create S3 bucket:"));
+
+ testSuccess(s3ObjectStore.deleteBucket(), actual -> actual.equals(bucketName));
+ }
+
+ @Test
+ @Order(3)
+ void testWriteAndReadAndDeleteObjectSuccess(CapturedOutput capturedOutput) {
+
+ testSuccess(s3ObjectStore.createDataStore(), actual -> actual.equals(bucketName));
+ byte[] fileData = "testData".getBytes(StandardCharsets.UTF_8);
+ new String(fileData);
+ testSuccess(s3ObjectStore.writeObject("test", fileData),
+ actual -> Arrays.equals(actual, fileData));
+ assertFalse(capturedOutput.getOut().contains("Failed to store object"));
+ testSuccess(s3ObjectStore.readObject("test"),
+ actual -> Arrays.equals(actual, fileData));
+ testSuccess(s3ObjectStore.deleteAllObjects(), actual -> actual.equals("OK"));
+ }
+
+ @Test
+ @Order(4)
+ void testListObjectsSuccess() {
+
+ s3ObjectStore.createDataStore().block();
+ String objectName = "test";
+ byte[] fileData = "testData".getBytes(StandardCharsets.UTF_8);
+ testSuccess(s3ObjectStore.writeObject(objectName, fileData),
+ actual -> Arrays.equals(actual, fileData));
+ testSuccess(s3ObjectStore.listObjects(""), actual -> actual.equals(objectName));
+ }
+
+ @Test
+ @Order(5)
+ void testCreateAndDeleteS3BucketError(CapturedOutput capturedOutput) {
+
+ when(appConfig.getS3Bucket()).thenReturn("S3Bucket");
+
+ testFailure(s3ObjectStore.createDataStore(), actual -> actual.equals("Not Created"));
+
+ testFailure(s3ObjectStore.deleteBucket(), actual -> actual.equals("NOK"));
+ assertTrue(capturedOutput.getOut().contains("Could not delete bucket:"));
+ }
+
+ <T> void testSuccess(Publisher<T> publisher, Predicate<T> equalityCheck) {
+ StepVerifier.create(publisher)
+ .expectNextMatches(equalityCheck)
+ .verifyComplete();
+ }
+
+ <T> void testFailure(Publisher<T> publisher, Predicate<T> equalityCheck) {
+ StepVerifier.create(publisher)
+ .expectNextMatches(equalityCheck)
+ .verifyComplete();
+ }
+}
package org.onap.ccsdk.oran.a1policymanagementservice.repository;
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.awaitility.Awaitility.await;
-
-import java.io.IOException;
-import java.lang.invoke.MethodHandles;
-
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.junit.jupiter.MockitoExtension;
-import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;
+import java.lang.invoke.MethodHandles;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
@ExtendWith(MockitoExtension.class)
class LockTest {
@Test
@DisplayName("test Lock")
- void testLock() throws IOException, ServiceException {
+ void testLock() {
Lock lock = new Lock("l1");
Lock.Grant grant = lock.lockBlocking(LockType.SHARED, "test");
grant.unlockBlocking();
package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.Mockito.atLeastOnce;
-import static org.mockito.Mockito.doReturn;
-import static org.mockito.Mockito.spy;
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
-
import com.google.common.base.Charsets;
import com.google.common.io.Resources;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
-
-import java.io.IOException;
-import java.net.URL;
-import java.time.Duration;
-import java.util.Arrays;
-import java.util.Optional;
-import java.util.Properties;
-
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser.ConfigParserResult;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
-import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
-
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.*;
import reactor.test.StepVerifier;
+import java.io.IOException;
+import java.net.URL;
+import java.time.Duration;
+import java.util.Arrays;
+import java.util.Optional;
+import java.util.Properties;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.*;
+
@ExtendWith(MockitoExtension.class)
class RefreshConfigTaskTest {
@Mock
ConfigurationFile configurationFileMock;
- private RefreshConfigTask createTestObject(boolean configFileExists) {
- return createTestObject(configFileExists, spy(new Rics()), new Policies(appConfig), true);
+ private RefreshConfigTask createTestObject(boolean stubConfigFileExists) {
+ return createTestObject(spy(new Rics()), new Policies(appConfig), stubConfigFileExists);
}
- private RefreshConfigTask createTestObject(boolean configFileExists, Rics rics, Policies policies,
+ private RefreshConfigTask createTestObject(Rics rics, Policies policies,
boolean stubConfigFileExists) {
SecurityContext secContext = new SecurityContext("");
assertThat(ricConfigs).isNotNull().hasSize(2);
}
+ @Test
+ @DisplayName("test handle updated ric config method with type removed")
+ void testHandleUpdatedRicConfigRemoved() {
+
+ String ricId = "ric1";
+ refreshTaskUnderTest = this.createTestObject(false);
+ refreshTaskUnderTest.handleUpdatedRicConfig(buildRicConfigUpdate(ricId, "ric_baseurl_removed",
+ Type.REMOVED));
+ verify(refreshTaskUnderTest.rics, times(1)).remove(anyString());
+ }
+
+ @Test
+ @DisplayName("test handle updated ric config method with type changed and no ric available before")
+ void testHandleUpdatedRicConfigNullRicChanged() {
+
+ String ricId = "ric1";
+ refreshTaskUnderTest = this.createTestObject(false);
+ refreshTaskUnderTest.handleUpdatedRicConfig(buildRicConfigUpdate(ricId, "ric_baseurl_changed",
+ Type.CHANGED));
+ verify(refreshTaskUnderTest.rics, times(1)).put(any(Ric.class));
+ }
+
@Test
@DisplayName("test when File Exists But Json Is Incorrect then No Rics Are Put In Repository")
- void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() throws Exception {
+ void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() {
refreshTaskUnderTest = this.createTestObject(true);
// When
String string = Resources.toString(url, Charsets.UTF_8);
return Optional.of(JsonParser.parseString(string).getAsJsonObject());
}
+
+ private ApplicationConfig.RicConfigUpdate buildRicConfigUpdate(String ricID, String baseUrl,
+ Type event) {
+ return new ApplicationConfig.RicConfigUpdate(buildRicConfig(ricID, baseUrl), event);
+ }
+
+ private RicConfig buildRicConfig(String ricID, String baseUrl) {
+ return RicConfig.builder()
+ .ricId(ricID)
+ .baseUrl(baseUrl)
+ .build();
+ }
}
@Setter
private String errorInject;
- public MockA1Client(String ricId, ApplicationConfig appConfig, PolicyTypes policyTypes, Duration asynchDelay) {
+ public MockA1Client(ApplicationConfig appConfig, PolicyTypes policyTypes, Duration asynchDelay) {
this.policyTypes = policyTypes;
this.asynchDelay = asynchDelay;
ApplicationConfig cfg = spy(appConfig);
public MockA1Client getOrCreateA1Client(String ricId) {
if (!clients.containsKey(ricId)) {
logger.debug("Creating client for RIC: {}", ricId);
- MockA1Client client = spy(new MockA1Client(ricId, appConfig, policyTypes, asynchDelay));
+ MockA1Client client = spy(new MockA1Client(appConfig, policyTypes, asynchDelay));
clients.put(ricId, client);
}
return clients.get(ricId);
return gson.toJson(policyObjectInfo);
}
+ public String putPolicyBody(String nearRtRicId, String policyTypeName, String policyId, String ueId, String qosId,
+ String priorityLevel) {
+ PolicyObjectInformation policyObjectInfo = new PolicyObjectInformation(nearRtRicId, dummyPolicyObjectForPut(
+ ueId, qosId, priorityLevel), policyTypeName);
+ if (policyId != null && !policyId.isEmpty() && !policyId.isBlank())
+ policyObjectInfo.setPolicyId(policyId);
+ return gson.toJson(policyObjectInfo);
+ }
+
public PolicyObjectInformation policyObjectInfo(String nearRtRicId, String policyTypeName) {
return gson.fromJson(postPolicyBody(nearRtRicId, policyTypeName, ""), PolicyObjectInformation.class);
}
+ public JsonObject dummyPolicyObjectForPut(String... values) {
+ return JsonParser.parseString("{\n" +
+ " \"scope\": {\n" +
+ " \"ueId\": \"" + values[0] + "\",\n" +
+ " \"qosId\": \"" + values[1] + "\"\n" +
+ " },\n" +
+ " \"qosObjectives\": {\n" +
+ " \"priorityLevel\": " + values[2] + "\n" +
+ " }\n" +
+ " }").getAsJsonObject();
+ }
+
public JsonObject dummyPolicyObject() {
return JsonParser.parseString("{\n" +
" \"scope\": {\n" +
html_theme_options = {
"style_nav_header_background": "white",
"sticky_navigation": "False" }
-html_logo = "_static/logo_onap_2017.png"
+html_logo = "_static/logo_onap_2024.png"
html_favicon = "_static/favicon.ico"
html_static_path = ["_static"]
html_show_sphinx = False
<script>
// Script section to load models into a JS Var
var defs = {}
- defs["authorization_result"] = {
- "required" : [ "result" ],
- "type" : "object",
- "properties" : {
- "result" : {
- "type" : "boolean",
- "description" : "If true, the access is granted"
- }
- },
- "description" : "Result of authorization",
- "example" : {
- "result" : true
- }
+ defs["authorization_result"] = {\r
+ "required" : [ "result" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "result" : {\r
+ "type" : "boolean",\r
+ "description" : "If true, the access is granted"\r
+ }\r
+ },\r
+ "description" : "Result of authorization",\r
+ "example" : {\r
+ "result" : true\r
+ }\r
};
- defs["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"
- },
- "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"
+ defs["error_information"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "detail" : {\r
+ "type" : "string",\r
+ "description" : " A human-readable explanation specific to this occurrence of the problem.",\r
+ "example" : "Policy type not found"\r
+ },\r
+ "title" : {\r
+ "type" : "string",\r
+ "description" : "A specific error name",\r
+ "example" : "Not Found"\r
+ },\r
+ "status" : {\r
+ "type" : "integer",\r
+ "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ",\r
+ "format" : "int32",\r
+ "example" : 404\r
+ }\r
+ },\r
+ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807"\r
};
- defs["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"
+ defs["input"] = {\r
+ "required" : [ "access_type", "auth_token", "policy_type_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "access_type" : {\r
+ "type" : "string",\r
+ "description" : "Access type",\r
+ "enum" : [ "READ", "WRITE", "DELETE" ]\r
+ },\r
+ "auth_token" : {\r
+ "type" : "string",\r
+ "description" : "Authorization token"\r
+ },\r
+ "policy_type_id" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identifier"\r
+ }\r
+ },\r
+ "description" : "input"\r
};
- defs["Link"] = {
- "type" : "object",
- "properties" : {
- "templated" : {
- "type" : "boolean"
- },
- "href" : {
- "type" : "string"
- }
- }
+ defs["Link"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "templated" : {\r
+ "type" : "boolean"\r
+ },\r
+ "href" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
};
- defs["policy_authorization"] = {
- "required" : [ "input" ],
- "type" : "object",
- "properties" : {
- "input" : {
- "$ref" : "#/components/schemas/input"
- }
- },
- "description" : "Authorization request for A1 policy requests"
+ defs["policy_authorization"] = {\r
+ "required" : [ "input" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "input" : {\r
+ "$ref" : "#/components/schemas/input"\r
+ }\r
+ },\r
+ "description" : "Authorization request for A1 policy requests"\r
};
- defs["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" ]
- }
+ defs["policy_id_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "A list of policy identities",\r
+ "example" : {\r
+ "policy_ids" : [ "policy_ids", "policy_ids" ]\r
+ }\r
};
- defs["policy_info"] = {
- "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id", "service_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."
- },
- "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"
+ defs["policy_info"] = {\r
+ "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the target Near-RT RIC"\r
+ },\r
+ "policy_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy"\r
+ },\r
+ "transient" : {\r
+ "type" : "boolean",\r
+ "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",\r
+ "nullable" : false,\r
+ "example" : false,\r
+ "default" : false\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "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.",\r
+ "default" : ""\r
+ },\r
+ "policy_data" : {\r
+ "type" : "object",\r
+ "description" : "the configuration of the policy"\r
+ },\r
+ "status_notification_uri" : {\r
+ "type" : "string",\r
+ "description" : "Callback URI for policy status updates"\r
+ },\r
+ "policytype_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy type"\r
+ }\r
+ },\r
+ "description" : "Information for one A1-P Policy"\r
};
- defs["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"
+ defs["policy_info_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policies" : {\r
+ "type" : "array",\r
+ "description" : "List of policy information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of policy information"\r
};
- defs["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"
+ defs["policy_status_info"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "last_modified" : {\r
+ "type" : "string",\r
+ "description" : "timestamp, last modification time"\r
+ },\r
+ "status" : {\r
+ "type" : "object",\r
+ "description" : "the Policy status"\r
+ }\r
+ },\r
+ "description" : "Status for one A1-P Policy"\r
};
- defs["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"
+ defs["policy_type_definition"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_schema" : {\r
+ "type" : "object",\r
+ "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema"\r
+ }\r
+ },\r
+ "description" : "Contains policy type schema definition"\r
};
- defs["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"
+ defs["policy_type_id_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy type identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information about policy types"\r
};
- defs["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"
+ defs["ric_info"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the Near-RT RIC"\r
+ },\r
+ "managed_element_ids" : {\r
+ "type" : "array",\r
+ "description" : "O1 identities for managed entities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "O1 identities for managed entities"\r
+ }\r
+ },\r
+ "state" : {\r
+ "type" : "string",\r
+ "description" : "Represents the states for a Near-RT RIC",\r
+ "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ]\r
+ },\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "supported policy types",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "supported policy types"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information for a Near-RT RIC"\r
};
- defs["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"
+ defs["ric_info_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "rics" : {\r
+ "type" : "array",\r
+ "description" : "List of Near-RT RIC information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/ric_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of Near-RT RIC information"\r
};
- defs["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)"
+ defs["service_callback_info_v2"] = {\r
+ "required" : [ "event_type", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of a Near-RT RIC"\r
+ },\r
+ "event_type" : {\r
+ "type" : "string",\r
+ "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",\r
+ "enum" : [ "AVAILABLE" ]\r
+ }\r
+ },\r
+ "description" : "Information transferred as in Service callbacks (callback_url)"\r
};
- defs["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"
+ defs["service_registration_info"] = {\r
+ "required" : [ "service_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of Near-RT RIC state changes"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "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.",\r
+ "format" : "int64"\r
+ }\r
+ },\r
+ "description" : "Information for one service"\r
};
- defs["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"
- }
- }
+ defs["service_status"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of RIC synchronization"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "policy keep alive timeout",\r
+ "format" : "int64"\r
+ },\r
+ "time_since_last_activity_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "time since last invocation by the service",\r
+ "format" : "int64"\r
+ }\r
+ }\r
};
- defs["service_status_list"] = {
- "type" : "object",
- "properties" : {
- "service_list" : {
- "type" : "array",
- "description" : "List of service information",
- "items" : {
- "$ref" : "#/components/schemas/service_status"
- }
- }
- }
+ defs["service_status_list"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "service_list" : {\r
+ "type" : "array",\r
+ "description" : "List of service information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/service_status"\r
+ }\r
+ }\r
+ }\r
};
- defs["status_info"] = {
- "type" : "object",
- "properties" : {
- "status" : {
- "type" : "string",
- "description" : "status text"
- }
- }
+ defs["status_info"] = {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "status" : {\r
+ "type" : "string",\r
+ "description" : "status text"\r
+ }\r
+ }\r
};
var errs = {};
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
- <div class="app-desc">Version: 1.2.0</div>
+ <div class="app-desc">Version: 1.3.0</div>
<hr>
<div id="app-description" class="app-desc">
- <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>
+ <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for manageme
cnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>
</div>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Deleting the policy using the Policy's Policy ID.</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/a1-policy/v2/policies/{policy_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-deletePolicy-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
"http://localhost/a1-policy/v2/policies/{policy_id}"
</code></pre>
</div>
<h3 id="examples-A1PolicyManagement-deletePolicy-title-200"></h3>
<p id="examples-A1PolicyManagement-deletePolicy-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Not used`;
+ var responseA1PolicyManagement200_description = `OK - Policy deleted`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-deletePolicy-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-deletePolicy-title-423"></h3>
<p id="examples-A1PolicyManagement-deletePolicy-description-423" class="marked"></p>
<script>
- var responseA1PolicyManagement423_description = `Near-RT RIC is not operational`;
+ var responseA1PolicyManagement423_description = `Locked - HTTP Status code which can be used when the state is Locked`;
var responseA1PolicyManagement423_description_break = responseA1PolicyManagement423_description.indexOf('\n');
if (responseA1PolicyManagement423_description_break == -1) {
$("#examples-A1PolicyManagement-deletePolicy-title-423").text("Status: 423 - " + responseA1PolicyManagement423_description);
<input id='responses-A1PolicyManagement-deletePolicy-423-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-A1PolicyManagement-deletePolicy-title-204"></h3>
- <p id="examples-A1PolicyManagement-deletePolicy-description-204" class="marked"></p>
- <script>
- var responseA1PolicyManagement204_description = `Policy deleted`;
- var responseA1PolicyManagement204_description_break = responseA1PolicyManagement204_description.indexOf('\n');
- if (responseA1PolicyManagement204_description_break == -1) {
- $("#examples-A1PolicyManagement-deletePolicy-title-204").text("Status: 204 - " + responseA1PolicyManagement204_description);
- } else {
- $("#examples-A1PolicyManagement-deletePolicy-title-204").text("Status: 204 - " + responseA1PolicyManagement204_description.substring(0, responseA1PolicyManagement204_description_break));
- $("#examples-A1PolicyManagement-deletePolicy-description-204").html(responseA1PolicyManagement204_description.substring(responseA1PolicyManagement204_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-A1PolicyManagement-deletePolicy-204" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-deletePolicy-204-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-A1PolicyManagement-deletePolicy-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-deletePolicy-204-schema">
- <div id="responses-A1PolicyManagement-deletePolicy-schema-204" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-deletePolicy-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-deletePolicy-schema-204');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-deletePolicy-204-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-A1PolicyManagement-deletePolicy-title-404"></h3>
- <p id="examples-A1PolicyManagement-deletePolicy-description-404" class="marked"></p>
- <script>
- var responseA1PolicyManagement404_description = `Policy is not found`;
- var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
- if (responseA1PolicyManagement404_description_break == -1) {
- $("#examples-A1PolicyManagement-deletePolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
- } else {
- $("#examples-A1PolicyManagement-deletePolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description.substring(0, responseA1PolicyManagement404_description_break));
- $("#examples-A1PolicyManagement-deletePolicy-description-404").html(responseA1PolicyManagement404_description.substring(responseA1PolicyManagement404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-A1PolicyManagement-deletePolicy-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-deletePolicy-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-A1PolicyManagement-deletePolicy-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-deletePolicy-404-schema">
- <div id="responses-A1PolicyManagement-deletePolicy-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-deletePolicy-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-deletePolicy-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-deletePolicy-404-schema-data' type='hidden' value=''></input>
- </div>
- </div>
</article>
</div>
<hr>
<article id="api-A1PolicyManagement-getPolicy-0" data-group="User" data-name="getPolicy" data-version="0">
<div class="pull-left">
<h1>getPolicy</h1>
- <p>Returns a policy</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns a policy</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policies/{policy_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicy-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/policies/{policy_id}"
</code></pre>
</div>
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; // (default to null)
-// Returns a policy
[apiInstance getPolicyWith:policyId
completionHandler: ^(policy_info output, NSError* error) {
if (output) {
var policyId = policyId_example; // String | (default to null)
try {
- // Returns a policy
policy_info result = apiInstance.getPolicy(policyId);
Debug.WriteLine(result);
} catch (Exception e) {
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:
<h3 id="examples-A1PolicyManagement-getPolicy-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicy-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy found`;
+ var responseA1PolicyManagement200_description = `OK - Policy found`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicy-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-getPolicy-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicy-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Policy is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicy-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicy-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicy-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicy-404-schema">
- <div id="responses-A1PolicyManagement-getPolicy-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicy-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicy-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicy-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyIds-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
<h3 id="examples-A1PolicyManagement-getPolicyIds-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyIds-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy identities`;
+ var responseA1PolicyManagement200_description = `OK - Policy identities`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyIds-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-getPolicyIds-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyIds-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Near-RT RIC or type not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyIds-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyIds-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyIds-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyIds-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyIds-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyIds-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyIds-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyIds-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyIds-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<h3 id="examples-A1PolicyManagement-getPolicyInstances-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyInstances-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policies`;
+ var responseA1PolicyManagement200_description = `OK - Returns A1 Policies which matches the criteria`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyInstances-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-getPolicyInstances-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyInstances-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Near-RT RIC, policy type or service not found`;
+ var responseA1PolicyManagement404_description = `Not Found - Near-RT RIC, policy type or service not found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyInstances-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<article id="api-A1PolicyManagement-getPolicyStatus-0" data-group="User" data-name="getPolicyStatus" data-version="0">
<div class="pull-left">
<h1>getPolicyStatus</h1>
- <p>Returns a policy status</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns a policy status</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policies/{policy_id}/status</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyStatus-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/policies/{policy_id}/status"
</code></pre>
</div>
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; // (default to null)
-// Returns a policy status
[apiInstance getPolicyStatusWith:policyId
completionHandler: ^(policy_status_info output, NSError* error) {
if (output) {
var policyId = policyId_example; // String | (default to null)
try {
- // Returns a policy status
policy_status_info result = apiInstance.getPolicyStatus(policyId);
Debug.WriteLine(result);
} catch (Exception e) {
policyId = policyId_example # String | (default to null)
try:
- # Returns a policy status
api_response = api_instance.get_policy_status(policyId)
pprint(api_response)
except ApiException as e:
<h3 id="examples-A1PolicyManagement-getPolicyStatus-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyStatus-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy status`;
+ var responseA1PolicyManagement200_description = `OK - Policy status`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyStatus-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-getPolicyStatus-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyStatus-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Policy is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyStatus-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyStatus-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyStatus-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyStatus-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyStatus-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyStatus-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyStatus-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyStatus-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyStatus-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<article id="api-A1PolicyManagement-getPolicyTypeDefinition-0" data-group="User" data-name="getPolicyTypeDefinition" data-version="0">
<div class="pull-left">
<h1>getPolicyTypeDefinition</h1>
- <p>Returns a policy type definition</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns a policy type definition</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policy-types/{policytype_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/policy-types/{policytype_id}"
</code></pre>
</div>
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policytypeId = policytypeId_example; // (default to null)
-// Returns a policy type definition
[apiInstance getPolicyTypeDefinitionWith:policytypeId
completionHandler: ^(policy_type_definition output, NSError* error) {
if (output) {
var policytypeId = policytypeId_example; // String | (default to null)
try {
- // Returns a policy type definition
policy_type_definition result = apiInstance.getPolicyTypeDefinition(policytypeId);
Debug.WriteLine(result);
} catch (Exception e) {
policytypeId = policytypeId_example # String | (default to null)
try:
- # Returns a policy type definition
api_response = api_instance.get_policy_type_definition(policytypeId)
pprint(api_response)
except ApiException as e:
<h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `schema of the given policy type`;
+ var responseA1PolicyManagement200_description = `OK - schema of the given policy type`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Policy type is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyTypeDefinition-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyTypeDefinition-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyTypeDefinition-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyTypeDefinition-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyTypeDefinition-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyTypeDefinition-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyTypeDefinition-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyTypeDefinition-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<article id="api-A1PolicyManagement-getPolicyTypes-0" data-group="User" data-name="getPolicyTypes" data-version="0">
<div class="pull-left">
<h1>getPolicyTypes</h1>
- <p>Query policy type identities</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Query policy type identities</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/policy-types</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-getPolicyTypes-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
String *typeName = typeName_example; // Select types with the given type name (type identity has the format <typename_version>) (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
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
policy_type_id_list result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion);
Debug.WriteLine(result);
} catch (Exception e) {
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:
<h3 id="examples-A1PolicyManagement-getPolicyTypes-title-200"></h3>
<p id="examples-A1PolicyManagement-getPolicyTypes-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy type IDs`;
+ var responseA1PolicyManagement200_description = `OK - Policy Type IDs Found`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyTypes-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-getPolicyTypes-title-404"></h3>
<p id="examples-A1PolicyManagement-getPolicyTypes-description-404" class="marked"></p>
<script>
- var responseA1PolicyManagement404_description = `Near-RT RIC is not found`;
+ var responseA1PolicyManagement404_description = `Not Found`;
var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
if (responseA1PolicyManagement404_description_break == -1) {
$("#examples-A1PolicyManagement-getPolicyTypes-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
<ul id="responses-detail-A1PolicyManagement-getPolicyTypes-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-getPolicyTypes-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-A1PolicyManagement-getPolicyTypes-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-getPolicyTypes-404-schema">
- <div id="responses-A1PolicyManagement-getPolicyTypes-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-getPolicyTypes-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-getPolicyTypes-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-getPolicyTypes-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<article id="api-A1PolicyManagement-putPolicy-0" data-group="User" data-name="putPolicy" data-version="0">
<div class="pull-left">
<h1>putPolicy</h1>
- <p>Create or update a policy</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Create or update a policy</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/policies</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-A1PolicyManagement-putPolicy-0-curl">
<pre class="prettyprint"><code class="language-bsh">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 ''
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
PolicyInfo *policyInfo = ; //
-// Create or update a policy
[apiInstance putPolicyWith:policyInfo
completionHandler: ^(Object output, NSError* error) {
if (output) {
var policyInfo = new PolicyInfo(); // PolicyInfo |
try {
- // Create or update a policy
Object result = apiInstance.putPolicy(policyInfo);
Debug.WriteLine(result);
} catch (Exception e) {
policyInfo = # PolicyInfo |
try:
- # Create or update a policy
api_response = api_instance.put_policy(policyInfo)
pprint(api_response)
except ApiException as e:
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
<h3 id="examples-A1PolicyManagement-putPolicy-title-200"></h3>
<p id="examples-A1PolicyManagement-putPolicy-description-200" class="marked"></p>
<script>
- var responseA1PolicyManagement200_description = `Policy updated`;
+ var responseA1PolicyManagement200_description = `OK - Policy updated`;
var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n');
if (responseA1PolicyManagement200_description_break == -1) {
$("#examples-A1PolicyManagement-putPolicy-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description);
<h3 id="examples-A1PolicyManagement-putPolicy-title-201"></h3>
<p id="examples-A1PolicyManagement-putPolicy-description-201" class="marked"></p>
<script>
- var responseA1PolicyManagement201_description = `Policy created`;
+ var responseA1PolicyManagement201_description = `Created - Policy created`;
var responseA1PolicyManagement201_description_break = responseA1PolicyManagement201_description.indexOf('\n');
if (responseA1PolicyManagement201_description_break == -1) {
$("#examples-A1PolicyManagement-putPolicy-title-201").text("Status: 201 - " + responseA1PolicyManagement201_description);
<h3 id="examples-A1PolicyManagement-putPolicy-title-423"></h3>
<p id="examples-A1PolicyManagement-putPolicy-description-423" class="marked"></p>
<script>
- var responseA1PolicyManagement423_description = `Near-RT RIC is not operational`;
+ var responseA1PolicyManagement423_description = `Locked - HTTP Status code which can be used when the state is Locked`;
var responseA1PolicyManagement423_description_break = responseA1PolicyManagement423_description.indexOf('\n');
if (responseA1PolicyManagement423_description_break == -1) {
$("#examples-A1PolicyManagement-putPolicy-title-423").text("Status: 423 - " + responseA1PolicyManagement423_description);
<input id='responses-A1PolicyManagement-putPolicy-423-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-A1PolicyManagement-putPolicy-title-404"></h3>
- <p id="examples-A1PolicyManagement-putPolicy-description-404" class="marked"></p>
- <script>
- var responseA1PolicyManagement404_description = `Near-RT RIC or policy type is not found`;
- var responseA1PolicyManagement404_description_break = responseA1PolicyManagement404_description.indexOf('\n');
- if (responseA1PolicyManagement404_description_break == -1) {
- $("#examples-A1PolicyManagement-putPolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description);
- } else {
- $("#examples-A1PolicyManagement-putPolicy-title-404").text("Status: 404 - " + responseA1PolicyManagement404_description.substring(0, responseA1PolicyManagement404_description_break));
- $("#examples-A1PolicyManagement-putPolicy-description-404").html(responseA1PolicyManagement404_description.substring(responseA1PolicyManagement404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-A1PolicyManagement-putPolicy-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-A1PolicyManagement-putPolicy-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-A1PolicyManagement-putPolicy-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-A1PolicyManagement-putPolicy-404-schema">
- <div id="responses-A1PolicyManagement-putPolicy-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-A1PolicyManagement-putPolicy-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-A1PolicyManagement-putPolicy-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-A1PolicyManagement-putPolicy-404-schema-data' type='hidden' value=''></input>
- </div>
- </div>
</article>
</div>
<hr>
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string",
- "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]
- }
- }
- }
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "string",\r
+ "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]\r
+ }\r
+ }\r
+ }\r
};
var schema = findNode('schema',schemaWrapper).schema;
<div class="tab-content">
<div class="tab-pane active" id="examples-AuthorizationAPI-performAccessControl-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X POST \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
-H "Content-Type: application/json" \
"http://localhost/example-authz-check" \
-d ''
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_authorization"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_authorization"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
<input id='responses-AuthorizationAPI-performAccessControl-200-schema-data' type='hidden' value=''></input>
</div>
</div>
+ <h3 id="examples-AuthorizationAPI-performAccessControl-title-403"></h3>
+ <p id="examples-AuthorizationAPI-performAccessControl-description-403" class="marked"></p>
+ <script>
+ var responseAuthorizationAPI403_description = `Forbidden`;
+ var responseAuthorizationAPI403_description_break = responseAuthorizationAPI403_description.indexOf('\n');
+ if (responseAuthorizationAPI403_description_break == -1) {
+ $("#examples-AuthorizationAPI-performAccessControl-title-403").text("Status: 403 - " + responseAuthorizationAPI403_description);
+ } else {
+ $("#examples-AuthorizationAPI-performAccessControl-title-403").text("Status: 403 - " + responseAuthorizationAPI403_description.substring(0, responseAuthorizationAPI403_description_break));
+ $("#examples-AuthorizationAPI-performAccessControl-description-403").html(responseAuthorizationAPI403_description.substring(responseAuthorizationAPI403_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-AuthorizationAPI-performAccessControl-403" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-AuthorizationAPI-performAccessControl-403-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-AuthorizationAPI-performAccessControl-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-AuthorizationAPI-performAccessControl-403-schema">
+ <div id="responses-AuthorizationAPI-performAccessControl-schema-403" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = ;
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-AuthorizationAPI-performAccessControl-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-AuthorizationAPI-performAccessControl-schema-403');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-AuthorizationAPI-performAccessControl-403-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
</article>
</div>
<hr>
<article id="api-Configuration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0">
<div class="pull-left">
<h1>getConfiguration</h1>
- <p>Returns the contents of the application configuration file</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns the contents of the application configuration file</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-Configuration-getConfiguration-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/configuration"
</code></pre>
</div>
// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
-// Returns the contents of the application configuration file
[apiInstance getConfigurationWithCompletionHandler:
^('String' output, NSError* error) {
if (output) {
var apiInstance = new ConfigurationApi();
try {
- // Returns the contents of the application configuration file
'String' result = apiInstance.getConfiguration();
Debug.WriteLine(result);
} catch (Exception e) {
api_instance = openapi_client.ConfigurationApi()
try:
- # Returns the contents of the application configuration file
api_response = api_instance.get_configuration()
pprint(api_response)
except ApiException as e:
<h3 id="examples-Configuration-getConfiguration-title-200"></h3>
<p id="examples-Configuration-getConfiguration-description-200" class="marked"></p>
<script>
- var responseConfiguration200_description = `Configuration`;
+ var responseConfiguration200_description = `OK - Configuration`;
var responseConfiguration200_description_break = responseConfiguration200_description.indexOf('\n');
if (responseConfiguration200_description_break == -1) {
$("#examples-Configuration-getConfiguration-title-200").text("Status: 200 - " + responseConfiguration200_description);
<h3 id="examples-Configuration-getConfiguration-title-404"></h3>
<p id="examples-Configuration-getConfiguration-description-404" class="marked"></p>
<script>
- var responseConfiguration404_description = `File is not found or readable`;
+ var responseConfiguration404_description = `Not Found`;
var responseConfiguration404_description_break = responseConfiguration404_description.indexOf('\n');
if (responseConfiguration404_description_break == -1) {
$("#examples-Configuration-getConfiguration-title-404").text("Status: 404 - " + responseConfiguration404_description);
<ul id="responses-detail-Configuration-getConfiguration-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Configuration-getConfiguration-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-Configuration-getConfiguration-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Configuration-getConfiguration-404-schema">
- <div id="responses-Configuration-getConfiguration-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Configuration-getConfiguration-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Configuration-getConfiguration-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Configuration-getConfiguration-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<article id="api-Configuration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0">
<div class="pull-left">
<h1>putConfiguration</h1>
- <p>Replace the current configuration file with the given configuration</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Replace the current configuration with the given configuration</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/a1-policy/v2/configuration</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-Configuration-putConfiguration-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
-H "Content-Type: application/json" \
"http://localhost/a1-policy/v2/configuration" \
-d ''
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
Object *body = Object; //
-// Replace the current configuration file with the given configuration
[apiInstance putConfigurationWith:body
completionHandler: ^(Object output, NSError* error) {
if (output) {
var body = Object; // Object |
try {
- // Replace the current configuration file with the given configuration
Object result = apiInstance.putConfiguration(body);
Debug.WriteLine(result);
} catch (Exception e) {
body = Object # Object |
try:
- # Replace the current configuration file with the given configuration
api_response = api_instance.put_configuration(body)
pprint(api_response)
except ApiException as e:
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
<h3 id="examples-Configuration-putConfiguration-title-200"></h3>
<p id="examples-Configuration-putConfiguration-description-200" class="marked"></p>
<script>
- var responseConfiguration200_description = `Configuration updated`;
+ var responseConfiguration200_description = `OK - Configuration updated`;
var responseConfiguration200_description_break = responseConfiguration200_description.indexOf('\n');
if (responseConfiguration200_description_break == -1) {
$("#examples-Configuration-putConfiguration-title-200").text("Status: 200 - " + responseConfiguration200_description);
</ul>
- <div class="tab-content" id="responses-Configuration-putConfiguration-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Configuration-putConfiguration-200-schema">
- <div id="responses-Configuration-putConfiguration-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Configuration-putConfiguration-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Configuration-putConfiguration-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Configuration-putConfiguration-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Configuration-putConfiguration-title-400"></h3>
- <p id="examples-Configuration-putConfiguration-description-400" class="marked"></p>
- <script>
- var responseConfiguration400_description = `Invalid configuration provided`;
- var responseConfiguration400_description_break = responseConfiguration400_description.indexOf('\n');
- if (responseConfiguration400_description_break == -1) {
- $("#examples-Configuration-putConfiguration-title-400").text("Status: 400 - " + responseConfiguration400_description);
- } else {
- $("#examples-Configuration-putConfiguration-title-400").text("Status: 400 - " + responseConfiguration400_description.substring(0, responseConfiguration400_description_break));
- $("#examples-Configuration-putConfiguration-description-400").html(responseConfiguration400_description.substring(responseConfiguration400_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Configuration-putConfiguration-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Configuration-putConfiguration-400-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Configuration-putConfiguration-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Configuration-putConfiguration-400-schema">
- <div id="responses-Configuration-putConfiguration-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Configuration-putConfiguration-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Configuration-putConfiguration-200-schema">
+ <div id="responses-Configuration-putConfiguration-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = ;
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Configuration-putConfiguration-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Configuration-putConfiguration-schema-400');
+ $('#responses-Configuration-putConfiguration-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Configuration-putConfiguration-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Configuration-putConfiguration-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Configuration-putConfiguration-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Configuration-putConfiguration-title-500"></h3>
- <p id="examples-Configuration-putConfiguration-description-500" class="marked"></p>
+ <h3 id="examples-Configuration-putConfiguration-title-400"></h3>
+ <p id="examples-Configuration-putConfiguration-description-400" class="marked"></p>
<script>
- var responseConfiguration500_description = `Something went wrong when replacing the configuration. Try again.`;
- var responseConfiguration500_description_break = responseConfiguration500_description.indexOf('\n');
- if (responseConfiguration500_description_break == -1) {
- $("#examples-Configuration-putConfiguration-title-500").text("Status: 500 - " + responseConfiguration500_description);
+ var responseConfiguration400_description = `Bad Request`;
+ var responseConfiguration400_description_break = responseConfiguration400_description.indexOf('\n');
+ if (responseConfiguration400_description_break == -1) {
+ $("#examples-Configuration-putConfiguration-title-400").text("Status: 400 - " + responseConfiguration400_description);
} else {
- $("#examples-Configuration-putConfiguration-title-500").text("Status: 500 - " + responseConfiguration500_description.substring(0, responseConfiguration500_description_break));
- $("#examples-Configuration-putConfiguration-description-500").html(responseConfiguration500_description.substring(responseConfiguration500_description_break));
+ $("#examples-Configuration-putConfiguration-title-400").text("Status: 400 - " + responseConfiguration400_description.substring(0, responseConfiguration400_description_break));
+ $("#examples-Configuration-putConfiguration-description-400").html(responseConfiguration400_description.substring(responseConfiguration400_description_break));
}
</script>
- <ul id="responses-detail-Configuration-putConfiguration-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Configuration-putConfiguration-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Configuration-putConfiguration-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Configuration-putConfiguration-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Configuration-putConfiguration-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Configuration-putConfiguration-500-schema">
- <div id="responses-Configuration-putConfiguration-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Configuration-putConfiguration-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Configuration-putConfiguration-400-schema">
+ <div id="responses-Configuration-putConfiguration-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = ;
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Configuration-putConfiguration-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Configuration-putConfiguration-schema-500');
+ $('#responses-Configuration-putConfiguration-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Configuration-putConfiguration-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Configuration-putConfiguration-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Configuration-putConfiguration-400-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
<article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0">
<div class="pull-left">
<h1>getStatus</h1>
- <p>Returns status and statistics of this service</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns status and statistics of this service</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/a1-policy/v2/status</span></code></pre>
// Create an instance of the API class
HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
-// Returns status and statistics of this service
[apiInstance getStatusWithCompletionHandler:
^(status_info output, NSError* error) {
if (output) {
var apiInstance = new HealthCheckApi();
try {
- // Returns status and statistics of this service
status_info result = apiInstance.getStatus();
Debug.WriteLine(result);
} catch (Exception e) {
api_instance = openapi_client.HealthCheckApi()
try:
- # Returns status and statistics of this service
api_response = api_instance.get_status()
pprint(api_response)
except ApiException as e:
<h3 id="examples-HealthCheck-getStatus-title-200"></h3>
<p id="examples-HealthCheck-getStatus-description-200" class="marked"></p>
<script>
- var responseHealthCheck200_description = `Service is living`;
+ var responseHealthCheck200_description = `OK- Service is living Ok`;
var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
if (responseHealthCheck200_description_break == -1) {
$("#examples-HealthCheck-getStatus-title-200").text("Status: 200 - " + responseHealthCheck200_description);
<article id="api-HealthCheck-getStatusV1-0" data-group="User" data-name="getStatusV1" data-version="0">
<div class="pull-left">
<h1>getStatusV1</h1>
- <p>Returns status and statistics of this service</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Returns status and statistics of this service</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/status</span></code></pre>
// Create an instance of the API class
HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
-// Returns status and statistics of this service
[apiInstance getStatusV1WithCompletionHandler:
^('String' output, NSError* error) {
if (output) {
var apiInstance = new HealthCheckApi();
try {
- // Returns status and statistics of this service
'String' result = apiInstance.getStatusV1();
Debug.WriteLine(result);
} catch (Exception e) {
api_instance = openapi_client.HealthCheckApi()
try:
- # Returns status and statistics of this service
api_response = api_instance.get_status_v1()
pprint(api_response)
except ApiException as e:
<h3 id="examples-HealthCheck-getStatusV1-title-200"></h3>
<p id="examples-HealthCheck-getStatusV1-description-200" class="marked"></p>
<script>
- var responseHealthCheck200_description = `Service is living`;
+ var responseHealthCheck200_description = `OK - Service is living`;
var responseHealthCheck200_description_break = responseHealthCheck200_description.indexOf('\n');
if (responseHealthCheck200_description_break == -1) {
$("#examples-HealthCheck-getStatusV1-title-200").text("Status: 200 - " + responseHealthCheck200_description);
<article id="api-NearRTRICRepository-getRic-0" data-group="User" data-name="getRic" data-version="0">
<div class="pull-left">
<h1>getRic</h1>
- <p>Returns info for one Near-RT RIC</p>
+ <p>Returns info of Near-RT RIC queried by the ric-id and managed-element-id</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<div class="tab-content">
<div class="tab-pane active" id="examples-NearRTRICRepository-getRic-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
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
+// 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) {
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
+ // 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) {
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
+ # 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:
<h3 id="examples-NearRTRICRepository-getRic-title-200"></h3>
<p id="examples-NearRTRICRepository-getRic-description-200" class="marked"></p>
<script>
- var responseNearRTRICRepository200_description = `Near-RT RIC is found`;
+ var responseNearRTRICRepository200_description = `OK - Near-RT RIC is found`;
var responseNearRTRICRepository200_description_break = responseNearRTRICRepository200_description.indexOf('\n');
if (responseNearRTRICRepository200_description_break == -1) {
$("#examples-NearRTRICRepository-getRic-title-200").text("Status: 200 - " + responseNearRTRICRepository200_description);
<h3 id="examples-NearRTRICRepository-getRic-title-404"></h3>
<p id="examples-NearRTRICRepository-getRic-description-404" class="marked"></p>
<script>
- var responseNearRTRICRepository404_description = `Near-RT RIC is not found`;
+ var responseNearRTRICRepository404_description = `Not Found`;
var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
if (responseNearRTRICRepository404_description_break == -1) {
$("#examples-NearRTRICRepository-getRic-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
<ul id="responses-detail-NearRTRICRepository-getRic-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRic-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-NearRTRICRepository-getRic-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRic-404-schema">
- <div id="responses-NearRTRICRepository-getRic-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRic-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRic-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-NearRTRICRepository-getRic-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-NearRTRICRepository-getRics-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/rics?policytype_id=policytypeId_example"
</code></pre>
</div>
<h3 id="examples-NearRTRICRepository-getRics-title-404"></h3>
<p id="examples-NearRTRICRepository-getRics-description-404" class="marked"></p>
<script>
- var responseNearRTRICRepository404_description = `Policy type is not found`;
+ var responseNearRTRICRepository404_description = `Not Found`;
var responseNearRTRICRepository404_description_break = responseNearRTRICRepository404_description.indexOf('\n');
if (responseNearRTRICRepository404_description_break == -1) {
$("#examples-NearRTRICRepository-getRics-title-404").text("Status: 404 - " + responseNearRTRICRepository404_description);
<ul id="responses-detail-NearRTRICRepository-getRics-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-NearRTRICRepository-getRics-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-NearRTRICRepository-getRics-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-NearRTRICRepository-getRics-404-schema">
- <div id="responses-NearRTRICRepository-getRics-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-NearRTRICRepository-getRics-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-NearRTRICRepository-getRics-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-NearRTRICRepository-getRics-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<article id="api-ServiceRegistryAndSupervision-deleteService-0" data-group="User" data-name="deleteService" data-version="0">
<div class="pull-left">
<h1>deleteService</h1>
- <p>Unregister a service</p>
+ <p></p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked"></p>
+ <p class="marked">Unregister a service</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/a1-policy/v2/services/{service_id}</span></code></pre>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-deleteService-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
"http://localhost/a1-policy/v2/services/{service_id}"
</code></pre>
</div>
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) {
var serviceId = serviceId_example; // String | (default to null)
try {
- // Unregister a service
Object result = apiInstance.deleteService(serviceId);
Debug.WriteLine(result);
} catch (Exception e) {
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:
<h2>Responses</h2>
- <h3 id="examples-ServiceRegistryAndSupervision-deleteService-title-200"></h3>
- <p id="examples-ServiceRegistryAndSupervision-deleteService-description-200" class="marked"></p>
- <script>
- var responseServiceRegistryAndSupervision200_description = `Not used`;
- var responseServiceRegistryAndSupervision200_description_break = responseServiceRegistryAndSupervision200_description.indexOf('\n');
- if (responseServiceRegistryAndSupervision200_description_break == -1) {
- $("#examples-ServiceRegistryAndSupervision-deleteService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description);
- } else {
- $("#examples-ServiceRegistryAndSupervision-deleteService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description.substring(0, responseServiceRegistryAndSupervision200_description_break));
- $("#examples-ServiceRegistryAndSupervision-deleteService-description-200").html(responseServiceRegistryAndSupervision200_description.substring(responseServiceRegistryAndSupervision200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-ServiceRegistryAndSupervision-deleteService-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-deleteService-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-ServiceRegistryAndSupervision-deleteService-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-deleteService-200-schema">
- <div id="responses-ServiceRegistryAndSupervision-deleteService-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-deleteService-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-deleteService-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-deleteService-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
<h3 id="examples-ServiceRegistryAndSupervision-deleteService-title-204"></h3>
<p id="examples-ServiceRegistryAndSupervision-deleteService-description-204" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision204_description = `Service unregistered`;
+ var responseServiceRegistryAndSupervision204_description = `No Content - Service unregistered`;
var responseServiceRegistryAndSupervision204_description_break = responseServiceRegistryAndSupervision204_description.indexOf('\n');
if (responseServiceRegistryAndSupervision204_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-deleteService-title-204").text("Status: 204 - " + responseServiceRegistryAndSupervision204_description);
<h3 id="examples-ServiceRegistryAndSupervision-deleteService-title-404"></h3>
<p id="examples-ServiceRegistryAndSupervision-deleteService-description-404" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision404_description = `Service not found`;
+ var responseServiceRegistryAndSupervision404_description = `Not Found`;
var responseServiceRegistryAndSupervision404_description_break = responseServiceRegistryAndSupervision404_description.indexOf('\n');
if (responseServiceRegistryAndSupervision404_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-deleteService-title-404").text("Status: 404 - " + responseServiceRegistryAndSupervision404_description);
<ul id="responses-detail-ServiceRegistryAndSupervision-deleteService-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-deleteService-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-ServiceRegistryAndSupervision-deleteService-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-deleteService-404-schema">
- <div id="responses-ServiceRegistryAndSupervision-deleteService-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-deleteService-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-deleteService-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-deleteService-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-getServices-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json" \
+ -H "Accept: application/json,application/problem+json" \
"http://localhost/a1-policy/v2/services?service_id=serviceId_example"
</code></pre>
</div>
<h3 id="examples-ServiceRegistryAndSupervision-getServices-title-404"></h3>
<p id="examples-ServiceRegistryAndSupervision-getServices-description-404" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision404_description = `Service is not found`;
+ var responseServiceRegistryAndSupervision404_description = `Not Found`;
var responseServiceRegistryAndSupervision404_description_break = responseServiceRegistryAndSupervision404_description.indexOf('\n');
if (responseServiceRegistryAndSupervision404_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-getServices-title-404").text("Status: 404 - " + responseServiceRegistryAndSupervision404_description);
<ul id="responses-detail-ServiceRegistryAndSupervision-getServices-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-getServices-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-ServiceRegistryAndSupervision-getServices-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-getServices-404-schema">
- <div id="responses-ServiceRegistryAndSupervision-getServices-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-getServices-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-getServices-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-getServices-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-keepAliveService-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
"http://localhost/a1-policy/v2/services/{service_id}/keepalive"
</code></pre>
</div>
<h3 id="examples-ServiceRegistryAndSupervision-keepAliveService-title-200"></h3>
<p id="examples-ServiceRegistryAndSupervision-keepAliveService-description-200" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision200_description = `Service supervision timer refreshed, OK`;
+ var responseServiceRegistryAndSupervision200_description = `OK - Service supervision timer refreshed, OK`;
var responseServiceRegistryAndSupervision200_description_break = responseServiceRegistryAndSupervision200_description.indexOf('\n');
if (responseServiceRegistryAndSupervision200_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-keepAliveService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description);
<h3 id="examples-ServiceRegistryAndSupervision-keepAliveService-title-404"></h3>
<p id="examples-ServiceRegistryAndSupervision-keepAliveService-description-404" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision404_description = `The service is not found, needs re-registration`;
+ var responseServiceRegistryAndSupervision404_description = `Not Found`;
var responseServiceRegistryAndSupervision404_description_break = responseServiceRegistryAndSupervision404_description.indexOf('\n');
if (responseServiceRegistryAndSupervision404_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-keepAliveService-title-404").text("Status: 404 - " + responseServiceRegistryAndSupervision404_description);
<ul id="responses-detail-ServiceRegistryAndSupervision-keepAliveService-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-ServiceRegistryAndSupervision-keepAliveService-404-schema">Schema</a>
- </li>
-
-
</ul>
<div class="tab-content" id="responses-ServiceRegistryAndSupervision-keepAliveService-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-ServiceRegistryAndSupervision-keepAliveService-404-schema">
- <div id="responses-ServiceRegistryAndSupervision-keepAliveService-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = ;
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-ServiceRegistryAndSupervision-keepAliveService-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-ServiceRegistryAndSupervision-keepAliveService-schema-404');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-ServiceRegistryAndSupervision-keepAliveService-404-schema-data' type='hidden' value=''></input>
- </div>
</div>
</article>
</div>
<div class="tab-content">
<div class="tab-pane active" id="examples-ServiceRegistryAndSupervision-putService-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X PUT \
- -H "Accept: */*" \
+ -H "Accept: */*,application/problem+json" \
-H "Content-Type: application/json" \
"http://localhost/a1-policy/v2/services" \
-d ''
<p class="marked"></p>
<script>
$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/service_registration_info"
- }
- }
- },
- "required" : true
+ var schemaWrapper = {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_registration_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
};
var schema = findNode('schema',schemaWrapper).schema;
<h3 id="examples-ServiceRegistryAndSupervision-putService-title-200"></h3>
<p id="examples-ServiceRegistryAndSupervision-putService-description-200" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision200_description = `Service updated`;
+ var responseServiceRegistryAndSupervision200_description = `OK - Service updated`;
var responseServiceRegistryAndSupervision200_description_break = responseServiceRegistryAndSupervision200_description.indexOf('\n');
if (responseServiceRegistryAndSupervision200_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-putService-title-200").text("Status: 200 - " + responseServiceRegistryAndSupervision200_description);
<h3 id="examples-ServiceRegistryAndSupervision-putService-title-201"></h3>
<p id="examples-ServiceRegistryAndSupervision-putService-description-201" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision201_description = `Service created`;
+ var responseServiceRegistryAndSupervision201_description = `Created - Service created`;
var responseServiceRegistryAndSupervision201_description_break = responseServiceRegistryAndSupervision201_description.indexOf('\n');
if (responseServiceRegistryAndSupervision201_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-putService-title-201").text("Status: 201 - " + responseServiceRegistryAndSupervision201_description);
<h3 id="examples-ServiceRegistryAndSupervision-putService-title-400"></h3>
<p id="examples-ServiceRegistryAndSupervision-putService-description-400" class="marked"></p>
<script>
- var responseServiceRegistryAndSupervision400_description = `The ServiceRegistrationInfo is not accepted`;
+ var responseServiceRegistryAndSupervision400_description = `Bad Request`;
var responseServiceRegistryAndSupervision400_description_break = responseServiceRegistryAndSupervision400_description.indexOf('\n');
if (responseServiceRegistryAndSupervision400_description_break == -1) {
$("#examples-ServiceRegistryAndSupervision-putService-title-400").text("Status: 400 - " + responseServiceRegistryAndSupervision400_description);
<div id="footer">
<div id="api-_footer">
<p>Suggestions, contact, support and error reporting;
- <div class="app-desc">Information URL: <a href="https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP">https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP</a></div>
- <div class="app-desc">Contact Info: <a href="team@openapitools.org">team@openapitools.org</a></div>
+ <div class="app-desc">Information URL: <a href="https://www.onap.org/">https://www.onap.org/</a></div>
+ <div class="app-desc">Contact Info: <a href="discuss-list@onap.com">discuss-list@onap.com</a></div>
</p>
- <div class="license-info">Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License, and Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.</div>
+ <div class="license-info">Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.</div>
<div class="license-url">http://www.apache.org/licenses/LICENSE-2.0</div>
</div>
</div>
-{
- "openapi" : "3.0.3",
- "info" : {
- "title" : "A1 Policy Management Service",
- "description" : "<h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>",
- "license" : {
- "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License, and Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.",
- "url" : "http://www.apache.org/licenses/LICENSE-2.0"
- },
- "version" : "1.2.0"
- },
- "servers" : [ {
- "url" : "/"
- } ],
- "tags" : [ {
- "name" : "Authorization API",
- "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA). <br> Note that this API is called by PMS, it is not provided."
- }, {
- "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. <br>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 <typename_version>)",
- "required" : false,
- "style" : "form",
- "explode" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Policies",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info_list"
- },
- "examples" : {
- "policy_info_list" : {
- "$ref" : "#/components/examples/policy_info_list"
- }
- }
- }
- }
- },
- "404" : {
- "description" : "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"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/status" : {
- "get" : {
- "tags" : [ "Health Check" ],
- "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"
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/rics/ric" : {
- "get" : {
- "tags" : [ "NearRT-RIC Repository" ],
- "summary" : "Returns info for one Near-RT RIC",
- "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>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" : "Near-RT RIC is found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ric_info"
- },
- "examples" : {
- "ric_info" : {
- "$ref" : "#/components/examples/ric_info"
- }
- }
- }
- }
- },
- "404" : {
- "description" : "Near-RT RIC is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/policy-types" : {
- "get" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "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 <typename_version>)",
- "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" : "Policy type IDs",
- "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" : "Near-RT RIC is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/policies/{policy_id}" : {
- "get" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "Returns a policy",
- "operationId" : "getPolicy",
- "parameters" : [ {
- "name" : "policy_id",
- "in" : "path",
- "required" : true,
- "style" : "simple",
- "explode" : false,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Policy found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info"
- },
- "examples" : {
- "policy_info" : {
- "$ref" : "#/components/examples/policy_info"
- }
- }
- }
- }
- },
- "404" : {
- "description" : "Policy is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- },
- "delete" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "Delete a policy",
- "operationId" : "deletePolicy",
- "parameters" : [ {
- "name" : "policy_id",
- "in" : "path",
- "required" : true,
- "style" : "simple",
- "explode" : false,
- "schema" : {
- "type" : "string"
- }
- } ],
- "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"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/configuration" : {
- "get" : {
- "tags" : [ "configuration" ],
- "summary" : "Returns the contents of the application configuration file",
- "operationId" : "getConfiguration",
- "responses" : {
- "200" : {
- "description" : "Configuration",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- }
- },
- "404" : {
- "description" : "File is not found or readable",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- },
- "put" : {
- "tags" : [ "configuration" ],
- "summary" : "Replace the current configuration file with the given configuration",
- "operationId" : "putConfiguration",
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object"
- }
- }
- },
- "required" : true
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "/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" : "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"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/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" : "Policy type is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- }
- },
- "/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" : "Service is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- },
- "put" : {
- "tags" : [ "Service Registry and Supervision" ],
- "summary" : "Register a service",
- "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><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",
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/service_registration_info"
- }
- }
- },
- "required" : true
- },
- "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"
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/status" : {
- "get" : {
- "tags" : [ "Health Check" ],
- "summary" : "Returns status and statistics of this service",
- "operationId" : "getStatusV1",
- "responses" : {
- "200" : {
- "description" : "Service is living",
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "string"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/policy-types/{policytype_id}" : {
- "get" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "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" : "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" : "Policy type is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/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"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/policies" : {
- "get" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "Query policy identities",
- "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",
- "operationId" : "getPolicyIds",
- "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 <typename_version>)",
- "required" : false,
- "style" : "form",
- "explode" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Policy identities",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_id_list"
- },
- "examples" : {
- "policy_id_list" : {
- "$ref" : "#/components/examples/policy_id_list"
- }
- }
- }
- }
- },
- "404" : {
- "description" : "Near-RT RIC or type not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- },
- "put" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "Create or update a policy",
- "operationId" : "putPolicy",
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_info"
- }
- }
- },
- "required" : true
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/services/{service_id}" : {
- "delete" : {
- "tags" : [ "Service Registry and Supervision" ],
- "summary" : "Unregister a service",
- "operationId" : "deleteService",
- "parameters" : [ {
- "name" : "service_id",
- "in" : "path",
- "required" : true,
- "style" : "simple",
- "explode" : false,
- "schema" : {
- "type" : "string"
- }
- } ],
- "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"
- }
- }
- }
- }
- }
- }
- },
- "/actuator/heapdump" : {
- "get" : {
- "tags" : [ "Actuator" ],
- "summary" : "Actuator web endpoint 'heapdump'",
- "operationId" : "heapdump",
- "responses" : {
- "200" : {
- "description" : "OK",
- "content" : {
- "application/octet-stream" : {
- "schema" : {
- "type" : "object"
- }
- }
- }
- }
- }
- }
- },
- "/a1-policy/v2/policies/{policy_id}/status" : {
- "get" : {
- "tags" : [ "A1 Policy Management" ],
- "summary" : "Returns a policy status",
- "operationId" : "getPolicyStatus",
- "parameters" : [ {
- "name" : "policy_id",
- "in" : "path",
- "required" : true,
- "style" : "simple",
- "explode" : false,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Policy status",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/policy_status_info"
- },
- "examples" : {
- "policy_status_info" : {
- "$ref" : "#/components/examples/policy_status_info"
- }
- }
- }
- }
- },
- "404" : {
- "description" : "Policy is not found",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/error_information"
- }
- }
- }
- }
- }
- }
- }
- },
- "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"
- },
- "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", "service_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."
- },
- "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"
- }
- }
- }
- },
- "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" : [ "policy_ids", "policy_ids" ]
- }
- },
- "policy_status_info" : {
- "description" : "Status for one A1-P Policy",
- "value" : {
- "last_modified" : "last_modified",
- "status" : "{}"
- }
- },
- "status_info" : {
- "value" : {
- "status" : "status"
- }
- },
- "ric_info" : {
- "value" : {
- "ric_id" : "ric_id",
- "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ],
- "state" : "UNAVAILABLE",
- "policytype_ids" : [ "policytype_ids", "policytype_ids" ]
- }
- },
- "ric_info_list" : {
- "value" : {
- "rics" : [ {
- "ric_id" : "ric_id",
- "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ],
- "state" : "UNAVAILABLE",
- "policytype_ids" : [ "policytype_ids", "policytype_ids" ]
- }, {
- "ric_id" : "ric_id",
- "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ],
- "state" : "UNAVAILABLE",
- "policytype_ids" : [ "policytype_ids", "policytype_ids" ]
- } ]
- }
- }
- }
- }
+{\r
+ "openapi" : "3.0.3",\r
+ "info" : {\r
+ "title" : "A1 Policy Management Service",\r
+ "description" : "<h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>API used for 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><h3>Authorization API</h3><p>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><h3>Spring Boot Actuator</h3><p>Provides generic functions used to monitor and manage the Spring web application.</p>",\r
+ "contact" : {\r
+ "url" : "https://www.onap.org/",\r
+ "email" : "discuss-list@onap.com"\r
+ },\r
+ "license" : {\r
+ "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.",\r
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0"\r
+ },\r
+ "version" : "1.3.0",\r
+ "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8",\r
+ "x-audience" : "external-public"\r
+ },\r
+ "servers" : [ {\r
+ "url" : "/"\r
+ } ],\r
+ "tags" : [ {\r
+ "name" : "A1 Policy Management",\r
+ "description" : "API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances."\r
+ }, {\r
+ "name" : "NearRT-RIC Repository",\r
+ "description" : "API used to get the NearRT-RIC for the managed element."\r
+ }, {\r
+ "name" : "Service Registry and Supervision",\r
+ "description" : "API used to keep the service Alive with in the timeout period"\r
+ }, {\r
+ "name" : "Health Check",\r
+ "description" : "API used to get the health status and statistics of this service"\r
+ }, {\r
+ "name" : "Service callbacks"\r
+ }, {\r
+ "name" : "Authorization API",\r
+ "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA). <br> Note that this API is called by PMS, it is not provided."\r
+ }, {\r
+ "name" : "Configuration",\r
+ "description" : "API used to create or fetch the application configuration."\r
+ }, {\r
+ "name" : "Actuator",\r
+ "description" : "Monitor and interact",\r
+ "externalDocs" : {\r
+ "description" : "Spring Boot Actuator Web API Documentation",\r
+ "url" : "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"\r
+ }\r
+ } ],\r
+ "paths" : {\r
+ "/a1-policy/v2/policy-instances" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "summary" : "Query for A1 policy instances",\r
+ "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",\r
+ "operationId" : "getPolicyInstances",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "query",\r
+ "description" : "Select policies with a given type identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "Select policies for a given Near-RT RIC identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "service_id",\r
+ "in" : "query",\r
+ "description" : "Select policies owned by a given service.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "type_name",\r
+ "in" : "query",\r
+ "description" : "Select policies of a given type name (type identity has the format <typename_version>)",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Returns A1 Policies which matches the criteria",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info_list"\r
+ },\r
+ "examples" : {\r
+ "policy_info_list" : {\r
+ "$ref" : "#/components/examples/policy_info_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found - Near-RT RIC, policy type or service not found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/example-authz-check" : {\r
+ "post" : {\r
+ "tags" : [ "Authorization API" ],\r
+ "summary" : "Request for access authorization.",\r
+ "description" : "The authorization function decides if access is granted.",\r
+ "operationId" : "performAccessControl",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_authorization"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/authorization_result"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "403" : {\r
+ "description" : "Forbidden",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 403,\r
+ "title" : "Forbidden",\r
+ "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/threaddump" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'threaddump'",\r
+ "operationId" : "threaddump",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "text/plain;charset=UTF-8" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/status" : {\r
+ "get" : {\r
+ "tags" : [ "Health Check" ],\r
+ "description" : "Returns status and statistics of this service",\r
+ "operationId" : "getStatus",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK- Service is living Ok",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/status_info"\r
+ },\r
+ "examples" : {\r
+ "status_info" : {\r
+ "$ref" : "#/components/examples/status_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/loggers" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'loggers'",\r
+ "operationId" : "loggers",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator/health/**" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'health-path'",\r
+ "operationId" : "health-path",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/rics/ric" : {\r
+ "get" : {\r
+ "tags" : [ "NearRT-RIC Repository" ],\r
+ "summary" : "Returns info of Near-RT RIC queried by the ric-id and managed-element-id",\r
+ "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).",\r
+ "operationId" : "getRic",\r
+ "parameters" : [ {\r
+ "name" : "managed_element_id",\r
+ "in" : "query",\r
+ "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "The identity of a Near-RT RIC to get information for.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Near-RT RIC is found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/ric_info"\r
+ },\r
+ "examples" : {\r
+ "ric_info" : {\r
+ "$ref" : "#/components/examples/ric_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/shutdown" : {\r
+ "post" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'shutdown'",\r
+ "operationId" : "shutdown",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/policy-types" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Query policy type identities",\r
+ "operationId" : "getPolicyTypes",\r
+ "parameters" : [ {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "Select types for the given Near-RT RIC identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "type_name",\r
+ "in" : "query",\r
+ "description" : "Select types with the given type name (type identity has the format <typename_version>)",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "compatible_with_version",\r
+ "in" : "query",\r
+ "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.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy Type IDs Found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_type_id_list"\r
+ },\r
+ "examples" : {\r
+ "policy_type_id_list" : {\r
+ "$ref" : "#/components/examples/policy_type_id_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/policies/{policy_id}" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Returns a policy",\r
+ "operationId" : "getPolicy",\r
+ "parameters" : [ {\r
+ "name" : "policy_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy found",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ },\r
+ "examples" : {\r
+ "policy_info" : {\r
+ "$ref" : "#/components/examples/policy_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "delete" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "summary" : "Delete a policy",\r
+ "description" : "Deleting the policy using the Policy's Policy ID.",\r
+ "operationId" : "deletePolicy",\r
+ "parameters" : [ {\r
+ "name" : "policy_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy deleted",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "423" : {\r
+ "description" : "Locked - HTTP Status code which can be used when the state is Locked",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 423,\r
+ "title" : "Locked",\r
+ "detail" : "Requested resource is in a locked state."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/metrics/{requiredMetricName}" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'metrics-requiredMetricName'",\r
+ "operationId" : "metrics-requiredMetricName",\r
+ "parameters" : [ {\r
+ "name" : "requiredMetricName",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/configuration" : {\r
+ "get" : {\r
+ "tags" : [ "Configuration" ],\r
+ "description" : "Returns the contents of the application configuration file",\r
+ "operationId" : "getConfiguration",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Configuration",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ },\r
+ "put" : {\r
+ "tags" : [ "Configuration" ],\r
+ "description" : "Replace the current configuration with the given configuration",\r
+ "operationId" : "putConfiguration",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Configuration updated",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "400" : {\r
+ "description" : "Bad Request",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 400,\r
+ "title" : "Bad Request",\r
+ "detail" : "The provided request is not valid."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator root web endpoint",\r
+ "operationId" : "links",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "$ref" : "#/components/schemas/Link"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "$ref" : "#/components/schemas/Link"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "type" : "object",\r
+ "additionalProperties" : {\r
+ "$ref" : "#/components/schemas/Link"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator/loggers/{name}" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'loggers-name'",\r
+ "operationId" : "loggers-name",\r
+ "parameters" : [ {\r
+ "name" : "name",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ },\r
+ "post" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'loggers-name'",\r
+ "operationId" : "loggers-name_2",\r
+ "parameters" : [ {\r
+ "name" : "name",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "string",\r
+ "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ]\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/services/{service_id}/keepalive" : {\r
+ "put" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "summary" : "Heartbeat indicates that the service is running",\r
+ "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)",\r
+ "operationId" : "keepAliveService",\r
+ "parameters" : [ {\r
+ "name" : "service_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Service supervision timer refreshed, OK",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/metrics" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'metrics'",\r
+ "operationId" : "metrics",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/rics" : {\r
+ "get" : {\r
+ "tags" : [ "NearRT-RIC Repository" ],\r
+ "summary" : "Query Near-RT RIC information",\r
+ "description" : "The call returns all Near-RT RICs that supports a given policy type identity",\r
+ "operationId" : "getRics",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "query",\r
+ "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/ric_info_list"\r
+ },\r
+ "examples" : {\r
+ "ric_info_list" : {\r
+ "$ref" : "#/components/examples/ric_info_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/services" : {\r
+ "get" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "summary" : "Returns service information",\r
+ "description" : "Either information about a registered service with given identity or all registered services are returned.",\r
+ "operationId" : "getServices",\r
+ "parameters" : [ {\r
+ "name" : "service_id",\r
+ "in" : "query",\r
+ "description" : "The identity of the service",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_status_list"\r
+ },\r
+ "examples" : {\r
+ "service_status_list" : {\r
+ "$ref" : "#/components/examples/service_status_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "put" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "summary" : "Register a service",\r
+ "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><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.",\r
+ "operationId" : "putService",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_registration_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Service updated",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "201" : {\r
+ "description" : "Created - Service created",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "400" : {\r
+ "description" : "Bad Request",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 400,\r
+ "title" : "Bad Request",\r
+ "detail" : "The provided request is not valid."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "callbacks" : {\r
+ "RICStatus" : {\r
+ "{$request.body#/callback_url}" : {\r
+ "post" : {\r
+ "tags" : [ "Service callbacks" ],\r
+ "summary" : "Callback for Near-RT RIC status",\r
+ "description" : "The URL to this call is registered at Service registration.",\r
+ "operationId" : "serviceCallback",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/service_callback_info_v2"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/info" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'info'",\r
+ "operationId" : "info",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/status" : {\r
+ "get" : {\r
+ "tags" : [ "Health Check" ],\r
+ "description" : "Returns status and statistics of this service",\r
+ "operationId" : "getStatusV1",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Service is living",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/policy-types/{policytype_id}" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Returns a policy type definition",\r
+ "operationId" : "getPolicyTypeDefinition",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - schema of the given policy type",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_type_definition"\r
+ },\r
+ "examples" : {\r
+ "policy_type_definition" : {\r
+ "$ref" : "#/components/examples/policy_type_definition"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/logfile" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'logfile'",\r
+ "operationId" : "logfile",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "text/plain;charset=UTF-8" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/actuator/health" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'health'",\r
+ "operationId" : "health",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/vnd.spring-boot.actuator.v3+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ },\r
+ "application/vnd.spring-boot.actuator.v2+json" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/policies" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "summary" : "Query policy identities",\r
+ "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.",\r
+ "operationId" : "getPolicyIds",\r
+ "parameters" : [ {\r
+ "name" : "policytype_id",\r
+ "in" : "query",\r
+ "description" : "Select policies of a given policy type identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "ric_id",\r
+ "in" : "query",\r
+ "description" : "Select policies of a given Near-RT RIC identity.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "service_id",\r
+ "in" : "query",\r
+ "description" : "Select policies owned by a given service.",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ }, {\r
+ "name" : "type_name",\r
+ "in" : "query",\r
+ "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)",\r
+ "required" : false,\r
+ "style" : "form",\r
+ "explode" : true,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy identities",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_id_list"\r
+ },\r
+ "examples" : {\r
+ "policy_id_list" : {\r
+ "$ref" : "#/components/examples/policy_id_list"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "put" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Create or update a policy",\r
+ "operationId" : "putPolicy",\r
+ "requestBody" : {\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "required" : true\r
+ },\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy updated",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "201" : {\r
+ "description" : "Created - Policy created",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/void"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "423" : {\r
+ "description" : "Locked - HTTP Status code which can be used when the state is Locked",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 423,\r
+ "title" : "Locked",\r
+ "detail" : "Requested resource is in a locked state."\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/a1-policy/v2/services/{service_id}" : {\r
+ "delete" : {\r
+ "tags" : [ "Service Registry and Supervision" ],\r
+ "description" : "Unregister a service",\r
+ "operationId" : "deleteService",\r
+ "parameters" : [ {\r
+ "name" : "service_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "204" : {\r
+ "description" : "No Content - Service unregistered",\r
+ "content" : {\r
+ "*/*" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "/actuator/heapdump" : {\r
+ "get" : {\r
+ "tags" : [ "Actuator" ],\r
+ "summary" : "Actuator web endpoint 'heapdump'",\r
+ "operationId" : "heapdump",\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK",\r
+ "content" : {\r
+ "application/octet-stream" : {\r
+ "schema" : {\r
+ "type" : "object"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "x-internal" : true\r
+ }\r
+ },\r
+ "/a1-policy/v2/policies/{policy_id}/status" : {\r
+ "get" : {\r
+ "tags" : [ "A1 Policy Management" ],\r
+ "description" : "Returns a policy status",\r
+ "operationId" : "getPolicyStatus",\r
+ "parameters" : [ {\r
+ "name" : "policy_id",\r
+ "in" : "path",\r
+ "required" : true,\r
+ "style" : "simple",\r
+ "explode" : false,\r
+ "schema" : {\r
+ "type" : "string"\r
+ }\r
+ } ],\r
+ "responses" : {\r
+ "200" : {\r
+ "description" : "OK - Policy status",\r
+ "content" : {\r
+ "application/json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/policy_status_info"\r
+ },\r
+ "examples" : {\r
+ "policy_status_info" : {\r
+ "$ref" : "#/components/examples/policy_status_info"\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "404" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "components" : {\r
+ "schemas" : {\r
+ "policy_type_definition" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_schema" : {\r
+ "type" : "object",\r
+ "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema"\r
+ }\r
+ },\r
+ "description" : "Contains policy type schema definition"\r
+ },\r
+ "error_information" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "detail" : {\r
+ "type" : "string",\r
+ "description" : " A human-readable explanation specific to this occurrence of the problem.",\r
+ "example" : "Policy type not found"\r
+ },\r
+ "title" : {\r
+ "type" : "string",\r
+ "description" : "A specific error name",\r
+ "example" : "Not Found"\r
+ },\r
+ "status" : {\r
+ "type" : "integer",\r
+ "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ",\r
+ "format" : "int32",\r
+ "example" : 404\r
+ }\r
+ },\r
+ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807"\r
+ },\r
+ "void" : {\r
+ "type" : "object",\r
+ "description" : "Void/empty"\r
+ },\r
+ "status_info" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "status" : {\r
+ "type" : "string",\r
+ "description" : "status text"\r
+ }\r
+ }\r
+ },\r
+ "authorization_result" : {\r
+ "required" : [ "result" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "result" : {\r
+ "type" : "boolean",\r
+ "description" : "If true, the access is granted"\r
+ }\r
+ },\r
+ "description" : "Result of authorization",\r
+ "example" : {\r
+ "result" : true\r
+ }\r
+ },\r
+ "ric_info" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the Near-RT RIC"\r
+ },\r
+ "managed_element_ids" : {\r
+ "type" : "array",\r
+ "description" : "O1 identities for managed entities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "O1 identities for managed entities"\r
+ }\r
+ },\r
+ "state" : {\r
+ "type" : "string",\r
+ "description" : "Represents the states for a Near-RT RIC",\r
+ "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ]\r
+ },\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "supported policy types",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "supported policy types"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information for a Near-RT RIC"\r
+ },\r
+ "service_registration_info" : {\r
+ "required" : [ "service_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of Near-RT RIC state changes"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "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.",\r
+ "format" : "int64"\r
+ }\r
+ },\r
+ "description" : "Information for one service"\r
+ },\r
+ "policy_info_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policies" : {\r
+ "type" : "array",\r
+ "description" : "List of policy information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/policy_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of policy information"\r
+ },\r
+ "policy_status_info" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "last_modified" : {\r
+ "type" : "string",\r
+ "description" : "timestamp, last modification time"\r
+ },\r
+ "status" : {\r
+ "type" : "object",\r
+ "description" : "the Policy status"\r
+ }\r
+ },\r
+ "description" : "Status for one A1-P Policy"\r
+ },\r
+ "service_status" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "callback_url" : {\r
+ "type" : "string",\r
+ "description" : "callback for notifying of RIC synchronization"\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the service"\r
+ },\r
+ "keep_alive_interval_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "policy keep alive timeout",\r
+ "format" : "int64"\r
+ },\r
+ "time_since_last_activity_seconds" : {\r
+ "type" : "integer",\r
+ "description" : "time since last invocation by the service",\r
+ "format" : "int64"\r
+ }\r
+ }\r
+ },\r
+ "ric_info_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "rics" : {\r
+ "type" : "array",\r
+ "description" : "List of Near-RT RIC information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/ric_info"\r
+ }\r
+ }\r
+ },\r
+ "description" : "List of Near-RT RIC information"\r
+ },\r
+ "input" : {\r
+ "required" : [ "access_type", "auth_token", "policy_type_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "access_type" : {\r
+ "type" : "string",\r
+ "description" : "Access type",\r
+ "enum" : [ "READ", "WRITE", "DELETE" ]\r
+ },\r
+ "auth_token" : {\r
+ "type" : "string",\r
+ "description" : "Authorization token"\r
+ },\r
+ "policy_type_id" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identifier"\r
+ }\r
+ },\r
+ "description" : "input"\r
+ },\r
+ "policy_authorization" : {\r
+ "required" : [ "input" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "input" : {\r
+ "$ref" : "#/components/schemas/input"\r
+ }\r
+ },\r
+ "description" : "Authorization request for A1 policy requests"\r
+ },\r
+ "policy_type_id_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policytype_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy type identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy type identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "Information about policy types"\r
+ },\r
+ "policy_info" : {\r
+ "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the target Near-RT RIC"\r
+ },\r
+ "policy_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy"\r
+ },\r
+ "transient" : {\r
+ "type" : "boolean",\r
+ "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",\r
+ "nullable" : false,\r
+ "example" : false,\r
+ "default" : false\r
+ },\r
+ "service_id" : {\r
+ "type" : "string",\r
+ "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.",\r
+ "default" : ""\r
+ },\r
+ "policy_data" : {\r
+ "type" : "object",\r
+ "description" : "the configuration of the policy"\r
+ },\r
+ "status_notification_uri" : {\r
+ "type" : "string",\r
+ "description" : "Callback URI for policy status updates"\r
+ },\r
+ "policytype_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of the policy type"\r
+ }\r
+ },\r
+ "description" : "Information for one A1-P Policy"\r
+ },\r
+ "policy_id_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "policy_ids" : {\r
+ "type" : "array",\r
+ "description" : "Policy identities",\r
+ "items" : {\r
+ "type" : "string",\r
+ "description" : "Policy identities"\r
+ }\r
+ }\r
+ },\r
+ "description" : "A list of policy identities",\r
+ "example" : {\r
+ "policy_ids" : [ "policy_ids", "policy_ids" ]\r
+ }\r
+ },\r
+ "service_status_list" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "service_list" : {\r
+ "type" : "array",\r
+ "description" : "List of service information",\r
+ "items" : {\r
+ "$ref" : "#/components/schemas/service_status"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "service_callback_info_v2" : {\r
+ "required" : [ "event_type", "ric_id" ],\r
+ "type" : "object",\r
+ "properties" : {\r
+ "ric_id" : {\r
+ "type" : "string",\r
+ "description" : "identity of a Near-RT RIC"\r
+ },\r
+ "event_type" : {\r
+ "type" : "string",\r
+ "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",\r
+ "enum" : [ "AVAILABLE" ]\r
+ }\r
+ },\r
+ "description" : "Information transferred as in Service callbacks (callback_url)"\r
+ },\r
+ "Link" : {\r
+ "type" : "object",\r
+ "properties" : {\r
+ "templated" : {\r
+ "type" : "boolean"\r
+ },\r
+ "href" : {\r
+ "type" : "string"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "responses" : {\r
+ "Locked" : {\r
+ "description" : "Locked - HTTP Status code which can be used when the state is Locked",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 423,\r
+ "title" : "Locked",\r
+ "detail" : "Requested resource is in a locked state."\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "BadRequest" : {\r
+ "description" : "Bad Request",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 400,\r
+ "title" : "Bad Request",\r
+ "detail" : "The provided request is not valid."\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "Forbidden" : {\r
+ "description" : "Forbidden",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "schema" : {\r
+ "$ref" : "#/components/schemas/error_information"\r
+ },\r
+ "example" : {\r
+ "status" : 403,\r
+ "title" : "Forbidden",\r
+ "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights."\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "NotFound" : {\r
+ "description" : "Not Found",\r
+ "content" : {\r
+ "application/problem+json" : {\r
+ "example" : [ ]\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "examples" : {\r
+ "service_status" : {\r
+ "description" : "List of service information",\r
+ "value" : {\r
+ "callback_url" : "callback_url",\r
+ "service_id" : "service_id",\r
+ "keep_alive_interval_seconds" : 0,\r
+ "time_since_last_activity_seconds" : 6\r
+ }\r
+ },\r
+ "service_status_list" : {\r
+ "description" : "List of service information",\r
+ "value" : {\r
+ "service_list" : [ {\r
+ "callback_url" : "callback_url",\r
+ "service_id" : "service_id",\r
+ "keep_alive_interval_seconds" : 0,\r
+ "time_since_last_activity_seconds" : 6\r
+ }, {\r
+ "callback_url" : "callback_url",\r
+ "service_id" : "service_id",\r
+ "keep_alive_interval_seconds" : 0,\r
+ "time_since_last_activity_seconds" : 6\r
+ } ]\r
+ }\r
+ },\r
+ "policy_type_definition" : {\r
+ "description" : "Schema of the given Policy type",\r
+ "value" : {\r
+ "policy_schema" : "{}"\r
+ }\r
+ },\r
+ "policy_type_id_list" : {\r
+ "description" : "Array of policy type id's",\r
+ "value" : {\r
+ "policy_type_id_list" : [ "policytype_id", "policytype_id" ]\r
+ }\r
+ },\r
+ "policy_info" : {\r
+ "description" : "Policy information of one A1-P policy",\r
+ "value" : {\r
+ "ric_id" : "ric_id",\r
+ "policy_id" : "policy_id",\r
+ "transient" : false,\r
+ "service_id" : "service_id",\r
+ "policy_data" : "{}",\r
+ "status_notification_uri" : "status_notification_uri",\r
+ "policytype_id" : "policytype_id"\r
+ }\r
+ },\r
+ "policy_info_list" : {\r
+ "description" : "List of policy information",\r
+ "value" : {\r
+ "policies" : [ {\r
+ "ric_id" : "ric_id",\r
+ "policy_id" : "policy_id",\r
+ "transient" : false,\r
+ "service_id" : "service_id",\r
+ "policy_data" : "{}",\r
+ "status_notification_uri" : "status_notification_uri",\r
+ "policytype_id" : "policytype_id"\r
+ }, {\r
+ "ric_id" : "ric_id",\r
+ "policy_id" : "policy_id",\r
+ "transient" : false,\r
+ "service_id" : "service_id",\r
+ "policy_data" : "{}",\r
+ "status_notification_uri" : "status_notification_uri",\r
+ "policytype_id" : "policytype_id"\r
+ } ]\r
+ }\r
+ },\r
+ "policy_id_list" : {\r
+ "description" : "A list of policy identities",\r
+ "value" : {\r
+ "policy_ids" : [ "some_policy_id", "some_policy_id" ]\r
+ }\r
+ },\r
+ "policy_status_info" : {\r
+ "description" : "Status for one A1-P Policy",\r
+ "value" : {\r
+ "last_modified" : "last_modified",\r
+ "status" : {\r
+ "value" : {\r
+ "status" : "status"\r
+ }\r
+ }\r
+ }\r
+ },\r
+ "status_info" : {\r
+ "value" : {\r
+ "status" : "status"\r
+ }\r
+ },\r
+ "ric_info" : {\r
+ "value" : {\r
+ "ric_id" : "ric_id",\r
+ "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ],\r
+ "state" : "UNAVAILABLE",\r
+ "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ]\r
+ }\r
+ },\r
+ "ric_info_list" : {\r
+ "value" : {\r
+ "rics" : [ {\r
+ "ric_id" : "ric_id",\r
+ "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ],\r
+ "state" : "UNAVAILABLE",\r
+ "policytype_ids" : [ "policytype_id", "policytype_id" ]\r
+ }, {\r
+ "ric_id" : "ric_id",\r
+ "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ],\r
+ "state" : "UNAVAILABLE",\r
+ "policytype_ids" : [ "policytype_ids", "policytype_ids" ]\r
+ } ]\r
+ }\r
+ }\r
+ }\r
+ }\r
}
\ No newline at end of file
# ============LICENSE_START=======================================================
# Copyright (C) 2020-2023 Nordix Foundation
-# Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
+# Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved.
# Modifications Copyright (C) 2021 Pantheon.tech
# Modifications Copyright (C) 2021 Bell Canada
# ================================================================================
openapi: 3.0.3
info:
+ x-api-id: a31c510b-20e6-4a08-af16-368c44d7fba8
+ x-audience: external-public
description: "<h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service\
- \ provides a REST API for management of A1 policies. <br/>The main tasks of the\
+ \ provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the\
\ service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring\
\ and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining\
\ a view of supported Near-RT RIC policy types</li><li>Supervision of using services\
\ Actuator</h3><p>Provides generic functions used to monitor and manage the Spring\
\ web application.</p>"
license:
- name: Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License, and
- Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
+ name: Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.
url: http://www.apache.org/licenses/LICENSE-2.0
title: A1 Policy Management Service
- version: 1.2.0
+ version: 1.3.0
+ contact:
+ url: https://www.onap.org/
+ email: discuss-list@onap.com
servers:
- url: /
tags:
- - description: "API used for authorization of information A1 policy access (this is
+ - 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). <br> Note that this API is called
by PMS, it is not provided."
- name: Authorization API
- - description: Monitor and interact
+ - 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/
- name: Actuator
paths:
/a1-policy/v2/policy-instances:
get:
$ref: '#/components/examples/policy_info_list'
schema:
$ref: '#/components/schemas/policy_info_list'
- description: Policies
+ description: OK - Returns A1 Policies which matches the criteria
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/error_information'
- description: "Near-RT RIC, policy type or service not found"
+ description: "Not Found - Near-RT RIC, policy type or service not found"
summary: Query for A1 policy instances
tags:
- A1 Policy Management
schema:
$ref: '#/components/schemas/authorization_result'
description: OK
+ "403":
+ $ref: '#/components/responses/Forbidden'
summary: Request for access authorization.
tags:
- Authorization API
/actuator/threaddump:
get:
+ x-internal: true
operationId: threaddump
responses:
"200":
examples:
status_info:
$ref: '#/components/examples/status_info'
- description: Service is living
- summary: Returns status and statistics of this service
+ description: OK- Service is living Ok
+ description: Returns status and statistics of this service
tags:
- Health Check
/actuator/loggers:
get:
+ x-internal: true
operationId: loggers
responses:
"200":
- Actuator
/actuator/health/**:
get:
+ x-internal: true
operationId: health-path
responses:
"200":
examples:
ric_info:
$ref: '#/components/examples/ric_info'
- description: Near-RT RIC is found
+ description: OK - Near-RT RIC is found
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Near-RT RIC is not found
- summary: Returns info for one Near-RT RIC
+ $ref: '#/components/responses/NotFound'
+ description: NotFound - Requested NearRT-RIC Not Found
+ summary: Returns info of Near-RT RIC queried by the ric-id and managed-element-id
tags:
- NearRT-RIC Repository
/actuator/shutdown:
post:
+ x-internal: true
operationId: shutdown
responses:
"200":
$ref: '#/components/examples/policy_type_id_list'
schema:
$ref: '#/components/schemas/policy_type_id_list'
- description: Policy type IDs
+ description: OK - Policy Type IDs Found
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Near-RT RIC is not found
- summary: Query policy type identities
+ $ref: '#/components/responses/NotFound'
+ description: 'Not Found - Requested Policy Type IDs Not Found'
+ description: Query policy type identities
tags:
- A1 Policy Management
/a1-policy/v2/policies/{policy_id}:
delete:
+ description: Deleting the policy using the Policy's Policy ID.
operationId: deletePolicy
parameters:
- explode: false
'*/*':
schema:
$ref: '#/components/schemas/void'
- description: Not used
+ description: OK - Policy deleted
"423":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: Near-RT RIC is not operational
- "204":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- description: Policy deleted
- "404":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: Policy is not found
+ $ref: '#/components/responses/Locked'
+ description: 'The requested policy using policy_id is Locked'
summary: Delete a policy
tags:
- A1 Policy Management
examples:
policy_info:
$ref: '#/components/examples/policy_info'
- description: Policy found
+ description: OK - Policy found
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Policy is not found
- summary: Returns a policy
+ $ref: '#/components/responses/NotFound'
+ description: 'Not Found - Requested Policy using policy_id is not found'
+ description: Returns a policy
tags:
- A1 Policy Management
/actuator/metrics/{requiredMetricName}:
get:
+ x-internal: true
operationId: metrics-requiredMetricName
parameters:
- explode: false
- Actuator
/a1-policy/v2/configuration:
get:
+ x-internal: true
operationId: getConfiguration
responses:
"200":
application/json:
schema:
type: string
- description: Configuration
+ description: OK - Configuration
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: File is not found or readable
- summary: Returns the contents of the application configuration file
+ $ref: '#/components/responses/NotFound'
+ description: Not Found - Configuration is not found or readable
+ description: Returns the contents of the application configuration file
tags:
- - configuration
+ - Configuration
put:
+ x-internal: true
operationId: putConfiguration
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/void'
- description: Configuration updated
+ description: OK - Configuration updated
"400":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: Invalid configuration provided
- "500":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: Something went wrong when replacing the configuration. Try
- again.
- summary: Replace the current configuration file with the given configuration
+ $ref: '#/components/responses/BadRequest'
+ description: Replace the current configuration with the given configuration
tags:
- - configuration
+ - Configuration
/actuator:
get:
+ x-internal: true
operationId: links
responses:
"200":
- Actuator
/actuator/loggers/{name}:
get:
+ x-internal: true
operationId: loggers-name
parameters:
- explode: false
tags:
- Actuator
post:
+ x-internal: true
operationId: loggers-name_2
parameters:
- explode: false
'*/*':
schema:
type: object
- description: "Service supervision timer refreshed, OK"
+ description: "OK - Service supervision timer refreshed, OK"
"404":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: "The service is not found, needs re-registration"
+ $ref: '#/components/responses/NotFound'
summary: Heartbeat indicates that the service is running
tags:
- Service Registry and Supervision
/actuator/metrics:
get:
+ x-internal: true
operationId: metrics
responses:
"200":
$ref: '#/components/examples/ric_info_list'
description: OK
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Policy type is not found
+ $ref: '#/components/responses/NotFound'
summary: Query Near-RT RIC information
tags:
- NearRT-RIC Repository
$ref: '#/components/examples/service_status_list'
description: OK
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Service is not found
+ $ref: '#/components/responses/NotFound'
summary: Returns service information
tags:
- Service Registry and Supervision
'*/*':
schema:
type: object
- description: Service updated
+ description: OK - Service updated
"201":
content:
'*/*':
schema:
type: object
- description: Service created
+ description: Created - Service created
"400":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: The ServiceRegistrationInfo is not accepted
+ $ref: '#/components/responses/BadRequest'
summary: Register a service
tags:
- Service Registry and Supervision
callbacks:
RICStatus:
"{$request.body#/callback_url}":
- post:
- 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":
+ post:
+ description: The URL to this call is registered at Service registration.
+ operationId: serviceCallback
+ requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/void'
- description: OK
- summary: Callback for Near-RT RIC status
- tags:
- - Service callbacks
+ $ref: '#/components/schemas/service_callback_info_v2'
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/void'
+ description: OK
+ "404":
+ $ref: '#/components/responses/NotFound'
+ summary: Callback for Near-RT RIC status
+ tags:
+ - Service callbacks
/actuator/info:
get:
+ x-internal: true
operationId: info
responses:
"200":
'*/*':
schema:
type: string
- description: Service is living
- summary: Returns status and statistics of this service
+ description: OK - Service is living
+ description: Returns status and statistics of this service
tags:
- Health Check
/a1-policy/v2/policy-types/{policytype_id}:
examples:
policy_type_definition:
$ref: '#/components/examples/policy_type_definition'
- description: schema of the given policy type
+ description: OK - schema of the given policy type
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Policy type is not found
- summary: Returns a policy type definition
+ $ref: '#/components/responses/NotFound'
+ description: Returns a policy type definition
tags:
- A1 Policy Management
/actuator/logfile:
get:
+ x-internal: true
operationId: logfile
responses:
"200":
- Actuator
/actuator/health:
get:
+ x-internal: true
operationId: health
responses:
"200":
$ref: '#/components/examples/policy_id_list'
schema:
$ref: '#/components/schemas/policy_id_list'
- description: Policy identities
+ description: OK - Policy identities
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Near-RT RIC or type not found
+ $ref: '#/components/responses/NotFound'
summary: Query policy identities
tags:
- A1 Policy Management
application/json:
schema:
$ref: '#/components/schemas/void'
- description: Policy updated
+ description: OK - Policy updated
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/void'
- description: Policy created
+ description: Created - Policy created
"423":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Near-RT RIC is not operational
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Near-RT RIC or policy type is not found
- summary: Create or update a policy
+ $ref: '#/components/responses/Locked'
+ description: Create or update a policy
tags:
- A1 Policy Management
/a1-policy/v2/services/{service_id}:
type: string
style: simple
responses:
- "200":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/void'
- description: Not used
"204":
content:
'*/*':
schema:
type: object
- description: Service unregistered
+ description: No Content - Service unregistered
"404":
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/error_information'
- description: Service not found
- summary: Unregister a service
+ $ref: '#/components/responses/NotFound'
+ description: Unregister a service
tags:
- Service Registry and Supervision
/actuator/heapdump:
get:
+ x-internal: true
operationId: heapdump
responses:
"200":
"200":
content:
application/json:
+ schema:
+ $ref: '#/components/schemas/policy_status_info'
examples:
policy_status_info:
$ref: '#/components/examples/policy_status_info'
- schema:
- $ref: '#/components/schemas/policy_status_info'
- description: Policy status
+ description: OK - Policy status
"404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/error_information'
- description: Policy is not found
- summary: Returns a policy status
+ $ref: '#/components/responses/NotFound'
+ description: Returns a policy status
tags:
- A1 Policy Management
components:
+ 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
service_id: service_id
keep_alive_interval_seconds: 0
time_since_last_activity_seconds: 6
+
service_status_list:
description: List of service information
value:
description: A list of policy identities
value:
policy_ids:
- - policy_ids
- - policy_ids
+ - some_policy_id
+ - some_policy_id
policy_status_info:
description: Status for one A1-P Policy
value:
last_modified: last_modified
- status: "{}"
+ status:
+ value:
+ status: status
status_info:
value:
status: status
value:
ric_id: ric_id
managed_element_ids:
- - managed_element_ids
- - managed_element_ids
+ - some_managed_element_id
+ - some_managed_element_id
state: UNAVAILABLE
policytype_ids:
- - policytype_ids
- - policytype_ids
+ - some_policytype_id
+ - some_policytype_id
ric_info_list:
value:
rics:
- ric_id: ric_id
managed_element_ids:
- - managed_element_ids
- - managed_element_ids
+ - some_managed_element_id
+ - some_managed_element_id
state: UNAVAILABLE
policytype_ids:
- - policytype_ids
- - policytype_ids
+ - policytype_id
+ - policytype_id
- ric_id: ric_id
managed_element_ids:
- managed_element_ids
policytype_ids:
- policytype_ids
- policytype_ids
+
schemas:
policy_type_definition:
description: Contains policy type schema definition
of the problem.'
example: Policy type not found
type: string
+ title:
+ description: 'A specific error name'
+ type: string
+ example: Not Found
status:
description: 'The HTTP status code generated by the origin server for this
occurrence of the problem. '
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
required:
- ric_id
- policy_id
- - service_id
- policy_data
- policytype_id
type: object
type: boolean
href:
type: string
- type: object
+ type: object
\ No newline at end of file
Code Review / ccsdk / oran.git / commitdiff
