Skip to content

Commit 94cb6fd

Browse files
committed
fix: comment
'
1 parent 382f798 commit 94cb6fd

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1170,14 +1170,14 @@ try {
11701170

11711171
### Calling Other Endpoints
11721172

1173-
In certain cases you may want to call other APIs not yet wrapped by the SDK. You can do so by using the Raw API available from the `fgaClient`. The Raw API allows you to make raw HTTP calls to any OpenFGA endpoint by specifying the HTTP method, path, parameters, body, and headers, while still honoring the client configuration (authentication, telemetry, retries, and error handling).
1173+
The Raw API provides direct HTTP access to OpenFGA endpoints not yet wrapped by the SDK. It maintains the SDK's client configuration including authentication, telemetry, retries, and error handling.
11741174

1175-
This is useful when:
1176-
- you want to call a new endpoint that is not yet supported by the SDK
1177-
- you are using an earlier version of the SDK that doesn't yet support a particular endpoint
1178-
- you have a custom endpoint deployed that extends the OpenFGA API
1175+
Use cases:
1176+
- Calling endpoints not yet supported by the SDK
1177+
- Using an SDK version that lacks support for a particular endpoint
1178+
- Accessing custom endpoints that extend the OpenFGA API
11791179

1180-
In all cases, you initialize the SDK the same way as usual, and then use the Raw API from the `fgaClient` instance.
1180+
Initialize the SDK normally and access the Raw API via the `fgaClient` instance:
11811181

11821182
```java
11831183
// Initialize the client, same as above

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ A simple example that creates a store, runs a set of calls against it including
1414
- `streamed-list-objects/` - Demonstrates using the StreamedListObjects API to retrieve large result sets without pagination limits
1515

1616
#### Raw API Examples
17-
- `raw-api/` - Demonstrates using the Raw API to call OpenFGA endpoints that are not yet wrapped by the SDK, while still benefiting from the SDK's configuration (authentication, retries, error handling, etc.)
17+
- `raw-api/` - Demonstrates direct HTTP access to OpenFGA endpoints not yet wrapped by the SDK, maintaining SDK configuration (authentication, retries, error handling)
1818

0 commit comments

Comments
 (0)