Skip to content

Commit

Permalink
docs: Fix .NET-esque comments in README
Browse files Browse the repository at this point in the history
  • Loading branch information
booniepepper committed Sep 28, 2023
1 parent 739f568 commit 68d86e0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Delete a store.
> Requires a client initialized with a storeId
```java
var store = await fgaClient.deleteStore().get();
var store = fgaClient.deleteStore().get();
```

#### Authorization Models
Expand Down Expand Up @@ -335,7 +335,7 @@ var request = new WriteAuthorizationModelRequest()

var response = fgaClient.writeAuthorizationModel(request).get();

// response.AuthorizationModelId = "01GXSA8YR785C4FYS3C0RTG7B1"
// response.getAuthorizationModelId() = "01GXSA8YR785C4FYS3C0RTG7B1"
```

#### Read a Single Authorization Model
Expand Down Expand Up @@ -365,9 +365,9 @@ Reads the latest authorization model (note: this ignores the model id in configu
```java
var response = fgaClient.readLatestAuthorizationModel().get();

// response.AuthorizationModel.Id = "01GXSA8YR785C4FYS3C0RTG7B1"
// response.AuthorizationModel.SchemaVersion = "1.1"
// response.AuthorizationModel.TypeDefinitions = [{ "type": "document", "relations": { ... } }, { "type": "user", "relations": { ... }}]
// response.getAuthorizationModel().getId() = "01GXSA8YR785C4FYS3C0RTG7B1"
// response.getAuthorizationModel().SchemaVersion() = "1.1"
// response.getAuthorizationModel().TypeDefinitions() = [{ "type": "document", "relations": { ... } }, { "type": "user", "relations": { ... }}]
```

#### Relationship Tuples
Expand Down Expand Up @@ -498,7 +498,7 @@ var options = new ClientCheckOptions()
.authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");

var response = fgaClient.check(request, options).get();
// response.Allowed = true
// response.getAllowed() = true
```

##### Batch Check
Expand Down Expand Up @@ -526,7 +526,7 @@ var options = new ClientCheckOptions()

var response = fgaClient.expand(request, options).get();

// response.Tree.Root = {"name":"document:roadmap#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}
// response.getTree().getRoot() = {"name":"document:roadmap#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}
```

##### List Objects
Expand All @@ -552,7 +552,7 @@ var options = new ClientListObjectsOptions()

var response = fgaClient.listObjects(request, options).get();

// response.Objects = ["document:roadmap"]
// response.getObjects() = ["document:roadmap"]
```

##### List Relations
Expand Down

0 comments on commit 68d86e0

Please sign in to comment.