Skip to content

Commit b4d6296

Browse files
committed
docs: update README
1 parent d5c9ceb commit b4d6296

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,27 +125,29 @@ let [can_edit, can_delete, can_share] = vault.batch_check(&[
125125
]).await?[..] else { unreachable!() };
126126
```
127127

128-
## Authorization API
128+
## Usage
129+
130+
### Authorization API
129131

130132
```rust
131133
let vault = client.organization("org_...").vault("vlt_...");
132134
```
133135

134-
### Permission Checks
136+
#### Permission Checks
135137

136138
```rust
137139
let allowed = vault.check("user:alice", "view", "doc:1").await?;
138140
```
139141

140-
### Relationships
142+
#### Relationships
141143

142144
```rust
143145
vault.relationships()
144146
.write(Relationship::new("document:readme", "viewer", "user:alice"))
145147
.await?;
146148
```
147149

148-
### Lookups
150+
#### Lookups
149151

150152
```rust
151153
let docs = vault.resources()
@@ -157,21 +159,21 @@ let docs = vault.resources()
157159

158160
See the [Authorization API Guide](docs/guides/authorization-api.md) for ABAC context, batch checks, explain, simulate, watch, and more.
159161

160-
## Management API
162+
### Management API
161163

162164
```rust
163165
let org = client.organization("org_...");
164166
```
165167

166-
### Vaults
168+
#### Vaults
167169

168170
```rust
169171
let vault = org.vaults()
170172
.create(CreateVaultRequest::new("production"))
171173
.await?;
172174
```
173175

174-
### Schemas
176+
#### Schemas
175177

176178
```rust
177179
vault.schemas().push(r#"
@@ -184,7 +186,7 @@ type document {
184186
"#).await?;
185187
```
186188

187-
### Members & Teams
189+
#### Members & Teams
188190

189191
```rust
190192
org.members()
@@ -196,7 +198,7 @@ org.teams()
196198
.await?;
197199
```
198200

199-
### Audit Logs
201+
#### Audit Logs
200202

201203
```rust
202204
let events = org.audit().list().collect().await?;

0 commit comments

Comments
 (0)