aboutsummaryrefslogtreecommitdiffstats
path: root/a1-policy-management/api
diff options
context:
space:
mode:
authorPatrikBuhr <patrik.buhr@est.tech>2022-03-25 15:39:06 +0100
committerPatrikBuhr <patrik.buhr@est.tech>2022-03-25 15:39:06 +0100
commit62c259621a53b802e8ea2823d6b0fed78e4f6660 (patch)
treed2842da085365b1d4412f6900e7bf9ddbc8f8fd2 /a1-policy-management/api
parent31639ac11cc90c554b5303199c2da6fedc008d7b (diff)
NONRTRIC Minor changes
Some version updated and changes related to swagger documentation generation. Issue-ID: CCSDK-3560 Signed-off-by: PatrikBuhr <patrik.buhr@est.tech> Change-Id: I59311f5fd09face79e9dce185c65374522dcb40e
Diffstat (limited to 'a1-policy-management/api')
-rw-r--r--a1-policy-management/api/pms-api.json80
-rw-r--r--a1-policy-management/api/pms-api.yaml102
2 files changed, 91 insertions, 91 deletions
diff --git a/a1-policy-management/api/pms-api.json b/a1-policy-management/api/pms-api.json
index 91ad1b7e..2b8fb739 100644
--- a/a1-policy-management/api/pms-api.json
+++ b/a1-policy-management/api/pms-api.json
@@ -297,6 +297,15 @@
],
"tags": ["A1 Policy Management"]
}},
+ "/actuator/threaddump": {"get": {
+ "summary": "Actuator web endpoint 'threaddump'",
+ "operationId": "threaddump_2",
+ "responses": {"200": {
+ "description": "OK",
+ "content": {"*/*": {"schema": {"type": "object"}}}
+ }},
+ "tags": ["Actuator"]
+ }},
"/a1-policy/v2/status": {"get": {
"summary": "Returns status and statistics of this service",
"operationId": "getStatus",
@@ -306,9 +315,18 @@
}},
"tags": ["Health Check"]
}},
- "/actuator/threaddump": {"get": {
- "summary": "Actuator web endpoint 'threaddump'",
- "operationId": "threaddump_4",
+ "/actuator/loggers": {"get": {
+ "summary": "Actuator web endpoint 'loggers'",
+ "operationId": "loggers",
+ "responses": {"200": {
+ "description": "OK",
+ "content": {"*/*": {"schema": {"type": "object"}}}
+ }},
+ "tags": ["Actuator"]
+ }},
+ "/actuator/health/**": {"get": {
+ "summary": "Actuator web endpoint 'health-path'",
+ "operationId": "health-path",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -347,24 +365,6 @@
],
"tags": ["NearRT-RIC Repository"]
}},
- "/actuator/loggers": {"get": {
- "summary": "Actuator web endpoint 'loggers'",
- "operationId": "loggers_2",
- "responses": {"200": {
- "description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
- }},
- "tags": ["Actuator"]
- }},
- "/actuator/health/**": {"get": {
- "summary": "Actuator web endpoint 'health-path'",
- "operationId": "health-path_2",
- "responses": {"200": {
- "description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
- }},
- "tags": ["Actuator"]
- }},
"/a1-policy/v2/policy-types": {"get": {
"summary": "Query policy type identities",
"operationId": "getPolicyTypes",
@@ -457,7 +457,7 @@
},
"/actuator/metrics/{requiredMetricName}": {"get": {
"summary": "Actuator web endpoint 'metrics-requiredMetricName'",
- "operationId": "metrics-requiredMetricName_2",
+ "operationId": "metrics-requiredMetricName",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -512,7 +512,7 @@
},
"/actuator": {"get": {
"summary": "Actuator root web endpoint",
- "operationId": "links_1",
+ "operationId": "links",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {
@@ -528,7 +528,7 @@
"/actuator/loggers/{name}": {
"post": {
"summary": "Actuator web endpoint 'loggers-name'",
- "operationId": "loggers-name_3",
+ "operationId": "loggers-name",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -543,7 +543,7 @@
},
"get": {
"summary": "Actuator web endpoint 'loggers-name'",
- "operationId": "loggers-name_4",
+ "operationId": "loggers-name_2",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -581,7 +581,7 @@
}},
"/actuator/metrics": {"get": {
"summary": "Actuator web endpoint 'metrics'",
- "operationId": "metrics_2",
+ "operationId": "metrics",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -662,7 +662,7 @@
},
"/actuator/info": {"get": {
"summary": "Actuator web endpoint 'info'",
- "operationId": "info_2",
+ "operationId": "info",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -701,7 +701,7 @@
}},
"/actuator/logfile": {"get": {
"summary": "Actuator web endpoint 'logfile'",
- "operationId": "logfile_2",
+ "operationId": "logfile",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -710,7 +710,7 @@
}},
"/actuator/health": {"get": {
"summary": "Actuator web endpoint 'health'",
- "operationId": "health_2",
+ "operationId": "health",
"responses": {"200": {
"description": "OK",
"content": {"*/*": {"schema": {"type": "object"}}}
@@ -831,6 +831,15 @@
}],
"tags": ["Service Registry and Supervision"]
}},
+ "/actuator/heapdump": {"get": {
+ "summary": "Actuator web endpoint 'heapdump'",
+ "operationId": "heapdump",
+ "responses": {"200": {
+ "description": "OK",
+ "content": {"*/*": {"schema": {"type": "object"}}}
+ }},
+ "tags": ["Actuator"]
+ }},
"/a1-policy/v2/policies/{policy_id}/status": {"get": {
"summary": "Returns a policy status",
"operationId": "getPolicyStatus",
@@ -851,15 +860,6 @@
"required": true
}],
"tags": ["A1 Policy Management"]
- }},
- "/actuator/heapdump": {"get": {
- "summary": "Actuator web endpoint 'heapdump'",
- "operationId": "heapdump_2",
- "responses": {"200": {
- "description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
- }},
- "tags": ["Actuator"]
}}
},
"info": {
@@ -877,7 +877,6 @@
{"name": "NearRT-RIC Repository"},
{"name": "Callbacks"},
{"name": "Health Check"},
- {"name": "Management of configuration"},
{
"name": "Actuator",
"description": "Monitor and interact",
@@ -885,6 +884,7 @@
"description": "Spring Boot Actuator Web API Documentation",
"url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"
}
- }
+ },
+ {"name": "Management of configuration"}
]
} \ No newline at end of file
diff --git a/a1-policy-management/api/pms-api.yaml b/a1-policy-management/api/pms-api.yaml
index 875e2734..958ec0d4 100644
--- a/a1-policy-management/api/pms-api.yaml
+++ b/a1-policy-management/api/pms-api.yaml
@@ -32,12 +32,12 @@ tags:
- name: NearRT-RIC Repository
- name: Callbacks
- name: Health Check
-- name: Management of configuration
- name: Actuator
description: Monitor and interact
externalDocs:
description: Spring Boot Actuator Web API Documentation
url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
+- name: Management of configuration
paths:
/a1-policy/v2/policy-instances:
get:
@@ -95,6 +95,19 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/error_information'
+ /actuator/threaddump:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'threaddump'
+ operationId: threaddump_2
+ responses:
+ 200:
+ description: OK
+ content:
+ '*/*':
+ schema:
+ type: object
/a1-policy/v2/status:
get:
tags:
@@ -108,12 +121,25 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/status_info_v2'
- /actuator/threaddump:
+ /actuator/loggers:
get:
tags:
- Actuator
- summary: Actuator web endpoint 'threaddump'
- operationId: threaddump_4
+ summary: Actuator web endpoint 'loggers'
+ operationId: loggers
+ responses:
+ 200:
+ description: OK
+ content:
+ '*/*':
+ schema:
+ type: object
+ /actuator/health/**:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'health-path'
+ operationId: health-path
responses:
200:
description: OK
@@ -161,32 +187,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/error_information'
- /actuator/loggers:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'loggers'
- operationId: loggers_2
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: object
- /actuator/health/**:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'health-path'
- operationId: health-path_2
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: object
/a1-policy/v2/policy-types:
get:
tags:
@@ -305,7 +305,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'metrics-requiredMetricName'
- operationId: metrics-requiredMetricName_2
+ operationId: metrics-requiredMetricName
parameters:
- name: requiredMetricName
in: path
@@ -376,7 +376,7 @@ paths:
tags:
- Actuator
summary: Actuator root web endpoint
- operationId: links_1
+ operationId: links
responses:
200:
description: OK
@@ -393,7 +393,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: loggers-name_4
+ operationId: loggers-name_2
parameters:
- name: name
in: path
@@ -413,7 +413,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: loggers-name_3
+ operationId: loggers-name
parameters:
- name: name
in: path
@@ -464,7 +464,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'metrics'
- operationId: metrics_2
+ operationId: metrics
responses:
200:
description: OK
@@ -571,7 +571,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'info'
- operationId: info_2
+ operationId: info
responses:
200:
description: OK
@@ -624,7 +624,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'logfile'
- operationId: logfile_2
+ operationId: logfile
responses:
200:
description: OK
@@ -637,7 +637,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'health'
- operationId: health_2
+ operationId: health
responses:
200:
description: OK
@@ -790,6 +790,19 @@ paths:
'*/*':
schema:
$ref: '#/components/schemas/error_information'
+ /actuator/heapdump:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'heapdump'
+ operationId: heapdump
+ responses:
+ 200:
+ description: OK
+ content:
+ '*/*':
+ schema:
+ type: object
/a1-policy/v2/policies/{policy_id}/status:
get:
tags:
@@ -817,19 +830,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/error_information'
- /actuator/heapdump:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'heapdump'
- operationId: heapdump_2
- responses:
- 200:
- description: OK
- content:
- '*/*':
- schema:
- type: object
components:
schemas:
error_information: