Add RuleSet validation endpoint (in swagger). #49

m-sandusky · 2018-01-02T22:51:54Z

No description provided.

coveralls · 2018-01-02T22:57:41Z

Coverage remained the same at 52.786% when pulling a7e484b on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-02T22:57:41Z

Coverage remained the same at 52.786% when pulling a7e484b on validation-endpoint-swagger into 706b2dd on master.

saminzadeh · 2018-01-02T23:13:23Z

public/r2/v1/swagger/swagger.json

@@ -771,6 +775,52 @@
                    }
                }
            }
+        },
+        "/rulesets/validate": {


If we're validating the full RuleSet, why not have the validation process apart of the normal POST and PUT operations for the mapping and rollup roles.

For example, when you do a PUT on a mapping rules
PUT /namespaces/{namespaceID}/mapping-rules

It can return a HTTP 400: Mapping rule is invalid because {error}

Hey @saminzadeh I've actually updated the diff to include validation for namespace as well so things have changed around. I believe RuleSets are validated on all POST and PUT operations dealing with rules already. The motivation for this endpoint is to:

Provide a validation endpoint for proposed changes to a namespace (ie given a namespace name and its updated RuleSets - validate them). This will be used in CI to validate changes to rules when users have diffs created for their rule changes

Have a way to validate new changes while the user is making them from the UI (without them having to hit create/update.

coveralls · 2018-01-03T00:05:51Z

Coverage remained the same at 52.786% when pulling 3479f5e on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T00:05:51Z

Coverage remained the same at 52.786% when pulling 3479f5e on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T17:01:58Z

Coverage remained the same at 52.786% when pulling ddd736f on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T17:01:58Z

Coverage remained the same at 52.786% when pulling ddd736f on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T17:15:36Z

Coverage remained the same at 52.786% when pulling 8419c96 on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T17:15:36Z

Coverage remained the same at 52.786% when pulling 8419c96 on validation-endpoint-swagger into 706b2dd on master.

saminzadeh

LGMT. As discussed, it will be nice to consolidate a single endpoint in the future POST /namespace and it could take a dry_run parameter.

coveralls · 2018-01-03T22:20:43Z

Coverage remained the same at 52.786% when pulling 84f3c05 on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T22:20:43Z

Coverage remained the same at 52.786% when pulling 84f3c05 on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-03T22:28:10Z

Coverage remained the same at 52.786% when pulling 89e8a3a on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-10T16:12:50Z

Coverage remained the same at 52.786% when pulling 6c8fe19 on validation-endpoint-swagger into 706b2dd on master.

xichen2020

LGTM other than the nits.

xichen2020 · 2018-01-10T18:37:04Z

public/r2/v1/swagger/swagger.json

+                "tags": [
+                    "namespaces"
+                ],
+                "summary": "Performs validation for a Namespace's RuleSet.",


nit: ... for a namespace's ruleset.

xichen2020 · 2018-01-10T18:37:45Z

public/r2/v1/swagger/swagger.json

+                    "namespaces"
+                ],
+                "summary": "Performs validation for a Namespace's RuleSet.",
+                "operationId": "validateNamespaceRuleSet",


nit: just validateRuleSet?

xichen2020 · 2018-01-10T18:39:41Z

public/r2/v1/swagger/swagger.json

+                    },
+                    {
+                        "in": "body",
+                        "name": "rule-set",


nit: just ruleset?

xichen2020 · 2018-01-10T18:39:50Z

public/r2/v1/swagger/swagger.json

+                    {
+                        "in": "body",
+                        "name": "rule-set",
+                        "description": "The rule-set to validate.",


nit: The ruleset to validate.

xichen2020 · 2018-01-10T18:40:36Z

public/r2/v1/swagger/swagger.json

+                ],
+                "responses": {
+                    "200": {
+                        "description": "The rule-set is valid.",


nit: rule-set -> ruleset.

xichen2020 · 2018-01-10T18:40:49Z

public/r2/v1/swagger/swagger.json

+                        }
+                    },
+                    "400": {
+                        "description": "The rule-set is invalid.",


nit: rule-set -> ruleset.

coveralls · 2018-01-10T21:52:16Z

Coverage remained the same at 52.786% when pulling b772a74 on validation-endpoint-swagger into 706b2dd on master.

coveralls · 2018-01-10T21:52:16Z

Coverage remained the same at 52.786% when pulling b772a74 on validation-endpoint-swagger into 706b2dd on master.

xichen2020 · 2018-01-11T05:23:11Z

public/r2/v1/swagger/swagger.json

@@ -189,8 +189,8 @@
                "tags": [
                    "namespaces"
                ],
-                "summary": "Performs validation for a Namespace's RuleSet.",
-                "operationId": "validateNamespaceRuleSet",
+                "summary": "Performs validation for a namespace's ruleSet.",


nit: a namespace's ruleset?

coveralls · 2018-01-12T18:55:55Z

Coverage increased (+4.5%) to 57.333% when pulling 0715a36 on validation-endpoint-swagger into 706b2dd on master.

Add RuleSet validation endpoint.

a7e484b

m-sandusky requested review from saminzadeh and xichen2020 January 2, 2018 22:51

saminzadeh reviewed Jan 2, 2018

View reviewed changes

Include namespace name as param for validation

3479f5e

m-sandusky requested a review from jskelcy January 2, 2018 23:45

m-sandusky changed the title ~~Add RuleSet validation endpoint.~~ Add RuleSet validation endpoint (in swagger). Jan 3, 2018

Update to remove list of RuleSets

ddd736f

Remove unecessary namespace param

8419c96

saminzadeh approved these changes Jan 3, 2018

View reviewed changes

Add namespaceID param and change to PUT

84f3c05

Change endpoint back to POST

89e8a3a

Update endpoint path

6c8fe19

xichen2020 approved these changes Jan 10, 2018

View reviewed changes

Address review comments

b772a74

xichen2020 reviewed Jan 11, 2018

View reviewed changes

Updates validate enpdoint summary

0715a36

m-sandusky merged commit 1441ef1 into master Jan 12, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RuleSet validation endpoint (in swagger). #49

Add RuleSet validation endpoint (in swagger). #49

m-sandusky commented Jan 2, 2018

coveralls commented Jan 2, 2018

coveralls commented Jan 2, 2018

saminzadeh Jan 2, 2018

m-sandusky Jan 2, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

saminzadeh left a comment

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 10, 2018 •

edited

Loading

xichen2020 left a comment

xichen2020 Jan 10, 2018

xichen2020 Jan 10, 2018

xichen2020 Jan 10, 2018

xichen2020 Jan 10, 2018

xichen2020 Jan 10, 2018

xichen2020 Jan 10, 2018

coveralls commented Jan 10, 2018

coveralls commented Jan 10, 2018

xichen2020 Jan 11, 2018

coveralls commented Jan 12, 2018 •

edited

Loading

Add RuleSet validation endpoint (in swagger). #49

Add RuleSet validation endpoint (in swagger). #49

Conversation

m-sandusky commented Jan 2, 2018

coveralls commented Jan 2, 2018

coveralls commented Jan 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

saminzadeh left a comment

Choose a reason for hiding this comment

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018 • edited Loading

coveralls commented Jan 10, 2018 • edited Loading

xichen2020 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Jan 10, 2018

coveralls commented Jan 10, 2018

Choose a reason for hiding this comment

coveralls commented Jan 12, 2018 • edited Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 10, 2018 •

edited

Loading

coveralls commented Jan 12, 2018 •

edited

Loading