Add APIs to evaluate policies get result from OPA

eclipse-xpanse · Sep 28, 2023 · 024fd1c · 024fd1c
1 parent e513ae1
commit 024fd1c
Show file tree

Hide file tree

Showing 8 changed files with 510 additions and 29 deletions.
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 # install swag and update docs of openapi with swag
 INSTALL_SWAG := $(shell go get -u github.com/swaggo/swag/cmd/swag;go install github.com/swaggo/swag/cmd/swag)
-UPDATE_DOCS := $(shell swag fmt;swag init -o ./openapi/docs)
+UPDATE_DOCS := $(shell swag fmt;swag init --parseDependency --parseInternal -o ./openapi/docs)
 
 DIST := dist
 EXECUTABLE := policy-man

diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ or API annotations are updated, these files should be updated by the following c
 go get -u github.com/swaggo/swag/cmd/swag
 go install github.com/swaggo/swag/cmd/swag
 swag fmt
-swag init -o ./openapi/docs
+swag init --parseDependency --parseInternal -o ./openapi/docs
 ```
 
 All the above commands are written to the file [Makefile](./Makefile), You can also use commands in the chapter

diff --git a/openapi/docs/docs.go b/openapi/docs/docs.go
@@ -25,9 +25,9 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "tags": [
-                    "Policies Evaluate"
+                    "Policies Evaluation"
                 ],
-                "summary": "Evaluate the policies",
+                "summary": "Evaluate the input by policies",
                 "parameters": [
                     {
                         "description": "evalCmdList",
@@ -67,6 +67,61 @@ const docTemplate = `{
                 }
             }
         },
+        "/evaluate/policies/raw": {
+            "post": {
+                "description": "Evaluate the input by all the policies and get raw result",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Policies Evaluation"
+                ],
+                "summary": "Evaluate the input by policies",
+                "parameters": [
+                    {
+                        "description": "evalCmdList",
+                        "name": "cmdList",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/server.evalCmdList"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/rego.Result"
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/server.ErrorResult"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/server.ErrorResult"
+                        }
+                    },
+                    "502": {
+                        "description": "Bad Gateway",
+                        "schema": {
+                            "$ref": "#/definitions/server.ErrorResult"
+                        }
+                    }
+                }
+            }
+        },
         "/evaluate/policy": {
             "post": {
                 "description": "Evaluate whether the input meets the policy",
@@ -77,9 +132,9 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "tags": [
-                    "Policies Evaluate"
+                    "Policies Evaluation"
                 ],
-                "summary": "Evaluate the policy",
+                "summary": "Evaluate the input by policies",
                 "parameters": [
                     {
                         "description": "evalCmd",
@@ -119,6 +174,61 @@ const docTemplate = `{
                 }
             }
         },
+        "/evaluate/policy/raw": {
+            "post": {
+                "description": "Evaluate the input by the policy and get raw result",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Policies Evaluation"
+                ],
+                "summary": "Evaluate the input by policies",
+                "parameters": [
+                    {
+                        "description": "evalCmd",
+                        "name": "cmd",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/server.evalCmd"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/rego.Result"
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/server.ErrorResult"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/server.ErrorResult"
+                        }
+                    },
+                    "502": {
+                        "description": "Bad Gateway",
+                        "schema": {
+                            "$ref": "#/definitions/server.ErrorResult"
+                        }
+                    }
+                }
+            }
+        },
         "/health": {
             "get": {
                 "description": "Check health status of service",
@@ -214,6 +324,47 @@ const docTemplate = `{
         }
     },
     "definitions": {
+        "rego.ExpressionValue": {
+            "type": "object",
+            "properties": {
+                "location": {
+                    "$ref": "#/definitions/rego.Location"
+                },
+                "text": {
+                    "type": "string"
+                },
+                "value": {}
+            }
+        },
+        "rego.Location": {
+            "type": "object",
+            "properties": {
+                "col": {
+                    "type": "integer"
+                },
+                "row": {
+                    "type": "integer"
+                }
+            }
+        },
+        "rego.Result": {
+            "type": "object",
+            "properties": {
+                "bindings": {
+                    "$ref": "#/definitions/rego.Vars"
+                },
+                "expressions": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/rego.ExpressionValue"
+                    }
+                }
+            }
+        },
+        "rego.Vars": {
+            "type": "object",
+            "additionalProperties": true
+        },
         "server.ErrorResult": {
             "type": "object",
             "required": [