Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update mutators in documentation #261

Closed
mvanderlee opened this issue Sep 23, 2019 · 5 comments
Closed

Update mutators in documentation #261

mvanderlee opened this issue Sep 23, 2019 · 5 comments

Comments

@mvanderlee
Copy link

In the documentation for access rules, the mutator field is singular and an object. However, the code expects mutators with an array of objects as value.

Bonus issue:
Error message is only clear when using a json rules file, not when using yaml.
json error:
error="json: unknown field \"mutator\""

yaml error:
error="An internal server error occurred, please contact the system administrator"

@aeneasr
Copy link
Member

aeneasr commented Sep 23, 2019

Would you be open to fix that in a PR? :)

@mvanderlee
Copy link
Author

I don't have much time atm.

Might I suggest versioned documentation?
I realize that it's still v0 and open source, but it'd be great documentation could at least be marked 'up to date with version x' or something like that.
Yesterday I spend quite a bit of time trying to get /judge to work only to find that it's now /decisions. That documentation has been update just today.

@aeneasr
Copy link
Member

aeneasr commented Sep 24, 2019 via email

@mvanderlee
Copy link
Author

Ah, thank you!

@aeneasr
Copy link
Member

aeneasr commented Sep 25, 2019

I'm closing this - I'd however like to inform you that we'll be adding versioning to access rules to improve the upgrade experience: #266

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants