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