-openapi: 3.0.1
+# ============LICENSE_START=======================================================
+# Copyright (C) 2020-2023 Nordix Foundation
+# Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
+# Modifications Copyright (C) 2021 Pantheon.tech
+# Modifications Copyright (C) 2021 Bell Canada
+# ================================================================================
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+openapi: 3.0.3
info:
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\
\ 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.
+ 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
title: A1 Policy Management Service
version: 1.2.0
servers:
-- url: /
+ - url: /
tags:
-- 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: Authorization API
-- 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
+ - 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
+ 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:
\ are returned."
operationId: getPolicyInstances
parameters:
- - description: Select policies with a given type identity.
- explode: true
- in: query
- name: policytype_id
- required: false
- schema:
- type: string
- style: form
- - description: Select policies for a given Near-RT RIC identity.
- explode: true
- in: query
- name: ric_id
- required: false
- schema:
- type: string
- style: form
- - description: Select policies owned by a given service.
- explode: true
- in: query
- name: service_id
- required: false
- schema:
- type: string
- style: form
- - description: Select policies of a given type name (type identity has the format
- <typename_version>)
- explode: true
- in: query
- name: type_name
- required: false
- schema:
- type: string
- style: form
+ - description: Select policies with a given type identity.
+ explode: true
+ in: query
+ name: policytype_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select policies for a given Near-RT RIC identity.
+ explode: true
+ in: query
+ name: ric_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select policies owned by a given service.
+ explode: true
+ in: query
+ name: service_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select policies of a given type name (type identity has the format
+ <typename_version>)
+ explode: true
+ in: query
+ name: type_name
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/json:
+ examples:
+ policy_info_list:
+ $ref: '#/components/examples/policy_info_list'
schema:
- $ref: '#/components/schemas/policy_info_list_v2'
+ $ref: '#/components/schemas/policy_info_list'
description: Policies
"404":
content:
description: "Near-RT RIC, policy type or service not found"
summary: Query for A1 policy instances
tags:
- - A1 Policy Management
+ - A1 Policy Management
/example-authz-check:
post:
description: The authorization function decides if access is granted.
description: OK
summary: Request for access authorization.
tags:
- - Authorization API
+ - Authorization API
/actuator/threaddump:
get:
operationId: threaddump
description: OK
summary: Actuator web endpoint 'threaddump'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/status:
get:
operationId: getStatus
content:
application/json:
schema:
- $ref: '#/components/schemas/status_info_v2'
+ $ref: '#/components/schemas/status_info'
+ examples:
+ status_info:
+ $ref: '#/components/examples/status_info'
description: Service is living
summary: Returns status and statistics of this service
tags:
- - Health Check
+ - Health Check
/actuator/loggers:
get:
operationId: loggers
description: OK
summary: Actuator web endpoint 'loggers'
tags:
- - Actuator
+ - Actuator
/actuator/health/**:
get:
operationId: health-path
description: OK
summary: Actuator web endpoint 'health-path'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/rics/ric:
get:
description: Either a Near-RT RIC identity or a Managed Element identity can
in O1 for accessing the traffical element (such as the ID of CU).
operationId: getRic
parameters:
- - description: "The identity of a Managed Element. If given, the Near-RT RIC\
+ - description: "The identity of a Managed Element. If given, the Near-RT RIC\
\ managing the ME is returned."
- explode: true
- in: query
- name: managed_element_id
- required: false
- schema:
- type: string
- style: form
- - description: The identity of a Near-RT RIC to get information for.
- explode: true
- in: query
- name: ric_id
- required: false
- schema:
- type: string
- style: form
+ explode: true
+ in: query
+ name: managed_element_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: The identity of a Near-RT RIC to get information for.
+ explode: true
+ in: query
+ name: ric_id
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ric_info_v2'
+ $ref: '#/components/schemas/ric_info'
+ examples:
+ ric_info:
+ $ref: '#/components/examples/ric_info'
description: Near-RT RIC is found
"404":
content:
description: Near-RT RIC is not found
summary: Returns info for one Near-RT RIC
tags:
- - NearRT-RIC Repository
+ - NearRT-RIC Repository
/actuator/shutdown:
post:
operationId: shutdown
description: OK
summary: Actuator web endpoint 'shutdown'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/policy-types:
get:
operationId: getPolicyTypes
parameters:
- - description: Select types for the given Near-RT RIC identity.
- explode: true
- in: query
- name: ric_id
- required: false
- schema:
- type: string
- style: form
- - description: Select types with the given type name (type identity has the
- format <typename_version>)
- explode: true
- in: query
- name: type_name
- required: false
- schema:
- type: string
- style: form
- - 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.
- explode: true
- in: query
- name: compatible_with_version
- required: false
- schema:
- type: string
- style: form
+ - description: Select types for the given Near-RT RIC identity.
+ explode: true
+ in: query
+ name: ric_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select types with the given type name (type identity has the
+ format <typename_version>)
+ explode: true
+ in: query
+ name: type_name
+ required: false
+ schema:
+ type: string
+ style: form
+ - 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.
+ explode: true
+ in: query
+ name: compatible_with_version
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/json:
+ examples:
+ policy_type_id_list:
+ $ref: '#/components/examples/policy_type_id_list'
schema:
- $ref: '#/components/schemas/policytype_id_list_v2'
+ $ref: '#/components/schemas/policy_type_id_list'
description: Policy type IDs
"404":
content:
description: Near-RT RIC is not found
summary: Query policy type identities
tags:
- - A1 Policy Management
+ - A1 Policy Management
/a1-policy/v2/policies/{policy_id}:
delete:
operationId: deletePolicy
parameters:
- - explode: false
- in: path
- name: policy_id
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: policy_id
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
description: Policy is not found
summary: Delete a policy
tags:
- - A1 Policy Management
+ - A1 Policy Management
get:
operationId: getPolicy
parameters:
- - explode: false
- in: path
- name: policy_id
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: policy_id
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/policy_info_v2'
+ $ref: '#/components/schemas/policy_info'
+ examples:
+ policy_info:
+ $ref: '#/components/examples/policy_info'
description: Policy found
"404":
content:
description: Policy is not found
summary: Returns a policy
tags:
- - A1 Policy Management
+ - A1 Policy Management
/actuator/metrics/{requiredMetricName}:
get:
operationId: metrics-requiredMetricName
parameters:
- - explode: false
- in: path
- name: requiredMetricName
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: requiredMetricName
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
description: OK
summary: Actuator web endpoint 'metrics-requiredMetricName'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/configuration:
get:
operationId: getConfiguration
content:
application/json:
schema:
- type: object
+ type: string
description: Configuration
"404":
content:
description: File is not found or readable
summary: Returns the contents of the application configuration file
tags:
- - Management of configuration
+ - configuration
put:
operationId: putConfiguration
requestBody:
again.
summary: Replace the current configuration file with the given configuration
tags:
- - Management of configuration
+ - configuration
/actuator:
get:
operationId: links
description: OK
summary: Actuator root web endpoint
tags:
- - Actuator
+ - Actuator
/actuator/loggers/{name}:
get:
operationId: loggers-name
parameters:
- - explode: false
- in: path
- name: name
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: name
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
description: OK
summary: Actuator web endpoint 'loggers-name'
tags:
- - Actuator
+ - Actuator
post:
operationId: loggers-name_2
parameters:
- - explode: false
- in: path
- name: name
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: name
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/json:
schema:
enum:
- - TRACE
- - DEBUG
- - INFO
- - WARN
- - ERROR
- - FATAL
- - "OFF"
+ - TRACE
+ - DEBUG
+ - INFO
+ - WARN
+ - ERROR
+ - FATAL
+ - "OFF"
type: string
responses:
"200":
description: OK
summary: Actuator web endpoint 'loggers-name'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/services/{service_id}/keepalive:
put:
description: A registered service should invoke this operation regularly to
when each service is initially registered)
operationId: keepAliveService
parameters:
- - explode: false
- in: path
- name: service_id
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: service_id
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
description: "The service is not found, needs re-registration"
summary: Heartbeat indicates that the service is running
tags:
- - Service Registry and Supervision
+ - Service Registry and Supervision
/actuator/metrics:
get:
operationId: metrics
description: OK
summary: Actuator web endpoint 'metrics'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/rics:
get:
description: The call returns all Near-RT RICs that supports a given policy
type identity
operationId: getRics
parameters:
- - description: "The identity of a policy type. If given, all Near-RT RICs supporting\
+ - description: "The identity of a policy type. If given, all Near-RT RICs supporting\
\ the policy type are returned"
- explode: true
- in: query
- name: policytype_id
- required: false
- schema:
- type: string
- style: form
+ explode: true
+ in: query
+ name: policytype_id
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ric_info_list_v2'
+ $ref: '#/components/schemas/ric_info_list'
+ examples:
+ ric_info_list:
+ $ref: '#/components/examples/ric_info_list'
description: OK
"404":
content:
description: Policy type is not found
summary: Query Near-RT RIC information
tags:
- - NearRT-RIC Repository
+ - NearRT-RIC Repository
/a1-policy/v2/services:
get:
description: Either information about a registered service with given identity
or all registered services are returned.
operationId: getServices
parameters:
- - description: The identity of the service
- explode: true
- in: query
- name: service_id
- required: false
- schema:
- type: string
- style: form
+ - description: The identity of the service
+ explode: true
+ in: query
+ name: service_id
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/service_list_v2'
+ $ref: '#/components/schemas/service_status_list'
+ examples:
+ service_status_list:
+ $ref: '#/components/examples/service_status_list'
description: OK
"404":
content:
description: Service is not found
summary: Returns service information
tags:
- - Service Registry and Supervision
+ - Service Registry and Supervision
put:
description: "Registering a service is needed to:<ul><li>Get callbacks about\
\ available NearRT RICs.</li><li>Activate supervision of the service. If a\
content:
application/json:
schema:
- $ref: '#/components/schemas/service_registration_info_v2'
+ $ref: '#/components/schemas/service_registration_info'
required: true
responses:
"200":
description: The ServiceRegistrationInfo is not accepted
summary: Register a service
tags:
- - Service Registry and Supervision
+ - 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":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/void'
+ description: OK
+ summary: Callback for Near-RT RIC status
+ tags:
+ - Service callbacks
/actuator/info:
get:
operationId: info
description: OK
summary: Actuator web endpoint 'info'
tags:
- - Actuator
+ - Actuator
/status:
get:
operationId: getStatusV1
description: Service is living
summary: Returns status and statistics of this service
tags:
- - Health Check
+ - Health Check
/a1-policy/v2/policy-types/{policytype_id}:
get:
- operationId: getPolicyType
+ operationId: getPolicyTypeDefinition
parameters:
- - explode: false
- in: path
- name: policytype_id
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: policytype_id
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
- '*/*':
+ application/json:
schema:
- $ref: '#/components/schemas/policytype_v2'
- description: Policy type
+ $ref: '#/components/schemas/policy_type_definition'
+ examples:
+ policy_type_definition:
+ $ref: '#/components/examples/policy_type_definition'
+ description: 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
tags:
- - A1 Policy Management
+ - A1 Policy Management
/actuator/logfile:
get:
operationId: logfile
description: OK
summary: Actuator web endpoint 'logfile'
tags:
- - Actuator
+ - Actuator
/actuator/health:
get:
operationId: health
description: OK
summary: Actuator web endpoint 'health'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/policies:
get:
description: "Returns a list of A1 policies matching given search criteria.\
\ are returned."
operationId: getPolicyIds
parameters:
- - description: Select policies of a given policy type identity.
- explode: true
- in: query
- name: policytype_id
- required: false
- schema:
- type: string
- style: form
- - description: Select policies of a given Near-RT RIC identity.
- explode: true
- in: query
- name: ric_id
- required: false
- schema:
- type: string
- style: form
- - description: Select policies owned by a given service.
- explode: true
- in: query
- name: service_id
- required: false
- schema:
- type: string
- style: form
- - description: Select policies of types with the given type name (type identity
- has the format <typename_version>)
- explode: true
- in: query
- name: type_name
- required: false
- schema:
- type: string
- style: form
+ - description: Select policies of a given policy type identity.
+ explode: true
+ in: query
+ name: policytype_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select policies of a given Near-RT RIC identity.
+ explode: true
+ in: query
+ name: ric_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select policies owned by a given service.
+ explode: true
+ in: query
+ name: service_id
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Select policies of types with the given type name (type identity
+ has the format <typename_version>)
+ explode: true
+ in: query
+ name: type_name
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/json:
+ examples:
+ policy_id_list:
+ $ref: '#/components/examples/policy_id_list'
schema:
- $ref: '#/components/schemas/policy_id_list_v2'
+ $ref: '#/components/schemas/policy_id_list'
description: Policy identities
"404":
content:
description: Near-RT RIC or type not found
summary: Query policy identities
tags:
- - A1 Policy Management
+ - A1 Policy Management
put:
operationId: putPolicy
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/policy_info_v2'
+ $ref: '#/components/schemas/policy_info'
required: true
responses:
"200":
description: Near-RT RIC or policy type is not found
summary: Create or update a policy
tags:
- - A1 Policy Management
- /r-app/near-rt-ric-status:
- 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":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/void'
- description: OK
- summary: Callback for Near-RT RIC status
- tags:
- - Service callbacks
+ - A1 Policy Management
/a1-policy/v2/services/{service_id}:
delete:
operationId: deleteService
parameters:
- - explode: false
- in: path
- name: service_id
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: service_id
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
description: Service not found
summary: Unregister a service
tags:
- - Service Registry and Supervision
+ - Service Registry and Supervision
/actuator/heapdump:
get:
operationId: heapdump
description: OK
summary: Actuator web endpoint 'heapdump'
tags:
- - Actuator
+ - Actuator
/a1-policy/v2/policies/{policy_id}/status:
get:
operationId: getPolicyStatus
parameters:
- - explode: false
- in: path
- name: policy_id
- required: true
- schema:
- type: string
- style: simple
+ - explode: false
+ in: path
+ name: policy_id
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
application/json:
+ examples:
+ policy_status_info:
+ $ref: '#/components/examples/policy_status_info'
schema:
- $ref: '#/components/schemas/policy_status_info_v2'
+ $ref: '#/components/schemas/policy_status_info'
description: Policy status
"404":
content:
description: Policy is not found
summary: Returns a policy status
tags:
- - A1 Policy Management
+ - A1 Policy Management
components:
+ 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
schemas:
+ policy_type_definition:
+ description: Contains policy type schema definition
+ 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
error_information:
description: Problem as defined in https://tools.ietf.org/html/rfc7807
properties:
void:
description: Void/empty
type: object
- status_info_v2:
- example:
- status: status
+ status_info:
properties:
status:
description: status text
description: "If true, the access is granted"
type: boolean
required:
- - result
+ - result
type: object
- ric_info_v2:
+ ric_info:
description: Information for a Near-RT RIC
- example:
- ric_id: ric_id
- managed_element_ids:
- - managed_element_ids
- - managed_element_ids
- state: UNAVAILABLE
- policytype_ids:
- - policytype_ids
- - policytype_ids
properties:
ric_id:
description: identity of the Near-RT RIC
state:
description: Represents the states for a Near-RT RIC
enum:
- - UNAVAILABLE
- - AVAILABLE
- - SYNCHRONIZING
- - CONSISTENCY_CHECK
+ - UNAVAILABLE
+ - AVAILABLE
+ - SYNCHRONIZING
+ - CONSISTENCY_CHECK
type: string
policytype_ids:
description: supported policy types
type: string
type: array
type: object
- service_registration_info_v2:
+ service_registration_info:
description: Information for one service
properties:
callback_url:
format: int64
type: integer
required:
- - service_id
+ - service_id
type: object
- policy_info_list_v2:
+ policy_info_list:
description: List of policy information
- example:
- 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
properties:
policies:
description: List of policy information
items:
- $ref: '#/components/schemas/policy_info_v2'
+ $ref: '#/components/schemas/policy_info'
type: array
type: object
- policy_status_info_v2:
+ policy_status_info:
description: Status for one A1-P Policy
- example:
- last_modified: last_modified
- status: "{}"
properties:
last_modified:
description: "timestamp, last modification time"
description: the Policy status
type: object
type: object
- service_status_v2:
- description: List of service information
- example:
- callback_url: callback_url
- service_id: service_id
- keep_alive_interval_seconds: 0
- time_since_last_activity_seconds: 6
+ service_status:
properties:
callback_url:
description: callback for notifying of RIC synchronization
format: int64
type: integer
type: object
- ric_info_list_v2:
+ ric_info_list:
description: List of Near-RT RIC information
- example:
- 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
properties:
rics:
description: List of Near-RT RIC information
items:
- $ref: '#/components/schemas/ric_info_v2'
+ $ref: '#/components/schemas/ric_info'
type: array
type: object
- policytype_v2:
- description: Policy type
- example:
- policy_schema: "{}"
- properties:
- policy_schema:
- description: Policy type json schema. The schema is a json object following
- http://json-schema.org/draft-07/schema
- type: object
- type: object
input:
description: input
properties:
access_type:
description: Access type
enum:
- - READ
- - WRITE
- - DELETE
+ - READ
+ - WRITE
+ - DELETE
type: string
auth_token:
description: Authorization token
description: Policy type identifier
type: string
required:
- - access_type
- - auth_token
- - policy_type_id
+ - access_type
+ - auth_token
+ - policy_type_id
type: object
policy_authorization:
description: Authorization request for A1 policy requests
input:
$ref: '#/components/schemas/input'
required:
- - input
+ - input
type: object
- policytype_id_list_v2:
+ policy_type_id_list:
description: Information about policy types
- example:
- policytype_ids:
- - policytype_ids
- - policytype_ids
properties:
policytype_ids:
description: Policy type identities
type: string
type: array
type: object
- policy_info_v2:
+ policy_info:
description: Information for one A1-P Policy
- example:
- 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
properties:
ric_id:
description: identity of the target Near-RT RIC
\ value is maintained by this service until explicitly deleted. Default\
\ false."
example: false
+ nullable: false
type: boolean
service_id:
description: the identity of the service owning the policy. This can be
description: identity of the policy type
type: string
required:
- - policy_data
- - policy_id
- - policytype_id
- - ric_id
+ - ric_id
+ - policy_id
+ - service_id
+ - policy_data
+ - policytype_id
type: object
- policy_id_list_v2:
+ policy_id_list:
description: A list of policy identities
example:
policy_ids:
- - policy_ids
- - policy_ids
+ - policy_ids
+ - policy_ids
properties:
policy_ids:
description: Policy identities
type: string
type: array
type: object
- service_list_v2:
- description: List of service information
- example:
- 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
+ service_status_list:
properties:
service_list:
description: List of service information
items:
- $ref: '#/components/schemas/service_status_v2'
+ $ref: '#/components/schemas/service_status'
type: array
type: object
service_callback_info_v2:
description: "values:\nAVAILABLE: the Near-RT RIC has become available\
\ for A1 Policy management"
enum:
- - AVAILABLE
+ - AVAILABLE
type: string
required:
- - event_type
- - ric_id
+ - event_type
+ - ric_id
type: object
Link:
properties:
Code Review / ccsdk / oran.git / blobdiff