Code Review
/
nonrtric.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Fix Sonar security vulnerabilities
[nonrtric.git]
/
policy-agent
/
docs
/
api.yaml
diff --git
a/policy-agent/docs/api.yaml
b/policy-agent/docs/api.yaml
index
1c41d42
..
a2f1b57
100644
(file)
--- a/
policy-agent/docs/api.yaml
+++ b/
policy-agent/docs/api.yaml
@@
-1,21
+1,21
@@
swagger: '2.0'
info:
swagger: '2.0'
info:
- description: This page lists all the rest apis for
Policy server
.
+ description: This page lists all the rest apis for
the service
.
version: '1.0'
version: '1.0'
- title:
Policy server
+ title:
A1 Policy management service
host: 'localhost:8081'
basePath: /
tags:
host: 'localhost:8081'
basePath: /
tags:
- - name: operation-handler
- description: Operation Handler
- - name: policy-controller
+ - name: A1 Policy Management
description: Policy Controller
description: Policy Controller
- - name: ric-repository-controller
+ - name: Health check
+ description: Status Controller
+ - name: RIC Repository
description: Ric Repository Controller
description: Ric Repository Controller
- - name:
service-controller
+ - name:
Service registry and supervision
description: Service Controller
description: Service Controller
- - name:
status-control
ler
- description:
Status Control
ler
+ - name:
operation-hand
ler
+ description:
Operation Hand
ler
- name: web-mvc-links-handler
description: Web Mvc Links Handler
paths:
- name: web-mvc-links-handler
description: Web Mvc Links Handler
paths:
@@
-328,7
+328,7
@@
paths:
/policies:
get:
tags:
/policies:
get:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Query policies
operationId: getPoliciesUsingGET
produces:
summary: Query policies
operationId: getPoliciesUsingGET
produces:
@@
-361,12
+361,14
@@
paths:
'403':
description: Forbidden
'404':
'403':
description: Forbidden
'404':
- description: Not Found
+ description: RIC or type not found
+ schema:
+ type: string
deprecated: false
/policy:
get:
tags:
deprecated: false
/policy:
get:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Returns a policy configuration
operationId: getPolicyUsingGET
produces:
summary: Returns a policy configuration
operationId: getPolicyUsingGET
produces:
@@
-382,20
+384,16
@@
paths:
description: Policy found
schema:
type: object
description: Policy found
schema:
type: object
- '204':
- description: Policy is not found
- schema:
- type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
- description:
Not F
ound
+ description:
Policy is not f
ound
deprecated: false
put:
tags:
deprecated: false
put:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Put a policy
operationId: putPolicyUsingPUT
consumes:
summary: Put a policy
operationId: putPolicyUsingPUT
consumes:
@@
-431,21
+429,33
@@
paths:
type: string
responses:
'200':
type: string
responses:
'200':
- description: Policy
created or
updated
+ description: Policy updated
schema:
schema:
- type:
string
+ type:
object
'201':
'201':
- description: Created
+ description: Policy created
+ schema:
+ type: object
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
- description: Not Found
+ description: RIC or policy type is not found
+ schema:
+ type: string
+ '405':
+ description: Change is not allowed
+ schema:
+ type: string
+ '423':
+ description: RIC is locked
+ schema:
+ type: string
deprecated: false
delete:
tags:
deprecated: false
delete:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Delete a policy
operationId: deletePolicyUsingDELETE
produces:
summary: Delete a policy
operationId: deletePolicyUsingDELETE
produces:
@@
-469,11
+479,19
@@
paths:
description: Unauthorized
'403':
description: Forbidden
description: Unauthorized
'403':
description: Forbidden
+ '404':
+ description: Policy is not found
+ schema:
+ type: string
+ '423':
+ description: RIC is locked
+ schema:
+ type: string
deprecated: false
/policy_schema:
get:
tags:
deprecated: false
/policy_schema:
get:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Returns one policy type schema definition
operationId: getPolicySchemaUsingGET
produces:
summary: Returns one policy type schema definition
operationId: getPolicySchemaUsingGET
produces:
@@
-494,12
+512,14
@@
paths:
'403':
description: Forbidden
'404':
'403':
description: Forbidden
'404':
- description: Not Found
+ description: RIC is not found
+ schema:
+ type: string
deprecated: false
/policy_schemas:
get:
tags:
deprecated: false
/policy_schemas:
get:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Returns policy type schema definitions
operationId: getPolicySchemasUsingGET
produces:
summary: Returns policy type schema definitions
operationId: getPolicySchemasUsingGET
produces:
@@
-522,12
+542,14
@@
paths:
'403':
description: Forbidden
'404':
'403':
description: Forbidden
'404':
- description: Not Found
+ description: RIC is not found
+ schema:
+ type: string
deprecated: false
/policy_status:
get:
tags:
deprecated: false
/policy_status:
get:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Returns a policy status
operationId: getPolicyStatusUsingGET
produces:
summary: Returns a policy status
operationId: getPolicyStatusUsingGET
produces:
@@
-543,21
+565,19
@@
paths:
description: Policy status
schema:
type: object
description: Policy status
schema:
type: object
- '204':
- description: Policy is not found
- schema:
- type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
- description: Not Found
+ description: Policy is not found
+ schema:
+ type: string
deprecated: false
/policy_types:
get:
tags:
deprecated: false
/policy_types:
get:
tags:
- -
policy-controller
+ -
A1 Policy Management
summary: Query policy type names
operationId: getPolicyTypesUsingGET
produces:
summary: Query policy type names
operationId: getPolicyTypesUsingGET
produces:
@@
-580,12
+600,14
@@
paths:
'403':
description: Forbidden
'404':
'403':
description: Forbidden
'404':
- description: Not Found
+ description: RIC is not found
+ schema:
+ type: string
deprecated: false
/ric:
get:
tags:
deprecated: false
/ric:
get:
tags:
- -
ric-repository-controller
+ -
RIC Repository
summary: Returns the name of a RIC managing one Mananged Element
operationId: getRicUsingGET
produces:
summary: Returns the name of a RIC managing one Mananged Element
operationId: getRicUsingGET
produces:
@@
-613,7
+635,7
@@
paths:
/rics:
get:
tags:
/rics:
get:
tags:
- -
ric-repository-controller
+ -
RIC Repository
summary: Query NearRT RIC information
operationId: getRicsUsingGET
produces:
summary: Query NearRT RIC information
operationId: getRicsUsingGET
produces:
@@
-636,12
+658,14
@@
paths:
'403':
description: Forbidden
'404':
'403':
description: Forbidden
'404':
- description: Not Found
+ description: Policy type is not found
+ schema:
+ type: string
deprecated: false
/service:
put:
tags:
deprecated: false
/service:
put:
tags:
- -
service-controller
+ -
Service registry and supervision
summary: Register a service
operationId: putServiceUsingPUT
consumes:
summary: Register a service
operationId: putServiceUsingPUT
consumes:
@@
-662,6
+686,10
@@
paths:
type: string
'201':
description: Created
type: string
'201':
description: Created
+ '400':
+ description: Cannot parse the ServiceRegistrationInfo
+ schema:
+ type: string
'401':
description: Unauthorized
'403':
'401':
description: Unauthorized
'403':
@@
-672,7
+700,7
@@
paths:
/services:
get:
tags:
/services:
get:
tags:
- -
service-controller
+ -
Service registry and supervision
summary: Returns service information
operationId: getServicesUsingGET
produces:
summary: Returns service information
operationId: getServicesUsingGET
produces:
@@
-695,19
+723,21
@@
paths:
'403':
description: Forbidden
'404':
'403':
description: Forbidden
'404':
- description: Not Found
+ description: Service is not found
+ schema:
+ type: string
deprecated: false
delete:
tags:
deprecated: false
delete:
tags:
- -
service-controller
+ -
Service registry and supervision
summary: Delete a service
operationId: deleteServiceUsingDELETE
produces:
- '*/*'
parameters:
summary: Delete a service
operationId: deleteServiceUsingDELETE
produces:
- '*/*'
parameters:
- - name:
serviceN
ame
+ - name:
n
ame
in: query
in: query
- description:
serviceN
ame
+ description:
n
ame
required: true
type: string
responses:
required: true
type: string
responses:
@@
-716,26
+746,32
@@
paths:
schema:
type: string
'204':
schema:
type: string
'204':
- description: No Content
+ description: OK
+ schema:
+ type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'401':
description: Unauthorized
'403':
description: Forbidden
+ '404':
+ description: Service not found
+ schema:
+ type: string
deprecated: false
/services/keepalive:
post:
tags:
deprecated: false
/services/keepalive:
post:
tags:
- -
service-controller
- summary: Keep the po
i
licies alive for a service
+ -
Service registry and supervision
+ summary: Keep the policies alive for a service
operationId: keepAliveServiceUsingPOST
consumes:
- application/json
produces:
- '*/*'
parameters:
operationId: keepAliveServiceUsingPOST
consumes:
- application/json
produces:
- '*/*'
parameters:
- - name:
serviceN
ame
+ - name:
n
ame
in: query
in: query
- description:
serviceN
ame
+ description:
n
ame
required: true
type: string
responses:
required: true
type: string
responses:
@@
-755,7
+791,7
@@
paths:
/status:
get:
tags:
/status:
get:
tags:
- -
status-controller
+ -
Health check
summary: Returns status and statistics of this service
operationId: getStatusUsingGET
produces:
summary: Returns status and statistics of this service
operationId: getStatusUsingGET
produces:
@@
-786,9
+822,9
@@
definitions:
title: 'Map«string,Link»'
additionalProperties:
$ref: '#/definitions/Link'
title: 'Map«string,Link»'
additionalProperties:
$ref: '#/definitions/Link'
- Mono«ResponseEntity«
Void
»»:
+ Mono«ResponseEntity«
object
»»:
type: object
type: object
- title: Mono«ResponseEntity«
Void
»»
+ title: Mono«ResponseEntity«
object
»»
Mono«ResponseEntity«string»»:
type: object
title: Mono«ResponseEntity«string»»
Mono«ResponseEntity«string»»:
type: object
title: Mono«ResponseEntity«string»»
@@
-822,17
+858,19
@@
definitions:
description: O1 identities for managed entities
items:
type: string
description: O1 identities for managed entities
items:
type: string
- name:
- type: string
- description: identity of the ric
policyTypes:
type: array
description: supported policy types
items:
type: string
policyTypes:
type: array
description: supported policy types
items:
type: string
+ ricName:
+ type: string
+ description: identity of the ric
title: RicInfo
ServiceRegistrationInfo:
type: object
title: RicInfo
ServiceRegistrationInfo:
type: object
+ required:
+ - serviceName
properties:
callbackUrl:
type: string
properties:
callbackUrl:
type: string
@@
-848,6
+886,9
@@
definitions:
ServiceStatus:
type: object
properties:
ServiceStatus:
type: object
properties:
+ callbackUrl:
+ type: string
+ description: callback for notifying of RIC recovery
keepAliveIntervalSeconds:
type: integer
format: int64
keepAliveIntervalSeconds:
type: integer
format: int64