diff options
Diffstat (limited to 'docs/offeredapis/swagger/pms-api-v3.yaml')
| -rw-r--r-- | docs/offeredapis/swagger/pms-api-v3.yaml | 34 |
1 files changed, 16 insertions, 18 deletions
diff --git a/docs/offeredapis/swagger/pms-api-v3.yaml b/docs/offeredapis/swagger/pms-api-v3.yaml index 8bcfdf4b..e21f679e 100644 --- a/docs/offeredapis/swagger/pms-api-v3.yaml +++ b/docs/offeredapis/swagger/pms-api-v3.yaml @@ -1,5 +1,5 @@ # ============LICENSE_START======================================================= -# Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. +# Copyright (C) 2024 - 2025 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. @@ -22,7 +22,7 @@ info: version: 1.0.0 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\ + description: "<h2>General</h2><p>The ONAP CCSDK A1 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\ @@ -47,7 +47,7 @@ info: \ for access control of A1 Policy access. If configured, an external authorization\ \ provider is requested to grant access to the A1 Policy type.</p>" license: - name: Copyright (C) 2024 OpenInfra Foundation Europe. Licensed under the Apache License. + name: Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License. url: http://www.apache.org/licenses/LICENSE-2.0 contact: url: https://www.onap.org/ @@ -57,17 +57,17 @@ servers: variables: apiRoot: default: 'https://example.com' - description: 'This is the Host:Port or Address where the A1-Policy Management Service can be accessed' + description: 'This is the Host:Port or Address where the A1-Policy Management Service can be accessed. + Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management' tags: - name: A1 Policy Management - description: "API used to create polices, Policy Instances and get \ them as individual using an ID or get all policies/Instances." + description: "**(Newer Version)** 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: Configuration description: "API used to create or fetch the application configuration." paths: @@ -761,7 +761,7 @@ paths: RICStatus: "{$request.body#/callback_url}": post: - description: The URL to this call is registered at Service registration. + description: 'The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.' operationId: serviceCallback requestBody: content: @@ -778,9 +778,7 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: Callback for Near-RT RIC status - tags: - - Service callbacks + summary: "Callback for Near-RT RIC status." /services/{serviceId}: delete: operationId: deleteService @@ -953,19 +951,19 @@ components: type: object properties: nearRtRicId: - description: identity of the target Near-RT RIC + description: Identity of the target Near-RT RIC type: string example: 'Near-RT-Ric-ID' transient: default: false - description: "if true, the policy is deleted at RIC restart. If false, its\ + 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 type: boolean policyId: - description: identity of the Policy + description: The identity of the Policy. If this value is present, it must be unique; otherwise, a random UUID is generated. type: string example: 'POLICY-ID' @@ -979,7 +977,7 @@ components: policyObject: $ref: '#/components/schemas/PolicyObject' policyTypeId: - description: identity of the policy type + description: Identity of the policy type type: string example: 'ORAN_QOS_1.0.0(typeName_SemVersion)' required: @@ -1090,7 +1088,7 @@ components: description: Information for a Near-RT RIC properties: ricId: - description: identity of the Near-RT RIC + description: Identity of the Near-RT RIC type: string managedElementIds: description: O1 identities for managed entities @@ -1120,7 +1118,7 @@ components: description: callback for notifying of Near-RT RIC state changes type: string serviceId: - description: identity of the service + description: Identity of the service type: string keepAliveIntervalSeconds: description: "keep alive interval for the service. This is used to enable\ @@ -1151,7 +1149,7 @@ components: description: callback for notifying of RIC synchronization type: string serviceId: - description: identity of the service + description: Identity of the service type: string keepAliveIntervalSeconds: description: policy keep alive timeout @@ -1230,7 +1228,7 @@ components: description: Information transferred as in Service callbacks (callback_url) properties: ricId: - description: identity of a Near-RT RIC + description: Identity of a Near-RT RIC type: string eventType: description: "values:\nAVAILABLE: the Near-RT RIC has become available\ |