aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/swagger/pms-api-v3.json
diff options
context:
space:
mode:
authorsaul.gill <saul.gill@est.tech>2025-02-26 17:31:51 +0000
committersaul.gill <saul.gill@est.tech>2025-03-03 17:12:39 +0000
commitd2c683570632d0510749dfd97aa47caeea471643 (patch)
tree975214b483c346c35f4abf9ee55ed871508f8579 /docs/offeredapis/swagger/pms-api-v3.json
parentc9da0bff44e1c8d07c9b6fd3d8657c71cb1f0c9a (diff)
Controller behaviour fixesoslo
Issue-ID: CCSDK-4090 Change-Id: I76644282bea67e33ff346fe999d65f4d3b54751b Signed-off-by: saul.gill <saul.gill@est.tech>
Diffstat (limited to 'docs/offeredapis/swagger/pms-api-v3.json')
-rw-r--r--docs/offeredapis/swagger/pms-api-v3.json150
1 files changed, 40 insertions, 110 deletions
diff --git a/docs/offeredapis/swagger/pms-api-v3.json b/docs/offeredapis/swagger/pms-api-v3.json
index f923650c..f2141968 100644
--- a/docs/offeredapis/swagger/pms-api-v3.json
+++ b/docs/offeredapis/swagger/pms-api-v3.json
@@ -60,32 +60,33 @@
}
},
"description" : "OK- Service is living Ok"
+ },
+ "404" : {
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ProblemDetails"
+ }
+ }
+ },
+ "description" : "Not Found"
}
},
"tags" : [ "Health Check" ]
}
},
- "/rics/ric" : {
+ "/rics/{ricId}" : {
"get" : {
- "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).",
+ "description" : "A ricId path parameter must be specified to retrieve associated ric infomation",
"operationId" : "getRic",
"parameters" : [ {
- "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",
- "explode" : true,
- "in" : "query",
- "name" : "managedElementId",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "style" : "form"
- }, {
"description" : "The identity of a Near-RT RIC to get information for.",
"explode" : true,
- "in" : "query",
+ "in" : "path",
"name" : "ricId",
- "required" : false,
+ "required" : true,
"schema" : {
+ "nullable" : false,
"type" : "string"
},
"style" : "form"
@@ -312,7 +313,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -447,7 +448,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -510,7 +511,7 @@
} ],
"responses" : {
"204" : {
- "description" : "The A1 policy was deleted"
+ "description" : "No Content"
},
"400" : {
"content" : {
@@ -595,7 +596,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -729,7 +730,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -906,7 +907,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -1036,7 +1037,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -1200,7 +1201,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -1258,7 +1259,7 @@
}
}
},
- "description" : "Success case 201 created",
+ "description" : "Created",
"headers" : {
"Location" : {
"description" : "Contains the URI of the newly created resource",
@@ -1268,6 +1269,15 @@
"type" : "string"
},
"style" : "simple"
+ },
+ "Content-Type" : {
+ "description" : "Media Type of the response",
+ "explode" : false,
+ "schema" : {
+ "example" : "application/json",
+ "type" : "string"
+ },
+ "style" : "simple"
}
}
},
@@ -1384,7 +1394,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -1464,7 +1474,7 @@
"responses" : {
"200" : {
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
"$ref" : "#/components/schemas/void"
}
@@ -1524,7 +1534,7 @@
"responses" : {
"200" : {
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
"type" : "object"
}
@@ -1662,7 +1672,7 @@
"responses" : {
"200" : {
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
"type" : "object"
}
@@ -1672,7 +1682,7 @@
},
"201" : {
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
"type" : "object"
}
@@ -1723,7 +1733,7 @@
"responses" : {
"204" : {
"content" : {
- "*/*" : {
+ "application/json" : {
"schema" : {
"type" : "object"
}
@@ -1764,17 +1774,6 @@
} ]
}
},
- "PolicyStatusInfo" : {
- "description" : "Status for one A1-P Policy",
- "value" : {
- "lastModified" : "last_modified",
- "status" : {
- "value" : {
- "status" : "status"
- }
- }
- }
- },
"StatusInfo" : {
"value" : {
"status" : "status"
@@ -2005,7 +2004,7 @@
}
}
},
- "description" : "Too Many Request"
+ "description" : "Too Many Requests"
},
"500" : {
"content" : {
@@ -2222,20 +2221,6 @@
},
"type" : "object"
},
- "AuthorizationResult" : {
- "description" : "Result of authorization",
- "example" : {
- "result" : true
- },
- "properties" : {
- "result" : {
- "description" : "If true, the access is granted",
- "type" : "boolean"
- }
- },
- "required" : [ "result" ],
- "type" : "object"
- },
"RicInfo" : {
"description" : "Information for a Near-RT RIC",
"properties" : {
@@ -2287,20 +2272,6 @@
"required" : [ "serviceId" ],
"type" : "object"
},
- "PolicyStatusInfo" : {
- "description" : "Status for one A1-P Policy",
- "properties" : {
- "lastModified" : {
- "description" : "timestamp, last modification time",
- "type" : "string"
- },
- "status" : {
- "description" : "the Policy status",
- "type" : "object"
- }
- },
- "type" : "object"
- },
"ServiceStatus" : {
"properties" : {
"callbackUrl" : {
@@ -2337,36 +2308,6 @@
},
"type" : "object"
},
- "input" : {
- "description" : "input",
- "properties" : {
- "accessType" : {
- "description" : "Access type",
- "enum" : [ "READ", "WRITE", "DELETE" ],
- "type" : "string"
- },
- "authToken" : {
- "description" : "Authorization token",
- "type" : "string"
- },
- "policyTypeId" : {
- "description" : "Policy type identifier",
- "type" : "string"
- }
- },
- "required" : [ "accessType", "authToken", "policyTypeId" ],
- "type" : "object"
- },
- "PolicyAuthorization" : {
- "description" : "Authorization request for A1 policy requests",
- "properties" : {
- "input" : {
- "$ref" : "#/components/schemas/input"
- }
- },
- "required" : [ "input" ],
- "type" : "object"
- },
"NearRtRicId" : {
"description" : "Identity of the policy",
"type" : "string"
@@ -2413,17 +2354,6 @@
"required" : [ "eventType", "ricId" ],
"type" : "object"
},
- "Link" : {
- "properties" : {
- "templated" : {
- "type" : "boolean"
- },
- "href" : {
- "type" : "string"
- }
- },
- "type" : "object"
- },
"ProblemDetails" : {
"description" : "A problem detail to carry details in an HTTP response according to RFC 7807",
"properties" : {