docs: Promote user-info-fetcher docs to navgation (#557)

* docs: Promote user-info-fetcher docs to navgation * Document future plans * Apply suggestions from code review Co-authored-by: Techassi <[email protected]> --------- Co-authored-by: Techassi <[email protected]>
stackabletech · Jul 23, 2024 · c9684b9 · c9684b9
1 parent 8b6beac
commit c9684b9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/modules/opa/pages/usage-guide/user-info-fetcher.adoc b/docs/modules/opa/pages/usage-guide/user-info-fetcher.adoc
@@ -62,6 +62,16 @@ NOTE: The OAuth2 Client in Keycloak must be given the `view-users` _Service Acco
 // TODO: Document how to use it in OPA regorules, e.g. to authorize based on group membership
 == Example rego rule
 
+[NOTE]
+.User-facing API & API stability
+====
+Since the 24.07 SDP release we provide an example rego rule in our documentation using an HTTP request.
+However, our plan is that the user-facing API of the SPD is *not* the HTTP API of user-info-fetcher, but instead regorules that will automatically be shipped to the OPA server.
+This enables us to make underlying (for example breaking) changes to the HTTP API while keeping the rego rules API stable.
+
+The documentation will be updated to use the deployed rego rules once available.
+====
+
 [NOTE]
 .About unencrypted HTTP
 ====

diff --git a/docs/modules/opa/partials/nav.adoc b/docs/modules/opa/partials/nav.adoc
@@ -4,7 +4,7 @@
 * xref:opa:usage-guide/index.adoc[]
 ** xref:opa:usage-guide/listenerclass.adoc[]
 ** xref:opa:usage-guide/policies.adoc[]
-// ** xref:opa:usage-guide/user-info-fetcher.adoc[] Not yet ready for public consumption
+** xref:opa:usage-guide/user-info-fetcher.adoc[]
 ** xref:opa:usage-guide/resources.adoc[]
 ** xref:opa:usage-guide/logging.adoc[]
 ** xref:opa:usage-guide/monitoring.adoc[]