aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorelinuxhenrik <henrik.b.andersson@est.tech>2020-11-11 14:11:37 +0100
committerKAPIL SINGAL <ks220y@att.com>2020-11-17 14:23:46 +0000
commit50b658dcfa0e2e4ce21060e71d7ce7d701335ca8 (patch)
treed678a4b3114c944cc0bf63a381e09d8872ffdaed /docs
parente78c27efa1b2bbd9db762211e907777f49aba7d2 (diff)
Add ConfigurationController
Change-Id: I281398dc663c5778ea6a5c34262a5684db4df0d0 Issue-ID: CCSDK-2966 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Diffstat (limited to 'docs')
-rw-r--r--docs/offeredapis/swagger/pms-api.json80
1 files changed, 57 insertions, 23 deletions
diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json
index 6ece771b..f5cc0165 100644
--- a/docs/offeredapis/swagger/pms-api.json
+++ b/docs/offeredapis/swagger/pms-api.json
@@ -5,7 +5,7 @@
"summary": "Query policy type names",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "getPolicyTypesUsingGET",
+ "operationId": "getPolicyTypesUsingGET_1",
"responses": {
"200": {
"schema": {
@@ -35,7 +35,7 @@
"summary": "Returns status and statistics of this service",
"deprecated": false,
"produces": ["application/json"],
- "operationId": "getStatusUsingGET",
+ "operationId": "getStatusUsingGET_1",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/status_info_v2"},
@@ -51,7 +51,7 @@
"summary": "Query policy type identities",
"deprecated": false,
"produces": ["application/json"],
- "operationId": "getPolicyTypesUsingGET_1",
+ "operationId": "getPolicyTypesUsingGET",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/policytype_id_list_v2"},
@@ -79,7 +79,7 @@
"summary": "Returns service information",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "getServicesUsingGET_1",
+ "operationId": "getServicesUsingGET",
"responses": {
"200": {
"schema": {
@@ -109,7 +109,7 @@
"summary": "Delete a service",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "deleteServiceUsingDELETE_1",
+ "operationId": "deleteServiceUsingDELETE",
"responses": {
"200": {
"schema": {"type": "string"},
@@ -141,7 +141,7 @@
"summary": "Unregister a service",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "deleteServiceUsingDELETE",
+ "operationId": "deleteServiceUsingDELETE_1",
"responses": {
"200": {"description": "Not used"},
"401": {"description": "Unauthorized"},
@@ -169,7 +169,7 @@
"summary": "Returns a policy configuration",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "getPolicyUsingGET",
+ "operationId": "getPolicyUsingGET_1",
"responses": {
"200": {
"schema": {"type": "object"},
@@ -193,7 +193,7 @@
"summary": "Delete a policy",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "deletePolicyUsingDELETE",
+ "operationId": "deletePolicyUsingDELETE_1",
"responses": {
"200": {"description": "Not used"},
"401": {"description": "Unauthorized"},
@@ -222,7 +222,7 @@
"summary": "Put a policy",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "putPolicyUsingPUT",
+ "operationId": "putPolicyUsingPUT_1",
"responses": {
"200": {"description": "Policy updated"},
"201": {"description": "Policy created"},
@@ -345,7 +345,7 @@
"summary": "Returns a policy",
"deprecated": false,
"produces": ["application/json"],
- "operationId": "getPolicyUsingGET_1",
+ "operationId": "getPolicyUsingGET",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/policy_info_v2"},
@@ -371,7 +371,7 @@
"summary": "Delete a policy",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "deletePolicyUsingDELETE_1",
+ "operationId": "deletePolicyUsingDELETE",
"responses": {
"200": {"description": "Not used"},
"401": {"description": "Unauthorized"},
@@ -457,7 +457,7 @@
"summary": "Returns a policy status",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "getPolicyStatusUsingGET",
+ "operationId": "getPolicyStatusUsingGET_1",
"responses": {
"200": {
"schema": {"type": "object"},
@@ -484,7 +484,7 @@
"summary": "Returns a policy status",
"deprecated": false,
"produces": ["application/json"],
- "operationId": "getPolicyStatusUsingGET_1",
+ "operationId": "getPolicyStatusUsingGET",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/policy_status_info_v2"},
@@ -534,11 +534,41 @@
}],
"tags": ["A1 Policy Management Version 2.0 (in progress)"]
}},
+ "/v2/configuration": {"put": {
+ "summary": "Replace the current configuration with the given configuration",
+ "deprecated": false,
+ "produces": ["*/*"],
+ "operationId": "putConfigurationUsingPUT",
+ "responses": {
+ "200": {"description": "Configuration updated"},
+ "201": {"description": "Created"},
+ "400": {
+ "schema": {"$ref": "#/definitions/error_information"},
+ "description": "Invalid configuration provided"
+ },
+ "401": {"description": "Unauthorized"},
+ "500": {
+ "schema": {"$ref": "#/definitions/error_information"},
+ "description": "Something went wrong when replacing the configuration. Try again."
+ },
+ "403": {"description": "Forbidden"},
+ "404": {"description": "Not Found"}
+ },
+ "parameters": [{
+ "schema": {"type": "string"},
+ "in": "body",
+ "name": "configuration",
+ "description": "configuration",
+ "required": true
+ }],
+ "tags": ["A1 Policy Management Configuration"],
+ "consumes": ["application/json"]
+ }},
"/policy_ids": {"get": {
"summary": "Query policies, only policy identities returned",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "getPolicyIdsUsingGET",
+ "operationId": "getPolicyIdsUsingGET_1",
"responses": {
"200": {
"schema": {
@@ -664,7 +694,7 @@
"deprecated": false,
"produces": ["application/json"],
"description": "Either information about a registered service with given identity or all registered services are returned.",
- "operationId": "getServicesUsingGET",
+ "operationId": "getServicesUsingGET_1",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/service_list_v2"},
@@ -692,7 +722,7 @@
"deprecated": false,
"produces": ["*/*"],
"description": "Registering a service is needed to:<ul><li>Get callbacks.<\/li><li>Activate supervision of the service. If a service is inactive, its policies will be deleted.<\/li><\/ul>",
- "operationId": "putServiceUsingPUT",
+ "operationId": "putServiceUsingPUT_1",
"responses": {
"200": {
"schema": {"type": "object"},
@@ -752,7 +782,7 @@
"summary": "Heartbeat from a service",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "keepAliveServiceUsingPUT_1",
+ "operationId": "keepAliveServiceUsingPUT",
"responses": {
"200": {
"schema": {"type": "string"},
@@ -778,7 +808,7 @@
"summary": "Heartbeat indicates that the service is running",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "keepAliveServiceUsingPUT",
+ "operationId": "keepAliveServiceUsingPUT_1",
"responses": {
"200": {
"schema": {"type": "object"},
@@ -806,7 +836,7 @@
"summary": "Returns status and statistics of this service",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "getStatusUsingGET_1",
+ "operationId": "getStatusUsingGET",
"responses": {
"200": {
"schema": {"type": "string"},
@@ -909,7 +939,7 @@
"summary": "Register a service",
"deprecated": false,
"produces": ["*/*"],
- "operationId": "putServiceUsingPUT_1",
+ "operationId": "putServiceUsingPUT",
"responses": {
"200": {
"schema": {"type": "string"},
@@ -943,7 +973,7 @@
"deprecated": false,
"produces": ["application/json"],
"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.",
- "operationId": "getPolicyIdsUsingGET_1",
+ "operationId": "getPolicyIdsUsingGET",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/policy_id_list_v2"},
@@ -988,7 +1018,7 @@
"summary": "Create or update a policy",
"deprecated": false,
"produces": ["application/json"],
- "operationId": "putPolicyUsingPUT_1",
+ "operationId": "putPolicyUsingPUT",
"responses": {
"200": {"description": "Policy updated"},
"201": {"description": "Policy created"},
@@ -1015,7 +1045,7 @@
}
}
},
- "host": "localhost:38465",
+ "host": "localhost:49657",
"definitions": {
"error_information": {
"description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
@@ -1377,6 +1407,10 @@
},
"tags": [
{
+ "name": "A1 Policy Management Configuration",
+ "description": "Configuration Controller"
+ },
+ {
"name": "A1 Policy Management Version 1.0",
"description": "Policy Controller"
},