4 "description" : "Policy Xacml PDP Service",
5 "version" : "Swagger Server",
6 "title" : "Policy Xacml PDP Service",
7 "x-component" : "Policy Framework",
8 "x-planned-retirement-date" : "tbd"
10 "host" : "policy-xacml-pdp:6969",
13 "name" : "HealthCheck"
19 "schemes" : [ "http", "https" ],
21 "/policy/pdpx/v1/healthcheck" : {
23 "tags" : [ "HealthCheck" ],
24 "summary" : "Perform a system healthcheck",
25 "description" : "Provides healthy status of the Policy Xacml PDP component",
26 "operationId" : "healthcheck",
27 "consumes" : [ "application/json", "application/yaml" ],
28 "produces" : [ "application/json", "application/yaml" ],
30 "name" : "X-ONAP-RequestID",
32 "description" : "RequestID for http transaction",
39 "description" : "successful operation",
43 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
47 "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"
51 "description" : "Used only to communicate an API's latest version"
53 "X-ONAP-RequestID" : {
56 "description" : "Used to track REST transactions for logging purpose"
60 "$ref" : "#/definitions/HealthCheckReport"
64 "description" : "Authentication Error"
67 "description" : "Authorization Error"
70 "description" : "Internal Server Error"
76 "x-interface info" : {
77 "last-mod-release" : "Dublin",
78 "pdpx-version" : "1.0.0"
82 "/policy/pdpx/v1/xacml" : {
84 "tags" : [ "Decision" ],
85 "summary" : "Fetch the decision using specified decision parameters",
86 "description" : "Returns the policy decision from Policy Xacml PDP",
87 "operationId" : "xacml",
88 "consumes" : [ "application/xacml+json", "application/xacml+xml" ],
89 "produces" : [ "application/xacml+json", "application/xacml+xml" ],
95 "$ref" : "#/definitions/Request"
98 "name" : "X-ONAP-RequestID",
100 "description" : "RequestID for http transaction",
107 "description" : "successful operation",
111 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
115 "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"
117 "X-LatestVersion" : {
119 "description" : "Used only to communicate an API's latest version"
121 "X-ONAP-RequestID" : {
124 "description" : "Used to track REST transactions for logging purpose"
128 "$ref" : "#/definitions/Response"
132 "description" : "Bad Request",
134 "$ref" : "#/definitions/ErrorResponse"
138 "description" : "Authentication Error"
141 "description" : "Authorization Error"
144 "description" : "Internal Server Error"
150 "x-interface info" : {
151 "last-mod-release" : "Frankfurt",
152 "pdpx-version" : "1.0.0"
156 "/policy/pdpx/v1/statistics" : {
158 "tags" : [ "Statistics" ],
159 "summary" : "Fetch current statistics",
160 "description" : "Provides current statistics of the Policy Xacml PDP component",
161 "operationId" : "statistics",
162 "consumes" : [ "application/json", "application/yaml" ],
163 "produces" : [ "application/json", "application/yaml" ],
165 "name" : "X-ONAP-RequestID",
167 "description" : "RequestID for http transaction",
174 "description" : "successful operation",
178 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
182 "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"
184 "X-LatestVersion" : {
186 "description" : "Used only to communicate an API's latest version"
188 "X-ONAP-RequestID" : {
191 "description" : "Used to track REST transactions for logging purpose"
195 "$ref" : "#/definitions/StatisticsReport"
199 "description" : "Authentication Error"
202 "description" : "Authorization Error"
205 "description" : "Internal Server Error"
211 "x-interface info" : {
212 "last-mod-release" : "Dublin",
213 "pdpx-version" : "1.0.0"
217 "/policy/pdpx/v1/decision" : {
219 "tags" : [ "Decision" ],
220 "summary" : "Fetch the decision using specified decision parameters",
221 "description" : "Returns the policy decision from Policy Xacml PDP",
222 "operationId" : "decision",
223 "consumes" : [ "application/json", "application/yaml" ],
224 "produces" : [ "application/json", "application/yaml" ],
230 "$ref" : "#/definitions/DecisionRequest"
233 "name" : "X-ONAP-RequestID",
235 "description" : "RequestID for http transaction",
242 "description" : "successful operation",
246 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
250 "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"
252 "X-LatestVersion" : {
254 "description" : "Used only to communicate an API's latest version"
256 "X-ONAP-RequestID" : {
259 "description" : "Used to track REST transactions for logging purpose"
263 "$ref" : "#/definitions/DecisionResponse"
267 "description" : "Bad Request",
269 "$ref" : "#/definitions/ErrorResponse"
273 "description" : "Authentication Error"
276 "description" : "Authorization Error"
279 "description" : "Internal Server Error"
285 "x-interface info" : {
286 "last-mod-release" : "Dublin",
287 "pdpx-version" : "1.0.0"
292 "securityDefinitions" : {
299 "HealthCheckReport" : {
323 "attributeAssignments" : {
326 "$ref" : "#/definitions/AttributeAssignment"
330 "$ref" : "#/definitions/Identifier"
338 "$ref" : "#/definitions/Identifier"
343 "$ref" : "#/definitions/AttributeValueObject"
347 "$ref" : "#/definitions/Identifier"
352 "includeInResults" : {
357 "AttributeAssignment" : {
361 "$ref" : "#/definitions/AttributeValueObject"
364 "$ref" : "#/definitions/Identifier"
367 "$ref" : "#/definitions/Identifier"
373 "$ref" : "#/definitions/Identifier"
377 "AttributeCategory" : {
381 "$ref" : "#/definitions/Identifier"
386 "$ref" : "#/definitions/Attribute"
395 "$ref" : "#/definitions/Identifier"
398 "$ref" : "#/definitions/Identifier"
405 "AttributeValueObject" : {
409 "$ref" : "#/definitions/Identifier"
412 "$ref" : "#/definitions/Identifier"
423 "$ref" : "#/definitions/Version"
426 "$ref" : "#/definitions/Identifier"
439 "MissingAttributeDetail" : {
443 "$ref" : "#/definitions/Identifier"
446 "$ref" : "#/definitions/Identifier"
451 "attributeValues" : {
454 "$ref" : "#/definitions/AttributeValueObject"
458 "$ref" : "#/definitions/Identifier"
465 "attributeAssignments" : {
468 "$ref" : "#/definitions/AttributeAssignment"
472 "$ref" : "#/definitions/Identifier"
482 "$ref" : "#/definitions/Result"
491 "$ref" : "#/definitions/Status"
495 "enum" : [ "PERMIT", "DENY", "INDETERMINATE", "INDETERMINATE_PERMIT", "INDETERMINATE_DENY", "INDETERMINATE_DENYPERMIT", "NOTAPPLICABLE" ]
497 "associatedAdvice" : {
500 "$ref" : "#/definitions/Advice"
506 "$ref" : "#/definitions/Obligation"
509 "policyIdentifiers" : {
512 "$ref" : "#/definitions/IdReference"
515 "policySetIdentifiers" : {
518 "$ref" : "#/definitions/IdReference"
524 "$ref" : "#/definitions/AttributeCategory"
533 "$ref" : "#/definitions/StatusCode"
539 "$ref" : "#/definitions/StatusDetail"
549 "statusCodeValue" : {
550 "$ref" : "#/definitions/Identifier"
553 "$ref" : "#/definitions/StatusCode"
560 "missingAttributeDetails" : {
563 "$ref" : "#/definitions/MissingAttributeDetail"
588 "enum" : [ "OK", "CREATED", "ACCEPTED", "NO_CONTENT", "RESET_CONTENT", "PARTIAL_CONTENT", "MOVED_PERMANENTLY", "FOUND", "SEE_OTHER", "NOT_MODIFIED", "USE_PROXY", "TEMPORARY_REDIRECT", "BAD_REQUEST", "UNAUTHORIZED", "PAYMENT_REQUIRED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "PROXY_AUTHENTICATION_REQUIRED", "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" ]
607 "DOMConfiguration" : {
611 "$ref" : "#/definitions/DOMStringList"
615 "DOMImplementation" : {
630 "documentElement" : {
631 "$ref" : "#/definitions/Element"
636 "strictErrorChecking" : {
646 "$ref" : "#/definitions/DOMImplementation"
649 "$ref" : "#/definitions/DocumentType"
658 "$ref" : "#/definitions/DOMConfiguration"
670 "$ref" : "#/definitions/Document"
676 "$ref" : "#/definitions/NodeList"
686 "$ref" : "#/definitions/Node"
689 "$ref" : "#/definitions/Node"
692 "$ref" : "#/definitions/Node"
695 "$ref" : "#/definitions/Node"
697 "previousSibling" : {
698 "$ref" : "#/definitions/Node"
707 "$ref" : "#/definitions/NamedNodeMap"
715 "$ref" : "#/definitions/NamedNodeMap"
724 "$ref" : "#/definitions/NamedNodeMap"
742 "$ref" : "#/definitions/Document"
748 "$ref" : "#/definitions/NodeList"
758 "$ref" : "#/definitions/Node"
761 "$ref" : "#/definitions/Node"
764 "$ref" : "#/definitions/Node"
767 "$ref" : "#/definitions/Node"
769 "previousSibling" : {
770 "$ref" : "#/definitions/Node"
779 "$ref" : "#/definitions/NamedNodeMap"
790 "$ref" : "#/definitions/TypeInfo"
802 "$ref" : "#/definitions/Document"
808 "$ref" : "#/definitions/NodeList"
818 "$ref" : "#/definitions/Node"
821 "$ref" : "#/definitions/Node"
824 "$ref" : "#/definitions/Node"
827 "$ref" : "#/definitions/Node"
829 "previousSibling" : {
830 "$ref" : "#/definitions/Node"
839 "$ref" : "#/definitions/NamedNodeMap"
865 "$ref" : "#/definitions/Document"
871 "$ref" : "#/definitions/NodeList"
881 "$ref" : "#/definitions/Node"
884 "$ref" : "#/definitions/Node"
887 "$ref" : "#/definitions/Node"
890 "$ref" : "#/definitions/Node"
892 "previousSibling" : {
893 "$ref" : "#/definitions/Node"
902 "$ref" : "#/definitions/NamedNodeMap"
918 "requestDefaults" : {
919 "$ref" : "#/definitions/RequestDefaults"
924 "$ref" : "#/definitions/RequestReference"
928 "$ref" : "#/definitions/Status"
930 "requestAttributesIncludedInResult" : {
933 "$ref" : "#/definitions/AttributeCategory"
936 "combinedDecision" : {
939 "returnPolicyIdList" : {
942 "requestAttributes" : {
945 "$ref" : "#/definitions/RequestAttributes"
950 "RequestAttributes" : {
954 "$ref" : "#/definitions/Node"
960 "$ref" : "#/definitions/Identifier"
965 "$ref" : "#/definitions/Attribute"
970 "RequestAttributesReference" : {
978 "RequestDefaults" : {
987 "RequestReference" : {
990 "attributesReferences" : {
993 "$ref" : "#/definitions/RequestAttributesReference"
1009 "StatisticsReport" : {
1016 "totalPolicyTypesCount" : {
1020 "totalPoliciesCount" : {
1024 "totalErrorCount" : {
1028 "permitDecisionsCount" : {
1032 "denyDecisionsCount" : {
1036 "indeterminantDecisionsCount" : {
1040 "notApplicableDecisionsCount" : {
1046 "DecisionResponse" : {
1057 "additionalProperties" : {
1063 "additionalProperties" : {
1069 "additionalProperties" : {
1075 "DecisionRequest" : {
1092 "additionalProperties" : {
1101 "additionalProperties" : {