Skip to content

Commit 8a15c03

Browse files
marythoughtclaude
andcommitted
chore(docs): move version annotations to top of language tabs
Move <SdkVersion> tags from below the code blocks to directly after the <TabItem> opening, so the version badge appears at the top of each language-specific section. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent cd46980 commit 8a15c03

3 files changed

Lines changed: 38 additions & 57 deletions

File tree

docs/sdks/authorization.mdx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ Every authorization call requires an `EntityIdentifier` — the entity (user, se
8989
<Tabs>
9090
<TabItem value="go" label="Go">
9191

92+
<SdkVersion language="go" version="0.16.0" source="opentdf" />
93+
9294
| Helper | Description |
9395
|--------|-------------|
9496
| `authorizationv2.ForEmail(email)` | Identify by email address |
@@ -105,9 +107,6 @@ req := &authorizationv2.GetDecisionRequest{
105107
// ...
106108
}
107109
```
108-
109-
<SdkVersion language="go" version="0.16.0" source="opentdf" />
110-
111110
<details>
112111
<summary>Without helpers (manual proto construction)</summary>
113112

@@ -141,6 +140,8 @@ req := &authorizationv2.GetDecisionRequest{
141140
</TabItem>
142141
<TabItem value="java" label="Java">
143142

143+
<SdkVersion language="java" version="0.13.0" source="opentdf" />
144+
144145
| Helper | Description |
145146
|--------|-------------|
146147
| `EntityIdentifiers.forEmail(email)` | Identify by email address |
@@ -156,9 +157,6 @@ GetDecisionRequest request = GetDecisionRequest.newBuilder()
156157
// ...
157158
.build();
158159
```
159-
160-
<SdkVersion language="java" version="0.13.0" source="opentdf" />
161-
162160
<details>
163161
<summary>Without helpers (manual proto construction)</summary>
164162

@@ -180,6 +178,8 @@ EntityIdentifier.newBuilder()
180178
</TabItem>
181179
<TabItem value="js" label="JavaScript">
182180

181+
<SdkVersion language="js" version="0.14.0" source="opentdf" />
182+
183183
| Helper | Description |
184184
|--------|-------------|
185185
| `EntityIdentifiers.forEmail(email)` | Identify by email address |
@@ -196,9 +196,6 @@ const response = await platform.v2.authorization.getDecision({
196196
// ...
197197
});
198198
```
199-
200-
<SdkVersion language="js" version="0.14.0" source="opentdf" />
201-
202199
<details>
203200
<summary>Without helpers (manual object construction)</summary>
204201

docs/sdks/discovery.mdx

Lines changed: 30 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -94,31 +94,28 @@ Returns all active attributes on the platform. Use this to see what's available
9494
<Tabs groupId="sdk">
9595
<TabItem value="go" label="Go">
9696

97+
<SdkVersion language="go" version="0.14.0" source="opentdf" />
98+
9799
```go
98100
client.ListAttributes(ctx, ...namespaceFilter)
99101
```
100-
101-
<SdkVersion language="go" version="0.14.0" source="opentdf" />
102-
103102
</TabItem>
104103
<TabItem value="java" label="Java">
105104

105+
<SdkVersion language="java" version="0.13.0" source="opentdf" />
106+
106107
```java
107108
sdk.listAttributes()
108109
sdk.listAttributes(namespaceFilter)
109110
```
110-
111-
<SdkVersion language="java" version="0.13.0" source="opentdf" />
112-
113111
</TabItem>
114112
<TabItem value="js" label="JavaScript">
115113

114+
<SdkVersion language="js" version="0.10.0" source="opentdf" />
115+
116116
```typescript
117117
await listAttributes(platformUrl, auth, namespaceFilter?)
118118
```
119-
120-
<SdkVersion language="js" version="0.10.0" source="opentdf" />
121-
122119
</TabItem>
123120
</Tabs>
124121
@@ -213,30 +210,27 @@ Reports whether an attribute definition exists on the platform. Returns `true`/`
213210
<Tabs groupId="sdk">
214211
<TabItem value="go" label="Go">
215212
213+
<SdkVersion language="go" version="0.14.0" source="opentdf" />
214+
216215
```go
217216
client.AttributeExists(ctx, attributeFqn)
218217
```
219-
220-
<SdkVersion language="go" version="0.14.0" source="opentdf" />
221-
222218
</TabItem>
223219
<TabItem value="java" label="Java">
224220
221+
<SdkVersion language="java" version="0.13.0" source="opentdf" />
222+
225223
```java
226224
sdk.attributeExists(attributeFqn)
227225
```
228-
229-
<SdkVersion language="java" version="0.13.0" source="opentdf" />
230-
231226
</TabItem>
232227
<TabItem value="js" label="JavaScript">
233228
229+
<SdkVersion language="js" version="0.10.0" source="opentdf" />
230+
234231
```typescript
235232
await attributeExists(platformUrl, auth, attributeFqn)
236233
```
237-
238-
<SdkVersion language="js" version="0.10.0" source="opentdf" />
239-
240234
</TabItem>
241235
</Tabs>
242236
@@ -301,30 +295,27 @@ Reports whether a specific attribute value FQN exists on the platform. Returns `
301295
<Tabs groupId="sdk">
302296
<TabItem value="go" label="Go">
303297

298+
<SdkVersion language="go" version="0.14.0" source="opentdf" />
299+
304300
```go
305301
client.AttributeValueExists(ctx, valueFqn)
306302
```
307-
308-
<SdkVersion language="go" version="0.14.0" source="opentdf" />
309-
310303
</TabItem>
311304
<TabItem value="java" label="Java">
312305

306+
<SdkVersion language="java" version="0.13.0" source="opentdf" />
307+
313308
```java
314309
sdk.attributeValueExists(valueFqn)
315310
```
316-
317-
<SdkVersion language="java" version="0.13.0" source="opentdf" />
318-
319311
</TabItem>
320312
<TabItem value="js" label="JavaScript">
321313

314+
<SdkVersion language="js" version="0.10.0" source="opentdf" />
315+
322316
```typescript
323317
await attributeValueExists(platformUrl, auth, valueFqn)
324318
```
325-
326-
<SdkVersion language="js" version="0.10.0" source="opentdf" />
327-
328319
</TabItem>
329320
</Tabs>
330321

@@ -389,30 +380,27 @@ Checks that a list of attribute value FQNs exist on the platform **before** call
389380
<Tabs groupId="sdk">
390381
<TabItem value="go" label="Go">
391382

383+
<SdkVersion language="go" version="0.14.0" source="opentdf" />
384+
392385
```go
393386
client.ValidateAttributes(ctx, fqns...)
394387
```
395-
396-
<SdkVersion language="go" version="0.14.0" source="opentdf" />
397-
398388
</TabItem>
399389
<TabItem value="java" label="Java">
400390

391+
<SdkVersion language="java" version="0.13.0" source="opentdf" />
392+
401393
```java
402394
sdk.validateAttributes(fqns)
403395
```
404-
405-
<SdkVersion language="java" version="0.13.0" source="opentdf" />
406-
407396
</TabItem>
408397
<TabItem value="js" label="JavaScript">
409398

399+
<SdkVersion language="js" version="0.10.0" source="opentdf" />
400+
410401
```typescript
411402
await validateAttributes(platformUrl, auth, fqns)
412403
```
413-
414-
<SdkVersion language="js" version="0.10.0" source="opentdf" />
415-
416404
</TabItem>
417405
</Tabs>
418406

@@ -516,30 +504,27 @@ Returns the attribute value FQNs assigned to a specific entity (person or non-pe
516504
<Tabs groupId="sdk">
517505
<TabItem value="go" label="Go">
518506

507+
<SdkVersion language="go" version="0.14.0" source="opentdf" />
508+
519509
```go
520510
client.GetEntityAttributes(ctx, entity)
521511
```
522-
523-
<SdkVersion language="go" version="0.14.0" source="opentdf" />
524-
525512
</TabItem>
526513
<TabItem value="java" label="Java">
527514

515+
<SdkVersion language="java" version="0.13.0" source="opentdf" />
516+
528517
```java
529518
sdk.getEntityAttributes(entity)
530519
```
531-
532-
<SdkVersion language="java" version="0.13.0" source="opentdf" />
533-
534520
</TabItem>
535521
<TabItem value="js" label="JavaScript">
536522

523+
<SdkVersion language="js" version="0.10.0" source="opentdf" />
524+
537525
```typescript
538526
await platform.v2.authorization.getEntitlements({ ... })
539527
```
540-
541-
<SdkVersion language="js" version="0.10.0" source="opentdf" />
542-
543528
The JS SDK does not expose a standalone `getEntityAttributes` function. Use `getEntitlements` via `PlatformClient` in a Node.js server environment.
544529

545530
</TabItem>

docs/sdks/obligations.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,12 +1000,11 @@ The created [Obligation Trigger object](#obligation-trigger-object).
10001000
<Tabs>
10011001
<TabItem value="go" label="Go">
10021002

1003+
<SdkVersion language="go" version="0.16.0" source="opentdf" />
1004+
10031005
```go
10041006
client.Obligations.GetObligationTrigger(ctx, &obligations.GetObligationTriggerRequest{...})
10051007
```
1006-
1007-
<SdkVersion language="go" version="0.16.0" source="opentdf" />
1008-
10091008
</TabItem>
10101009
</Tabs>
10111010

0 commit comments

Comments
 (0)