diff options
Diffstat (limited to 'docs/offeredapis/swagger/pms-api.yaml')
| -rw-r--r-- | docs/offeredapis/swagger/pms-api.yaml | 1732 |
1 files changed, 921 insertions, 811 deletions
diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml index ea6d5d1e..5f54504f 100644 --- a/docs/offeredapis/swagger/pms-api.yaml +++ b/docs/offeredapis/swagger/pms-api.yaml @@ -19,87 +19,83 @@ openapi: 3.0.3 info: - x-api-id: a31c510b-20e6-4a08-af16-368c44d7fba8 - x-audience: external-public - description: "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service\ - \ provides a REST API for managing A1 policies. <br/>This document describes an older pre-spec API set - \ to perform tasks for: </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 each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services\ - \ (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs\ - \ provided or defined by the service</h2><h3>A1 Policy Management (Older pre-spec version) </h3>\ - \ <p>This is an older API for managing 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 (Older version)</h3>\ - \ <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy\ - \ is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision\ - \ of the A1 Policy Management Service .</p><h3>Service Registry and Supervision</h3>\ - \ <p>API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner.\ - \ If the owner service is registered, then the service can be monitored by a heart-beat supervision\ - \ mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note \ - \ that services do not need to be registered to create A1 Policies, but unregistered services are not \ - \ supervised. 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 built-in functions used to monitor and configure the Spring\ - \ web application hosting the service.</p>" + contact: + email: discuss-list@onap.com + name: ONAP CCSDK Project + url: https://www.onap.org/ + description: "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides\ + \ a REST API for managing A1 policies. <br/>This document describes an older pre-spec\ + \ API set to perform tasks for: </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 each Near-RT\ + \ RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps).\ + \ When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs\ + \ provided or defined by the service</h2><h3>A1 Policy Management (Older pre-spec\ + \ version) </h3> <p>This is an older API for managing 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 (Older version)</h3>\ + \ <p>This is an API that provides support for looking up a NearRT-RIC. Each A1\ + \ policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used\ + \ for supervision of the A1 Policy Management Service .</p><h3>Service Registry\ + \ and Supervision</h3> <p>API used for registering services/clients/rApps. Each\ + \ A1 Policy can be tagged with an owner. If the owner service is registered, then\ + \ the service can be monitored by a heart-beat supervision mechanism, and if the\ + \ registered service becomes unavailable, then its A1 Policies are removed. Note\ + \ that services do not need to be registered to create A1 Policies, but unregistered\ + \ services are not supervised. 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 built-in functions used to\ + \ monitor and configure the Spring web application hosting the service.</p>" license: - name: | - Copyright (C) 2020-2023 Nordix Foundation, and Copyright (C) 2024-2025 OpenInfra Foundation Europe. - All rights reserved. Licensed under the Apache 2 License. + name: "Copyright (C) 2020-2023 Nordix Foundation, and Copyright (C) 2024-2025\ + \ OpenInfra Foundation Europe. \nAll rights reserved. Licensed under the Apache\ + \ 2 License.\n" url: http://www.apache.org/licenses/LICENSE-2.0 title: ONAP CCSDK - Pre-Spec A1 Policy Management API version: 1.3.0 - contact: - name: ONAP CCSDK Project - url: https://www.onap.org/ - email: discuss-list@onap.com + x-api-id: a31c510b-20e6-4a08-af16-368c44d7fba8 + x-audience: external-public servers: - - url: / +- url: / tags: - - name: A1 Policy Management - description: > - Older pre-spec API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types. - - name: NearRT-RIC Repository - description: > - Older API used to get information about registered Near-RT RICs. - - name: Service Registry and Supervision - description: > - Older API used to manage registered services, and control their keep-alive status via heart-beat messages. - - name: Health Check - description: > - API used to get the health status and statistics of this service - - name: Service Callbacks - description: > - Callout to registered services to indicate a status changes for a Near-RT RIC. - Note that these operations are called by the A1 Policy Management Service, not provided. - - name: Authorization API - description: > - API used for authorization of information A1 policy access (this is - provided by an authorization producer such as OPA). - Note that these operations are called by the A1 Policy Management Service, not provided. - - name: Configuration - description: > - API used to create or fetch the application configuration. - - name: Actuator API - description: > - API used to monitor and configure the A1-PMS Springboot Service. - externalDocs: - description: Spring Boot Actuator Web API Documentation - url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - +- description: | + Older pre-spec API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types. + name: A1 Policy Management +- description: | + Older API used to get information about registered Near-RT RICs. + name: NearRT-RIC Repository +- description: | + Older API used to manage registered services, and control their keep-alive status via heart-beat messages. + name: Service Registry and Supervision +- description: | + API used to get the health status and statistics of this service + name: Health Check +- description: | + Callout to registered services to indicate a status changes for a Near-RT RIC. Note that these operations are called by the A1 Policy Management Service, not provided. + name: Service Callbacks +- description: | + API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA). Note that these operations are called by the A1 Policy Management Service, not provided. + name: Authorization API +- description: | + API used to create or fetch the application configuration. + name: Configuration +- description: | + API used to monitor and configure the A1-PMS Springboot Service. + externalDocs: + description: Spring Boot Actuator Web API Documentation + url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html + name: Actuator API paths: /status: get: - operationId: getStatusV1 description: Returns status and statistics of this service - summary: Get Status (getStatusV1) - tags: - - Health Check + operationId: getStatusV1 responses: "200": content: @@ -107,100 +103,100 @@ paths: schema: type: string description: OK - Service is living + summary: Get Status (getStatusV1) + tags: + - Health Check /a1-policy/v2/status: get: - operationId: getStatus description: Returns status and statistics of this service - summary: Get Status (getStatus) - tags: - - Health Check + operationId: getStatus responses: "200": content: application/json: - schema: - $ref: '#/components/schemas/status_info' examples: status_info: $ref: '#/components/examples/status_info' + schema: + $ref: '#/components/schemas/status_info' description: OK- Service is living Ok + summary: Get Status (getStatus) + tags: + - Health Check /a1-policy/v2/rics/ric: get: - description: > - Query information about a Near-RT RIC. Either a Near-RT RIC identity or a Managed Element - identity can be specified. The intention with Managed Element identity is the ID used - in O1 for accessing the traffical element (such as the ID of CU). + description: | + Query information about a Near-RT RIC. Either a Near-RT RIC identity or a Managed Element identity can be specified. The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU). operationId: getRic - summary: Get a Near-RT RIC (getRic) - tags: - - NearRT-RIC Repository parameters: - - 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 + - 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 responses: "200": content: application/json: - schema: - $ref: '#/components/schemas/ric_info' examples: ric_info: $ref: '#/components/examples/ric_info' + schema: + $ref: '#/components/schemas/ric_info' description: OK - Near-RT RIC is found "404": - $ref: '#/components/responses/NotFound' - description: NotFound - Requested NearRT-RIC Not Found + content: + application/problem+json: + example: [] + description: Not Found + summary: Get a Near-RT RIC (getRic) + tags: + - NearRT-RIC Repository /a1-policy/v2/policy-types: get: - operationId: getPolicyTypes description: Query A1 Policy Type identities using query parameters - summary: Get A1 Policy Types (getPolicyTypes) - tags: - - A1 Policy Management + 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 compatible 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 compatible 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: @@ -212,23 +208,25 @@ paths: $ref: '#/components/schemas/policy_type_id_list' description: OK - Policy Type IDs Found "404": - $ref: '#/components/responses/NotFound' - description: 'Not Found - Requested Policy Type IDs Not Found' + content: + application/problem+json: + example: [] + description: Not Found + summary: Get A1 Policy Types (getPolicyTypes) + tags: + - A1 Policy Management /a1-policy/v2/policies/{policy_id}: delete: description: Delete an A1 Policy instance using its policy ID. operationId: deletePolicy - summary: Delete an A1 Policy instance (deletePolicy) - tags: - - A1 Policy Management 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: @@ -237,138 +235,179 @@ paths: $ref: '#/components/schemas/void' description: OK - Policy deleted "423": - $ref: '#/components/responses/Locked' - description: 'The requested policy using policy_id is Locked' + content: + application/problem+json: + example: + status: 423 + title: Locked + detail: Requested resource is in a locked state. + schema: + $ref: '#/components/schemas/error_information' + description: Locked - HTTP Status code which can be used when the state + is Locked + summary: Delete an A1 Policy instance (deletePolicy) + tags: + - A1 Policy Management get: description: Get an A1 Policy instance using its policy ID operationId: getPolicy - summary: Get an A1 Policy instance (getPolicy) - tags: - - A1 Policy Management 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' examples: policy_info: $ref: '#/components/examples/policy_info' + schema: + $ref: '#/components/schemas/policy_info' description: OK - Policy found "404": - $ref: '#/components/responses/NotFound' - description: 'Not Found - Requested Policy using policy_id is not found' + content: + application/problem+json: + example: [] + description: Not Found + summary: Get an A1 Policy instance (getPolicy) + tags: + - A1 Policy Management /a1-policy/v2/services/{service_id}/keepalive: put: - description: A registered service should invoke this operation regularly to - indicate that it is still alive. If a registered service fails to invoke some operation, - or this operation, before the end of a timeout period the service will be deregistered - and all its A1 policies wil be removed. This operation is only intended for registered - services. (This timeout can be set or disabled when each service is initially registered) + description: "A registered service should invoke this operation regularly to\ + \ indicate that it is still alive. If a registered service fails to invoke\ + \ some operation, or this operation, before the end of a timeout period the\ + \ service will be deregistered and all its A1 policies wil be removed. This\ + \ operation is only intended for registered services. (This timeout can be\ + \ set or disabled when each service is initially registered)" operationId: keepAliveService - summary: Heartbeat message from a service (keepAliveService) - tags: - - Service Registry and Supervision 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: '*/*': schema: type: object - description: OK - Service supervision timer refreshed, OK + description: "OK - Service supervision timer refreshed, OK" "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Heartbeat message from a service (keepAliveService) + tags: + - Service Registry and Supervision /a1-policy/v2/rics: get: description: Get all Near-RT RICs that supports a given A1 Policy Type ID operationId: getRics - summary: Get Near-RT RICs for A1 Policy Type (getRics) - tags: - - NearRT-RIC Repository parameters: - - description: > - The identity of an A1 Policy Type. If given, all Near-RT RICs supporting - the A1 Policy Type are returned. - explode: true - in: query - name: policytype_id - required: false - schema: - type: string - style: form + - description: | + The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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' examples: ric_info_list: $ref: '#/components/examples/ric_info_list' + schema: + $ref: '#/components/schemas/ric_info_list' description: OK "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Get Near-RT RICs for A1 Policy Type (getRics) + tags: + - NearRT-RIC Repository /a1-policy/v2/services: get: - description: > - Get information about all registered services, or a single registered service. - If the service ID of a registered service is included in the query, information about that - service is returned. Otherwise Information about all registered is returned. - This operation does not retrieve information about unregistered services. + description: | + Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services. operationId: getServices - summary: Get Services (getServices) - tags: - - Service Registry and Supervision parameters: - - description: The identity of the registered service - explode: true - in: query - name: service_id - required: false - schema: - type: string - style: form + - description: The identity of the registered 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_status_list' examples: service_status_list: $ref: '#/components/examples/service_status_list' + schema: + $ref: '#/components/schemas/service_status_list' description: OK "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Get Services (getServices) + tags: + - Service Registry and Supervision put: - description: > - Register a single service, or update a previous registtration. - Service registration is required to get callbacks about available NearRT RICs - and to enable supervision of the service's active status. If a registered - service becomes inactive, its policies can be automatically deleted. - A1 Policy instances can also be created for unregistered services. - If an unregistered service is later registered, the service's policies are - retained when the service becomes registered. This feature is optional to use. + callbacks: + RICStatus: + '{$request.body#/callback_url}': + post: + description: "Callouts to indicate Near-RT RIC status changes relevant\ + \ for Services. \nThe URL invoked by this callback is provided at\ + \ Service registration.\n" + 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 + "404": + content: + application/problem+json: + example: [] + description: Not Found + summary: Callback for Near-RT RIC status (serviceCallback) + tags: + - Service Registry and Supervision + - Service Callbacks + x-callback-request: true + description: | + Register a single service, or update a previous registtration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use. operationId: putService - summary: Register or update a Service (putService) - tags: - - Service Registry and Supervision requestBody: content: application/json: @@ -389,105 +428,88 @@ paths: type: object description: Created - Service created "400": - $ref: '#/components/responses/BadRequest' - callbacks: - RICStatus: - "{$request.body#/callback_url}": - post: - description: | - Callouts to indicate Near-RT RIC status changes relevant for Services. - The URL invoked by this callback is provided at Service registration. - operationId: serviceCallback - summary: Callback for Near-RT RIC status (serviceCallback) - tags: - - Service Registry and Supervision - - Service Callbacks - 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 - "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: + status: 400 + title: Bad Request + detail: The provided request is not valid. + schema: + $ref: '#/components/schemas/error_information' + description: Bad Request + summary: Register or update a Service (putService) + tags: + - Service Registry and Supervision /a1-policy/v2/policy-types/{policytype_id}: get: description: Get an A1 Policy Type definition using its policy type ID operationId: getPolicyTypeDefinition - summary: Get an A1 Policy Type definition (getPolicyTypeDefinition) - tags: - - A1 Policy Management 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/policy_type_definition' examples: policy_type_definition: $ref: '#/components/examples/policy_type_definition' + schema: + $ref: '#/components/schemas/policy_type_definition' description: OK - schema of the requested A1 Policy Type "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Get an A1 Policy Type definition (getPolicyTypeDefinition) + tags: + - A1 Policy Management /a1-policy/v2/policies: get: - description: > - Retrieve a list of A1 Policy Instance IDs for policies that match given search criteria. - If multiple query parameters are given, the policies matching all conditions are returned. + description: | + Retrieve a list of A1 Policy Instance IDs for policies that match given search criteria. If multiple query parameters are given, the policies matching all conditions are returned. operationId: getPolicyIds - summary: Query A1 Policy Instances (getPolicyIds) - tags: - - A1 Policy Management parameters: - - description: Select policies of a given A1 Policy Type ID. - 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. (Both registered and unregistered services) - explode: true - in: query - name: service_id - required: false - schema: - type: string - style: form - - description: > - Select policies of types with the given A1 Policy Type name - (type names have the format 'typename_version') - explode: true - in: query - name: type_name - required: false - schema: - type: string - style: form + - description: Select policies of a given A1 Policy Type ID. + 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. (Both registered and + unregistered services) + explode: true + in: query + name: service_id + required: false + schema: + type: string + style: form + - description: | + Select policies of types with the given A1 Policy Type name (type names have the format 'typename_version') + explode: true + in: query + name: type_name + required: false + schema: + type: string + style: form responses: "200": content: @@ -499,13 +521,16 @@ paths: $ref: '#/components/schemas/policy_id_list' description: OK - Policy identities "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Query A1 Policy Instances (getPolicyIds) + tags: + - A1 Policy Management put: description: Create or Update an A1 Policy Instance - tags: - - A1 Policy Management operationId: putPolicy - summary: Create or Update an A1 Policy Instance (putPolicy) requestBody: content: application/json: @@ -526,49 +551,58 @@ paths: $ref: '#/components/schemas/void' description: Created - Policy created "423": - $ref: '#/components/responses/Locked' + content: + application/problem+json: + example: + status: 423 + title: Locked + detail: Requested resource is in a locked state. + schema: + $ref: '#/components/schemas/error_information' + description: Locked - HTTP Status code which can be used when the state + is Locked + summary: Create or Update an A1 Policy Instance (putPolicy) + tags: + - A1 Policy Management /a1-policy/v2/policy-instances: get: - description: > - Returns a collection of A1 Policy Instance information for policies that match given search criteria. - If several query parameters are defined, the policies matching all conditions are returned. + description: | + Returns a collection of A1 Policy Instance information for policies that match given search criteria. If several query parameters are defined, the policies matching all conditions are returned. operationId: getPolicyInstances - summary: Query for A1 Policy instances (getPolicyInstances) - tags: - - A1 Policy Management parameters: - - description: Select policies with a given A1 Policy Type ID. - 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 (registered or unregistered). - explode: true - in: query - name: service_id - required: false - schema: - type: string - style: form - - description: Select policies of a given A1 Policy 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 A1 Policy Type ID. + 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 (registered or unregistered). + explode: true + in: query + name: service_id + required: false + schema: + type: string + style: form + - description: Select policies of a given A1 Policy 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: @@ -584,25 +618,24 @@ paths: application/json: schema: $ref: '#/components/schemas/error_information' - description: Not Found - Near-RT RIC, A1 Policy Type or service was not found + description: "Not Found - Near-RT RIC, A1 Policy Type or service was not\ + \ found" + summary: Query for A1 Policy instances (getPolicyInstances) + tags: + - A1 Policy Management /a1-policy/v2/services/{service_id}: delete: - description: > - Unregister a registered Service using its service ID. - Only registered services can be unregistered. All A1 Policy Instances - for the previously registered service will be removed. - tags: - - Service Registry and Supervision + description: | + Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed. operationId: deleteService - summary: Unregister a Service (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: "204": content: @@ -611,41 +644,47 @@ paths: type: object description: No Content - Service unregistered "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Unregister a Service (deleteService) + tags: + - Service Registry and Supervision /a1-policy/v2/policies/{policy_id}/status: get: description: Retrieve the status information for an A1 Policy Instance. - tags: - - A1 Policy Management operationId: getPolicyStatus - summary: Get an A1 Policy Instance's status (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: - 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: OK - Policy status "404": - $ref: '#/components/responses/NotFound' + content: + application/problem+json: + example: [] + description: Not Found + summary: Get an A1 Policy Instance's status (getPolicyStatus) + tags: + - A1 Policy Management /a1-policy/v2/configuration: get: description: Returns the entire contents of the Application Configuration. - tags: - - Configuration operationId: getConfiguration - summary: Get the Application Configuration (getConfiguration) responses: "200": content: @@ -654,18 +693,17 @@ paths: type: string description: OK - Configuration "404": - $ref: '#/components/responses/NotFound' - description: Not Found - Configuration is not found or is not readable - put: - description: > - Replace the current Application Configuration with a new configuration. - The new configuration, if accepted, will take effect after a short delay. - The new configuration must comply with the Application Configuration schema, - which can be found from the the Application Documentation (Developer Guide) + content: + application/problem+json: + example: [] + description: Not Found + summary: Get the Application Configuration (getConfiguration) tags: - - Configuration + - Configuration + put: + description: | + Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) operationId: putConfiguration - summary: Set/Replace the Application Configuration (putConfiguration) requestBody: content: application/json: @@ -680,16 +718,23 @@ paths: $ref: '#/components/schemas/void' description: OK - Configuration updated "400": - $ref: '#/components/responses/BadRequest' + content: + application/problem+json: + example: + status: 400 + title: Bad Request + detail: The provided request is not valid. + schema: + $ref: '#/components/schemas/error_information' + description: Bad Request + summary: Set/Replace the Application Configuration (putConfiguration) + tags: + - Configuration /example-authz-check: post: - description: > - A template endpoint for callout requests to an external authorization function. - The authorization function, if enabled, decides if individual operations are permitted. + description: | + A template endpoint for callout requests to an external authorization function. The authorization function, if enabled, decides if individual operations are permitted. operationId: performAccessControl - summary: Callout request for access authorization (performAccessControl) - tags: - - Authorization API requestBody: content: application/json: @@ -704,20 +749,27 @@ paths: $ref: '#/components/schemas/authorization_result' description: OK "403": - $ref: '#/components/responses/Forbidden' + content: + application/problem+json: + example: + status: 403 + title: Forbidden + detail: Your role does not allow to perform this action. Contact System + Administrator to change your access rights. + schema: + $ref: '#/components/schemas/error_information' + description: Forbidden + summary: Callout request for access authorization (performAccessControl) + tags: + - Authorization API /actuator: get: - x-internal: true - operationId: actuatorLinks - description: > - A1-PMS Springboot Service Actuator web endpoint. - Returns a set of links to available/enabled actuator endpoints. + description: | + A1-PMS Springboot Service Actuator web endpoint. Returns a set of links to available/enabled actuator endpoints. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Root (actuatorLinks) - tags: - - Actuator API + operationId: actuatorLinks responses: "200": content: @@ -743,18 +795,18 @@ paths: type: object type: object description: OK + summary: Actuator endpoint - Root (actuatorLinks) + tags: + - Actuator API + x-internal: true /actuator/heapdump: get: - x-internal: true - operationId: actuatorHeapdump - description: > - A1-PMS Springboot Service Actuator web endpoint - HeapDump. + description: | + A1-PMS Springboot Service Actuator web endpoint - HeapDump. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Heapdump (actuatorHeapdump) - tags: - - Actuator API + operationId: actuatorHeapdump responses: "200": content: @@ -762,18 +814,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Heapdump (actuatorHeapdump) + tags: + - Actuator API + x-internal: true /actuator/info: get: - x-internal: true - operationId: actuatorInfo - description: > - A1-PMS Springboot Service Actuator web endpoint - Info. + description: | + A1-PMS Springboot Service Actuator web endpoint - Info. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Info (actuatorInfo) - tags: - - Actuator API + operationId: actuatorInfo responses: "200": content: @@ -787,18 +839,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Info (actuatorInfo) + tags: + - Actuator API + x-internal: true /actuator/threaddump: get: - x-internal: true - operationId: actuatorThreaddump - description: > - A1-PMS Springboot Service Actuator web endpoint - ThreadDump. + description: | + A1-PMS Springboot Service Actuator web endpoint - ThreadDump. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Threaddump (actuatorThreaddump) - tags: - - Actuator API + operationId: actuatorThreaddump responses: "200": content: @@ -815,18 +867,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Threaddump (actuatorThreaddump) + tags: + - Actuator API + x-internal: true /actuator/loggers: get: - x-internal: true - operationId: actuatorLoggers - description: > - A1-PMS Springboot Service Actuator web endpoint - Get a list of Loggers. + description: | + A1-PMS Springboot Service Actuator web endpoint - Get a list of Loggers. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Get Loggers (actuatorLoggers) - tags: - - Actuator API + operationId: actuatorLoggers responses: "200": content: @@ -840,26 +892,26 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Get Loggers (actuatorLoggers) + tags: + - Actuator API + x-internal: true /actuator/loggers/{name}: get: - x-internal: true - operationId: actuatorGetLogger - description: > - A1-PMS Springboot Service Actuator web endpoint - Get a single named Logger. + description: | + A1-PMS Springboot Service Actuator web endpoint - Get a single named Logger. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Get Logger (actuatorGetLogger) - tags: - - Actuator API + operationId: actuatorGetLogger 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: @@ -873,37 +925,37 @@ paths: schema: type: object description: OK - post: + summary: Actuator endpoint - Get Logger (actuatorGetLogger) + tags: + - Actuator API x-internal: true - operationId: actuatorSetlogger - description: > - A1-PMS Springboot Service Actuator web endpoint - Create or Update single named Logger. + post: + description: | + A1-PMS Springboot Service Actuator web endpoint - Create or Update single named Logger. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Set Logger (actuatorSetlogger) - tags: - - Actuator API + operationId: actuatorSetlogger 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": @@ -912,18 +964,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Set Logger (actuatorSetlogger) + tags: + - Actuator API + x-internal: true /actuator/logfile: get: - x-internal: true - operationId: actuatorGetLogFile - description: > - A1-PMS Springboot Service Actuator web endpoint - Get the Log file. + description: | + A1-PMS Springboot Service Actuator web endpoint - Get the Log file. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Log File (actuatorGetLogFile) - tags: - - Actuator API + operationId: actuatorGetLogFile responses: "200": content: @@ -931,18 +983,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Log File (actuatorGetLogFile) + tags: + - Actuator API + x-internal: true /actuator/health: get: - x-internal: true - operationId: actuatorHealth - description: > - A1-PMS Springboot Service Actuator web endpoint - Health Check. + description: | + A1-PMS Springboot Service Actuator web endpoint - Health Check. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Health (actuatorHealth) - tags: - - Actuator API + operationId: actuatorHealth responses: "200": content: @@ -956,18 +1008,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Health (actuatorHealth) + tags: + - Actuator API + x-internal: true /actuator/health/**: get: - x-internal: true - operationId: actuatorHealthComponent - description: > - A1-PMS Springboot Service Actuator web endpoint - Health Status for an Application Component. + description: | + A1-PMS Springboot Service Actuator web endpoint - Health Status for an Application Component. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Component Health (actuatorHealthComponent) - tags: - - Actuator API + operationId: actuatorHealthComponent responses: "200": content: @@ -981,18 +1033,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Component Health (actuatorHealthComponent) + tags: + - Actuator API + x-internal: true /actuator/shutdown: post: - x-internal: true - operationId: actuatorShutdown - description: > - A1-PMS Springboot Service Actuator web endpoint - Shutdown the Application. + description: | + A1-PMS Springboot Service Actuator web endpoint - Shutdown the Application. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Shutdown (actuatorShutdown) - tags: - - Actuator API + operationId: actuatorShutdown responses: "200": content: @@ -1006,18 +1058,18 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Shutdown (actuatorShutdown) + tags: + - Actuator API + x-internal: true /actuator/metrics: get: - x-internal: true - operationId: actuatorMetrics - description: > - A1-PMS Springboot Service Actuator web endpoint - Get a list of Application metrics names. + description: | + A1-PMS Springboot Service Actuator web endpoint - Get a list of Application metrics names. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Metrics (actuatorMetrics) - tags: - - Actuator API + operationId: actuatorMetrics responses: "200": content: @@ -1031,24 +1083,26 @@ paths: schema: type: object description: OK + summary: Actuator endpoint - Metrics (actuatorMetrics) + tags: + - Actuator API + x-internal: true /actuator/metrics/{requiredMetricName}: get: - x-internal: true - operationId: actuatorGetMetric - description: > - A1-PMS Springboot Service Actuator web endpoint - Get the value for a named Application metric. + description: | + A1-PMS Springboot Service Actuator web endpoint - Get the value for a named Application metric. externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html - summary: Actuator endpoint - Get Metric (actuatorGetMetric) + operationId: actuatorGetMetric 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: @@ -1062,78 +1116,29 @@ paths: schema: type: object description: OK - + summary: Actuator endpoint - Get Metric (actuatorGetMetric) + x-internal: true 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 - 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 + status_info: 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 A1 Policy Type + status: status + ric_info: value: - policy_schema: "{}" + ric_id: ric_id + managed_element_ids: + - some_managed_element_id + - some_managed_element_id + state: UNAVAILABLE + policytype_ids: + - some_policytype_id + - some_policytype_id policy_type_id_list: description: Array of A1 Policy Type id's value: policy_type_id_list: - - policytype_id - - policytype_id + - policytype_id + - policytype_id policy_info: description: Information for an A1 Policy Instance value: @@ -1144,30 +1149,65 @@ components: policy_data: "{}" status_notification_uri: status_notification_uri policytype_id: policytype_id1 - policy_info_list: - description: List of policy information + ric_info_list: value: - policies: - - ric_id: ric_id1 - policy_id: policy_id1 - transient: false - service_id: service_id1 - policy_data: "{}" - status_notification_uri: status_notification_uri - policytype_id: policytype_id1 - - ric_id: ric_id2 - policy_id: policy_id2 - transient: true - service_id: service_id2 - policy_data: "{}" - status_notification_uri: status_notification_uri - policytype_id: policytype_id2 + rics: + - ric_id: ric_id + managed_element_ids: + - some_managed_element_id + - some_managed_element_id + state: UNAVAILABLE + policytype_ids: + - policytype_id + - policytype_id + - ric_id: ric_id + managed_element_ids: + - managed_element_ids + - managed_element_ids + state: UNAVAILABLE + policytype_ids: + - policytype_ids + - policytype_ids + 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 A1 Policy Type + value: + policy_schema: "{}" policy_id_list: description: A list of policy identities value: policy_ids: - - some_policy_id - - some_policy_id + - some_policy_id + - some_policy_id + policy_info_list: + description: List of policy information + value: + policies: + - ric_id: ric_id1 + policy_id: policy_id1 + transient: false + service_id: service_id1 + policy_data: "{}" + status_notification_uri: status_notification_uri + policytype_id: policytype_id1 + - ric_id: ric_id2 + policy_id: policy_id2 + transient: true + service_id: service_id2 + policy_data: "{}" + status_notification_uri: status_notification_uri + policytype_id: policytype_id2 policy_status_info: description: Status for one A1-P Policy value: @@ -1175,89 +1215,63 @@ components: status: value: status: status - status_info: - value: - status: status - ric_info: - value: - ric_id: ric_id - managed_element_ids: - - some_managed_element_id - - some_managed_element_id - state: UNAVAILABLE - policytype_ids: - - some_policytype_id - - some_policytype_id - ric_info_list: - value: - rics: - - ric_id: ric_id - managed_element_ids: - - some_managed_element_id - - some_managed_element_id - state: UNAVAILABLE - policytype_ids: - - policytype_id - - policytype_id - - ric_id: ric_id - managed_element_ids: - - managed_element_ids - - managed_element_ids - state: UNAVAILABLE - policytype_ids: - - policytype_ids - - policytype_ids - + responses: + NotFound: + content: + application/problem+json: + example: [] + description: Not Found + Locked: + content: + application/problem+json: + example: + status: 423 + title: Locked + detail: Requested resource is in a locked state. + schema: + $ref: '#/components/schemas/error_information' + description: Locked - HTTP Status code which can be used when the state is Locked + BadRequest: + content: + application/problem+json: + example: + status: 400 + title: Bad Request + detail: The provided request is not valid. + schema: + $ref: '#/components/schemas/error_information' + description: Bad Request + Forbidden: + content: + application/problem+json: + example: + status: 403 + title: Forbidden + detail: Your role does not allow to perform this action. Contact System + Administrator to change your access rights. + schema: + $ref: '#/components/schemas/error_information' + description: Forbidden schemas: - policy_type_definition: - description: Contains A1 Policy Type schema definition - type: object - properties: - policy_schema: - description: A1 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: - detail: - description: ' A human-readable explanation specific to this occurrence - of the problem.' - example: A1 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. ' - example: 404 - format: int32 - type: integer - type: object - void: - description: Void/empty - type: object status_info: + example: + status: status properties: status: description: status text type: string type: object - authorization_result: - description: Result of authorization - example: - result: true - properties: - result: - description: If true, the access is granted - type: boolean - required: - - result - type: object 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 @@ -1271,10 +1285,10 @@ components: 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 A1 Policy Types @@ -1283,49 +1297,141 @@ components: type: string type: array type: object - service_registration_info: - description: Information for one service + policy_type_id_list: + description: Information about A1 Policy Types + example: + policytype_ids: + - policytype_ids + - policytype_ids properties: - callback_url: - description: Callback for notifying of Near-RT RIC state changes + policytype_ids: + description: A1 Policy Type identities + items: + description: A1 Policy Type identities + type: string + type: array + type: object + policy_info: + description: Information for one A1-P Policy + example: + ric_id: ric_id + policy_id: policy_id + transient: false + 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 + type: string + policy_id: + description: identity of the policy type: string + transient: + default: false + description: | + If true, the policy is automatically deleted if the targeted Near-RT RIC restarts or recovers. If false, the A1 Policy Instance remains, and is re-pushed to the targeted Near-RT RIC after a restart or recovery. If false, the A1 Policy Instance is maintained and must be deleted separately in the event of Near-RT RIC restart or recovery. Default is false. + example: false + nullable: false + type: boolean service_id: - description: identity of the service + default: "" + 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. If the service is registered, the A1 Policy Instance will be subject to the same supervision rules as the the service's other policies. + 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 A1 Policy Type type: string - keep_alive_interval_seconds: - 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 - type: integer required: - - service_id + - policy_data + - policy_id + - policytype_id + - ric_id type: object - policy_info_list: - description: List of policy information + void: + description: Void/empty + type: object + error_information: + description: Problem as defined in https://tools.ietf.org/html/rfc7807 + example: + detail: A1 Policy Type not found + title: Not Found + status: 404 properties: - policies: - description: List of policy information + detail: + description: ' A human-readable explanation specific to this occurrence + of the problem.' + example: A1 Policy Type not found + type: string + title: + description: A specific error name + example: Not Found + type: string + status: + description: 'The HTTP status code generated by the origin server for this + occurrence of the problem. ' + example: 404 + format: int32 + type: integer + type: object + 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/policy_info' + $ref: '#/components/schemas/ric_info' type: array type: object - policy_status_info: - description: Status for one A1-P Policy + service_status_list: + 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 properties: - last_modified: - description: timestamp, last modification time - type: string - status: - description: the Policy status - type: object + service_list: + description: List of service information + items: + $ref: '#/components/schemas/service_status' + type: array type: object service_status: + example: + callback_url: callback_url + service_id: service_id + keep_alive_interval_seconds: 0 + time_since_last_activity_seconds: 6 properties: callback_url: description: callback for notifying of RIC synchronization @@ -1342,103 +1448,56 @@ components: format: int64 type: integer type: object - ric_info_list: - description: List of Near-RT RIC information - properties: - rics: - description: List of Near-RT RIC information - items: - $ref: '#/components/schemas/ric_info' - type: array - type: object - input: - description: input + service_registration_info: + description: Information for one service properties: - access_type: - description: Access type - enum: - - READ - - WRITE - - DELETE - type: string - auth_token: - description: Authorization token + callback_url: + description: Callback for notifying of Near-RT RIC state changes type: string - policy_type_id: - description: A1 Policy Type identifier + service_id: + description: identity of the service type: string + keep_alive_interval_seconds: + 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 + type: integer required: - - access_type - - auth_token - - policy_type_id - type: object - policy_authorization: - description: Authorization request for A1 policy requests - properties: - input: - $ref: '#/components/schemas/input' - required: - - input - type: object - policy_type_id_list: - description: Information about A1 Policy Types - properties: - policytype_ids: - description: A1 Policy Type identities - items: - description: A1 Policy Type identities - type: string - type: array + - service_id type: object - policy_info: - description: Information for one A1-P Policy + service_callback_info_v2: + description: "Information transferred in Service callbacks, \nif a callback\ + \ URL was provided for a registered service\n" 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 automatically deleted if the targeted Near-RT RIC restarts - or recovers. If false, the A1 Policy Instance remains, and is re-pushed to the targeted - Near-RT RIC after a restart or recovery. If false, the A1 Policy Instance is maintained and - must be deleted separately in the event of Near-RT RIC restart or recovery. Default is false. - example: false - nullable: false - type: boolean - 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. - If the service is registered, the A1 Policy Instance will be - subject to the same supervision rules as the the service's other policies. - type: string - default: "" - policy_data: - description: the configuration of the policy - type: object - status_notification_uri: - description: Callback URI for policy status updates + description: identity of a Near-RT RIC type: string - policytype_id: - description: identity of the A1 Policy Type + event_type: + description: "values: \n AVAILABLE: the Near-RT RIC has become available\ + \ for A1 Policy management\n" + enum: + - AVAILABLE type: string required: - - ric_id - - policy_id - - policy_data - - policytype_id + - event_type + - ric_id + type: object + policy_type_definition: + description: Contains A1 Policy Type schema definition + example: + policy_schema: "{}" + properties: + policy_schema: + description: A1 Policy Type json schema. The schema is a json object following + http://json-schema.org/draft-07/schema + type: object type: object 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 @@ -1447,32 +1506,83 @@ components: type: string type: array type: object - service_status_list: + policy_info_list: + description: List of policy information + example: + policies: + - ric_id: ric_id + policy_id: policy_id + transient: false + 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: "" + policy_data: "{}" + status_notification_uri: status_notification_uri + policytype_id: policytype_id properties: - service_list: - description: List of service information + policies: + description: List of policy information items: - $ref: '#/components/schemas/service_status' + $ref: '#/components/schemas/policy_info' type: array type: object - service_callback_info_v2: - description: | - Information transferred in Service callbacks, - if a callback URL was provided for a registered service + policy_status_info: + description: Status for one A1-P Policy + example: + last_modified: last_modified + status: "{}" properties: - ric_id: - description: identity of a Near-RT RIC + last_modified: + description: "timestamp, last modification time" type: string - event_type: - description: > - values: - AVAILABLE: the Near-RT RIC has become available for A1 Policy management + status: + description: the Policy status + type: object + type: object + policy_authorization: + description: Authorization request for A1 policy requests + properties: + input: + $ref: '#/components/schemas/input' + required: + - input + type: object + input: + description: input + properties: + access_type: + description: Access type enum: - - AVAILABLE + - READ + - WRITE + - DELETE + type: string + auth_token: + description: Authorization token + type: string + policy_type_id: + description: A1 Policy Type identifier type: string required: - - event_type - - ric_id + - access_type + - auth_token + - policy_type_id + type: object + authorization_result: + description: Result of authorization + example: + result: true + properties: + result: + description: "If true, the access is granted" + type: boolean + required: + - result type: object Link: properties: @@ -1480,4 +1590,4 @@ components: type: boolean href: type: string - type: object
\ No newline at end of file + type: object |