-
-
Notifications
You must be signed in to change notification settings - Fork 3
docs: Promote user-info-fetcher docs to navgation #557
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you :)
Giving @nightkr and @NickLarsenNZ a chance to comment... |
Have we addressed the client API side yet? We shouldn't have been shipping it to demos or customers before that, and the linked docs definitely don't. |
Are you talking about the API described in https://docs.stackable.tech/home/nightly/opa/usage-guide/user-info-fetcher.html#_user_info_fetcher_api? |
The UIF provides the HTTP API, but we should wrap that in an OPA rule we provide (and can update), rather than have everyone hard-code the HTTP stuff themselves. |
I don't think we have that yet. I agree that it would be good to have. Could we simply have a I think we can still do this 'promotion' here and do a follow-up PR to adress this. it's all in nightly anyways, but we need to prioritise the follow-up then edit: I made a ticket for this: #558 |
Yeah, I can see the point of providing a regorule in addition to the HTTP API. The question is if we should block the docs on the API until the rego rules are there 🤔 |
Yes, basically this.
I'd rather avoid keeping
We should, because the current HTTP API is not public or stable. The uif package is the stable API surface, the HTTP API is just an implementation detail for how to get there. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
blocked by #558
I think the change is trivial and I would close this PR until everyone thinks we are ready to include the docs in the navigation |
Reopening according to the decision in the daily, as we where not able to ship #558 in time for the 23.07 release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions.
Co-authored-by: Techassi <[email protected]>
Description
Given that we are using it extensively already (e.g. in the e2e-security demo) and me handing out the link to multiple customers, I would like to promote https://docs.stackable.tech/home/nightly/opa/usage-guide/user-info-fetcher.html to include it in the navigation
Definition of Done Checklist