1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
#
# ========================LICENSE_START=================================
# Copyright (C) 2024: Deutsche Telekom
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# SPDX-License-Identifier: Apache-2.0
# ========================LICENSE_END===================================
#
openapi: 3.0.3
info:
title: "Policy OPA PDP Documentation"
description: Policy OPA PDP Service
version: 1.0.2
x-component: Policy Framework
x-planned-retirement-date: tbd
contact:
name: Deena Mukundan
email: dm00536893@techmahindra.com
servers:
- url: http://policy-opa-pdp:8282/policy/pdpo/v1
- url: https://policy-opa-pdp:8282/policy/pdpo/v1
tags:
- name: Decision
- name: Statistics
- name: HealthCheck
paths:
/decision:
post:
tags:
- Decision
summary: Fetch the decision using specified decision parameters
description: Returns the policy decision from Policy OPA PDP
operationId: decision
parameters:
- name: X-ONAP-RequestID
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OPADecisionRequest'
application/yaml:
schema:
$ref: '#/components/schemas/OPADecisionRequest'
required: false
responses:
200:
description: successful operation
headers:
X-LatestVersion:
description: Used only to communicate an API's latest version
schema:
type: string
X-PatchVersion:
description: Used only to communicate a PATCH version in a response
for troubleshooting purposes only, and will not be provided by the
client on request
schema:
type: string
X-MinorVersion:
description: Used to request or communicate a MINOR version back from
the client to the server, and from the server back to the client
schema:
type: string
X-ONAP-RequestID:
description: Used to track REST transactions for logging purpose
schema:
type: string
format: uuid
content:
application/json:
schema:
$ref: '#/components/schemas/OPADecisionResponse'
application/yaml:
schema:
$ref: '#/components/schemas/OPADecisionResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: Authentication Error
content: {}
403:
description: Authorization Error
content: {}
500:
description: Internal Server Error
content: {}
security:
- basicAuth: []
x-interface info:
last-mod-release: Paris
pdpo-version: 1.0.0
x-codegen-request-body-name: body
/healthcheck:
get:
tags:
- HealthCheck
summary: Perform a system healthcheck
description: Provides healthy status of the Policy OPA PDP component
operationId: healthcheck
parameters:
- name: X-ONAP-RequestID
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: successful operation
headers:
X-LatestVersion:
description: Used only to communicate an API's latest version
schema:
type: string
X-PatchVersion:
description: Used only to communicate a PATCH version in a response
for troubleshooting purposes only, and will not be provided by the
client on request
schema:
type: string
X-MinorVersion:
description: Used to request or communicate a MINOR version back from
the client to the server, and from the server back to the client
schema:
type: string
X-ONAP-RequestID:
description: Used to track REST transactions for logging purpose
schema:
type: string
format: uuid
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckReport'
application/yaml:
schema:
$ref: '#/components/schemas/HealthCheckReport'
401:
description: Authentication Error
content: {}
403:
description: Authorization Error
content: {}
500:
description: Internal Server Error
content: {}
security:
- basicAuth: []
x-interface info:
last-mod-release: Paris
pdpo-version: 1.0.0
/statistics:
get:
tags:
- Statistics
summary: Fetch current statistics
description: Provides current statistics of the Policy OPA PDP component
operationId: statistics
parameters:
- name: X-ONAP-RequestID
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: successful operation
headers:
X-LatestVersion:
description: Used only to communicate an API's latest version
schema:
type: string
X-PatchVersion:
description: Used only to communicate a PATCH version in a response
for troubleshooting purposes only, and will not be provided by the
client on request
schema:
type: string
X-MinorVersion:
description: Used to request or communicate a MINOR version back from
the client to the server, and from the server back to the client
schema:
type: string
X-ONAP-RequestID:
description: Used to track REST transactions for logging purpose
schema:
type: string
format: uuid
content:
application/json:
schema:
$ref: '#/components/schemas/StatisticsReport'
application/yaml:
schema:
$ref: '#/components/schemas/StatisticsReport'
401:
description: Authentication Error
content: {}
403:
description: Authorization Error
content: {}
500:
description: Internal Server Error
content: {}
security:
- basicAuth: []
x-interface info:
last-mod-release: Paris
pdpo-version: 1.0.0
components:
schemas:
ErrorResponse:
type: object
properties:
responseCode:
type: string
enum:
- BAD_REQUEST
- UNAUTHORIZED
- METHOD_NOT_ALLOWED
- NOT_ACCEPTABLE
- REQUEST_TIMEOUT
- CONFLICT
- GONE
- LENGTH_REQUIRED
- PRECONDITION_FAILED
- REQUEST_ENTITY_TOO_LARGE
- REQUEST_URI_TOO_LONG
- UNSUPPORTED_MEDIA_TYPE
- REQUESTED_RANGE_NOT_SATISFIABLE
- EXPECTATION_FAILED
- PRECONDITION_REQUIRED
- TOO_MANY_REQUESTS
- REQUEST_HEADER_FIELDS_TOO_LARGE
- INTERNAL_SERVER_ERROR
- NOT_IMPLEMENTED
- BAD_GATEWAY
- SERVICE_UNAVAILABLE
- GATEWAY_TIMEOUT
- HTTP_VERSION_NOT_SUPPORTED
- NETWORK_AUTHENTICATION_REQUIRED
errorMessage:
type: string
policyName:
type: string
errorDetails:
type: array
items:
type: string
OPADecisionRequest:
type: object
properties:
onapName:
type: string
onapComponent:
type: string
onapInstance:
type: string
currentDateTime:
type: string
format: date-time
currentDate:
type: string
format: date
currentTime:
type: string
format: date-time
timeZone:
type: string
description: "Timezone in IANA format (e.g., 'America/NewYork', 'Europe/Paris', 'UTC')"
timeOffset:
type: string
pattern: '^[+-]?\d{2}:\d{2}$'
description: "Time offset in hours and minutes, e.g., '+02:00' or '-05:00'"
policyName:
type: string
policyFilter:
type: array
items:
type: string
input:
type: object
additionalProperties: true
example:
user: alice
action: read
object: id123
type: dog
HealthCheckReport:
type: object
properties:
name:
type: string
url:
type: string
healthy:
type: boolean
code:
type: integer
format: int32
message:
type: string
OPADecisionResponse:
type: object
properties:
statusMessage:
type: string
decision:
type: string
enum:
- PERMIT
- DENY
- INDETERMINATE
- NOTAPPLICABLE
policyName:
type: string
output:
type: object
additionalProperties: true
StatisticsReport:
type: object
properties:
code:
type: integer
format: int32
totalPolicyTypesCount:
type: integer
format: int64
totalPoliciesCount:
type: integer
format: int64
totalErrorCount:
type: integer
format: int64
permitDecisionsCount:
type: integer
format: int64
denyDecisionsCount:
type: integer
format: int64
deploySuccessCount:
type: integer
format: int64
deployFailureCount:
type: integer
format: int64
undeploySuccessCount:
type: integer
format: int64
undeployFailureCount:
type: integer
format: int64
indeterminantDecisionsCount:
type: integer
format: int64
querySuccessCount:
type: integer
format: int64
queryFailureCount:
type: integer
format: int64
securitySchemes:
basicAuth:
type: http
description: ""
scheme: basic
|
