summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/swagger/pms-api.json
diff options
context:
space:
mode:
authorPatrikBuhr <patrik.buhr@est.tech>2021-10-07 18:03:53 +0200
committerPatrikBuhr <patrik.buhr@est.tech>2021-10-15 15:48:52 +0200
commit3b916e4dc5777863cb4ee873b41ee460fb9aec27 (patch)
treeda8003e728de8f9ca8d7a9a4369c20b16c1f6531 /docs/offeredapis/swagger/pms-api.json
parente81a9de40bc0acb4a15ecf9fd60500a6f71344e4 (diff)
Improving searching for policy types - A1 Jakarta
The querying for supported policy types is enhanced so that an application can get a list of all policy types that are compatible with a given version. This means added query parameters for GET types. Simplified exception handling. Issue-ID: CCSDK-3495 Signed-off-by: PatrikBuhr <patrik.buhr@est.tech> Change-Id: Iedc2267e4fe2b5e2c17d688e315893c354379930
Diffstat (limited to 'docs/offeredapis/swagger/pms-api.json')
-rw-r--r--docs/offeredapis/swagger/pms-api.json71
1 files changed, 54 insertions, 17 deletions
diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json
index 95bc6580..de014721 100644
--- a/docs/offeredapis/swagger/pms-api.json
+++ b/docs/offeredapis/swagger/pms-api.json
@@ -13,7 +13,7 @@
"format": "int32",
"description": "The HTTP status code generated by the origin server for this occurrence of the problem. ",
"type": "integer",
- "example": 503
+ "example": 404
}
}
},
@@ -280,7 +280,7 @@
"type": "boolean"
},
"service_id": {
- "description": "the name of the service owning the policy",
+ "description": "the identity of the service owning the policy",
"type": "string"
},
"policy_data": {
@@ -341,11 +341,11 @@
"openapi": "3.0.1",
"paths": {
"/policy_types": {"get": {
- "summary": "Query policy type names",
+ "summary": "Query policy type identities",
"operationId": "getPolicyTypes",
"responses": {
"200": {
- "description": "Policy type names",
+ "description": "Policy type identities",
"content": {"*/*": {"schema": {
"type": "array",
"items": {"type": "string"}
@@ -384,21 +384,28 @@
"schema": {"type": "string"},
"in": "query",
"name": "policytype_id",
- "description": "The identity of the policy type to get policies for.",
+ "description": "Select policies with a given type identity.",
"required": false
},
{
"schema": {"type": "string"},
"in": "query",
"name": "ric_id",
- "description": "The identity of the Near-RT RIC to get policies for.",
+ "description": "Select policies for a given Near-RT RIC identity.",
"required": false
},
{
"schema": {"type": "string"},
"in": "query",
"name": "service_id",
- "description": "The identity of the service to get policies for.",
+ "description": "Select policies owned by a given service.",
+ "required": false
+ },
+ {
+ "schema": {"type": "string"},
+ "in": "query",
+ "name": "type_name",
+ "description": "Select policies of a given type name (type identity has the format <typename_version>)",
"required": false
}
],
@@ -507,13 +514,36 @@
"content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
}
},
- "parameters": [{
- "schema": {"type": "string"},
- "in": "query",
- "name": "ric_id",
- "description": "The identity of the Near-RT RIC to get types for.",
- "required": false
- }],
+ "parameters": [
+ {
+ "schema": {"type": "string"},
+ "in": "query",
+ "name": "ric_id",
+ "description": "Select types for the given Near-RT RIC identity.",
+ "required": false
+ },
+ {
+ "schema": {"type": "string"},
+ "in": "query",
+ "name": "type_name",
+ "description": "Select types with the given type name (type identity has the format <typename_version>)",
+ "required": false
+ },
+ {
+ "schema": {"type": "string"},
+ "in": "query",
+ "name": "regexp",
+ "description": "Select types with type identity that matches a regular expression.",
+ "required": false
+ },
+ {
+ "schema": {"type": "string"},
+ "in": "query",
+ "name": "compatible_with_version",
+ "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.",
+ "required": false
+ }
+ ],
"tags": ["A1 Policy Management"]
}},
"/a1-policy/v2/policies/{policy_id}": {
@@ -1098,21 +1128,28 @@
"schema": {"type": "string"},
"in": "query",
"name": "policytype_id",
- "description": "The identity of the policy type to get policies for.",
+ "description": "Select policies of a given policy type identity.",
"required": false
},
{
"schema": {"type": "string"},
"in": "query",
"name": "ric_id",
- "description": "The identity of the Near-RT RIC to get policies for.",
+ "description": "Select policies of a given Near-RT RIC identity.",
"required": false
},
{
"schema": {"type": "string"},
"in": "query",
"name": "service_id",
- "description": "The identity of the service to get policies for.",
+ "description": "Select policies owned by a given service.",
+ "required": false
+ },
+ {
+ "schema": {"type": "string"},
+ "in": "query",
+ "name": "type_name",
+ "description": "Select policies of types with the given type name (type identity has the format <typename_version>)",
"required": false
}
],