Add JSON schemas for the policy configurations #522
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Apart from the code itself, each policy will, at least, have a schema for its configuration. The idea is to have a separate directory for each policy that will contain the policy itself and the schema.
This allows to require 'apicast.policy.somepolicy' instead of 'apicast.policy.somepolicy.policy'.
davidor
force-pushed
the
schema-policies-config
branch
from
f723d2c
to
dde322b
Compare
mikz
reviewed
Dec 5, 2017
| @@ -42,7 +42,8 @@ http { | |||
| log_format time '[$time_local] $host:$server_port $remote_addr:$remote_port "$request" $status $body_bytes_sent ($request_time) $post_action_impact'; | |||
| access_log off; | |||
|
|
|||
| lua_package_path ";;{{prefix}}/?.lua;{{prefix}}/src/?.lua"; | |||
| # src/?/policy.lua allows us to require apicast.policy.apolicy | |||
There was a problem hiding this comment.
I think it is fine now. 👍 Later we can solve it with custom loader.
mikz
reviewed
Dec 5, 2017
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "PATCH"] |
There was a problem hiding this comment.
To be future-proff we definitely should include OPTIONS and when we are at it I think we can include TRACE and CONNECT too. https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
mikz
approved these changes
Dec 5, 2017
There was a problem hiding this comment.
👍 good start
We will have to add more descriptions to those configuration options, but that we can do as we will have some UI prototype.
@ddcesare @thomasmaas please check the JSON schema so you know how they'll look like.
I think we should address #522 (comment) before merging and add at least OPTIONS HTTP method.
👍
davidor
force-pushed
the
schema-policies-config
branch
from
dde322b
to
ffec937
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds JSON schemas for the configurations of the policies that have one. This schemas will be used by the UI to know which parameters it needs to ask the user when configuring a policy.
This PR also changes the organization a bit. Now every policy has its own directory with that contains the policy itself and its schema.
Also, in order to be able to require
apicast.policy.a_policyinstead ofapicast.policy.a_policy.policy, I needed to change lua paths in several places. Ideas on how to make this simpler welcome :)