opal
opal copied to clipboard
Docs: More details into utilizing the examples
The main readme only goes into depth for running the compose file. For those trying to experiment with http://localhost:8181/ it would be nice to have some query and scenarios to walk through.
Good idea; though it's more of a documentation issue than a bug; so I've updated the label.
Yeah i would have changed the label but I am not allowed.
Example after tinkering and looking here at query.
- go to http://localhost:8181/
- query field:
data.users[i].roles[_] = "admin"
- execute
- expected result
{
"result": [
{
"i": "alice"
}
]
}
For others that are not following the data you are querying is here https://github.com/permitio/opal-example-policy-repo/blob/master/data.json
hey would love to work on it but the localhost is not opening
HI @kunalranjan19 - what do you mean by " localhost is not opening"? Are you running the OPAL-client with OPA in place?
Hey guys ,i would like to work on this issue , i have done the example policy setup and just trying to understand how is Opal and OPA are working.
Hi @lakshyabhasin509 that would be wonderful, feel free to submit these as .md files in a pull request.
Let us know if you need any guidance here
FYI: @filipermit
any one worked on this yet? i am interested in doing this. but would be needing a little guide.
Hi @Uthycloud - I think this one is up for grabs :) Both @filipermit and I would be happy to provide guidance.
A good place to start is going yourself through the steps here: https://docs.opal.ac/getting-started/quickstart/opal-playground/overview
And then you can add more examples here: https://github.com/permitio/opal/tree/master/documentation/docs/getting-started/quickstart/opal-playground.
I'd suggest each example starts with showing loading policy and/or data with OPAL, and then checking on the result with queries directly to OPA (sharing both the policy, data, commands and queries being sent as part of the example). You can draw inspiration, or even use as is the example we show in this recorded demo: https://youtu.be/A5adHlkmdC0?t=1297