opa-react: update changeset and README

StyraInc · Jul 10, 2024 · 872b27d · 872b27d
1 parent 9365825
commit 872b27d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/.changeset/strong-melons-sip.md b/.changeset/strong-melons-sip.md
@@ -2,8 +2,8 @@
 "@styra/opa-react": minor
 ---
 
-change exported interfaces names
+change exported interfaces names, and AuthzProvider property
 
 The export iterface `SDK` is now called `OPAClient` for consistency with `@styra/opa`.
 
-It is used in `AuthzProviderContext` and `AuthzProviderProps`.
+It is used in `AuthzProviderContext` and `AuthzProviderProps`, and has been renamed from `sdk` to `opaClient`.
diff --git a/packages/opa-react/README.md b/packages/opa-react/README.md
@@ -10,13 +10,13 @@ The package provides an `useAuthz` hook and a high-level `<Authz>` component.
 They are enabled by wrapping your App into `<AuthzProvider>`:
 
 ```tsx
-<AuthzProvider sdk={sdk} defaultPath="policy" defaultInput={{ user, tenant }}>
+<AuthzProvider opaClient={opaClient} defaultPath="policy" defaultInput={{ user, tenant }}>
   <Nav />
   <Outlet />
 </AuthzProvider>
 ```
 
-This example provides a previously-configured `sdk` instance (`OPAClient` from `@styra/opa`), a request path, and default input (which is merged with per-call inputs).
+This example provides a previously-configured `opaClient` instance (`OPAClient` from `@styra/opa`), a request path, and default input (which is merged with per-call inputs).
 
 They can either be used by providing static children (`<button>Press Here</button>`) and optionally `fallback` and `loading` JSX elements:
 ```tsx