Skip to content

Commit 60e4c70

Browse files
marythoughtclaude
andcommitted
chore(docs): DSPX-2959 add Java/JS shorthand enum updates and version badges
- Update JS imports to use barrel exports from @opentdf/sdk instead of deep proto paths - Update policy.mdx Java example to use PolicyEnums shorthand constants - Update policy.mdx JS example to use enum values instead of strings - Add SdkVersion badges with NEXT placeholders to code samples (replace with actual versions once SDK releases ship) Note: Java code_samples/java/ files are pulled from the java-sdk repo at build time via remote-content plugin. They will update automatically once javaSdkVersion is bumped in docusaurus.config.ts after the java-sdk release containing opentdf/java-sdk#357. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
1 parent ea2c87c commit 60e4c70

3 files changed

Lines changed: 25 additions & 7 deletions

File tree

code_samples/policy_code/create_attribute.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import Tabs from '@theme/Tabs';
22
import TabItem from '@theme/TabItem';
3+
import SdkVersion from '@site/src/components/SdkVersion';
34

45
<details id="create-attribute">
56
<summary>Create an Attribute</summary>
@@ -45,6 +46,8 @@ await platform.v1.attributes.createAttribute({ ... })
4546
<Tabs>
4647
<TabItem value="go" label="Go">
4748

49+
<SdkVersion language="go" version="NEXT" source="opentdf" />
50+
4851
```go
4952
import (
5053
"github.com/opentdf/platform/protocol/go/policy"
@@ -69,15 +72,19 @@ log.Printf("Created attribute: %s (ID: %s)\n",
6972
</TabItem>
7073
<TabItem value="java" label="Java">
7174

75+
<SdkVersion language="java" version="NEXT" source="opentdf" />
76+
7277
import CreateAttributeExample from '@site/code_samples/java/create-attribute.mdx';
7378

7479
<CreateAttributeExample />
7580

7681
</TabItem>
7782
<TabItem value="js" label="JavaScript">
7883

84+
<SdkVersion language="js" version="NEXT" source="opentdf" />
85+
7986
```typescript
80-
import { AttributeRuleTypeEnum } from '@opentdf/sdk/platform/policy/objects_pb.js';
87+
import { AttributeRuleTypeEnum } from '@opentdf/sdk';
8188

8289
const resp = await platform.v1.attributes.createAttribute({
8390
namespaceId: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',

code_samples/policy_code/create_subject_condition_set.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import Tabs from '@theme/Tabs';
22
import TabItem from '@theme/TabItem';
3+
import SdkVersion from '@site/src/components/SdkVersion';
34

45
<details id="create-subject-condition-set">
56
<summary>Create a Subject Condition Set</summary>
@@ -42,6 +43,8 @@ await platform.v1.subjectMapping.createSubjectConditionSet({ ... })
4243
<Tabs>
4344
<TabItem value="go" label="Go">
4445

46+
<SdkVersion language="go" version="NEXT" source="opentdf" />
47+
4548
```go
4649
import (
4750
"github.com/opentdf/platform/protocol/go/policy"
@@ -83,19 +86,23 @@ log.Printf("Created Subject Condition Set with ID: %s\n", resp.GetSubjectConditi
8386
</TabItem>
8487
<TabItem value="java" label="Java">
8588

89+
<SdkVersion language="java" version="NEXT" source="opentdf" />
90+
8691
import CreateSubjectConditionSetExample from '@site/code_samples/java/create-subject-condition-set.mdx';
8792

8893
<CreateSubjectConditionSetExample />
8994

9095
</TabItem>
9196
<TabItem value="js" label="JavaScript">
9297

98+
<SdkVersion language="js" version="NEXT" source="opentdf" />
99+
93100
```typescript
94101
import { create } from '@bufbuild/protobuf';
95102
import {
96103
ConditionBooleanTypeEnum,
97104
SubjectMappingOperatorEnum,
98-
} from '@opentdf/sdk/platform/policy/objects_pb.js';
105+
} from '@opentdf/sdk';
99106
import {
100107
CreateSubjectConditionSetRequestSchema,
101108
} from '@opentdf/sdk/platform/policy/subjectmapping/subject_mapping_pb.js';

docs/sdks/policy.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1666,16 +1666,17 @@ log.Printf("Updated SCS ID: %s\n", resp.GetSubjectConditionSet().GetId())
16661666
```java
16671667
import io.opentdf.platform.policy.*;
16681668
import io.opentdf.platform.policy.subjectmapping.UpdateSubjectConditionSetRequest;
1669+
import static io.opentdf.platform.sdk.PolicyEnums.*;
16691670

16701671
var condition = Condition.newBuilder()
16711672
.setSubjectExternalSelectorValue(".clientId")
1672-
.setOperator(SubjectMappingOperatorEnum.SUBJECT_MAPPING_OPERATOR_ENUM_IN)
1673+
.setOperator(OPERATOR_IN)
16731674
.addSubjectExternalValues("my-service")
16741675
.addSubjectExternalValues("my-other-service")
16751676
.build();
16761677

16771678
var conditionGroup = ConditionGroup.newBuilder()
1678-
.setBooleanOperator(ConditionBooleanTypeEnum.CONDITION_BOOLEAN_TYPE_ENUM_AND)
1679+
.setBooleanOperator(BOOLEAN_AND)
16791680
.addConditions(condition)
16801681
.build();
16811682

@@ -1698,19 +1699,22 @@ System.out.println("Updated SCS ID: " + resp.getSubjectConditionSet().getId());
16981699
<TabItem value="js" label="JavaScript">
16991700

17001701
```typescript
1701-
import { authTokenInterceptor, clientCredentialsTokenProvider } from '@opentdf/sdk';
1702+
import {
1703+
ConditionBooleanTypeEnum,
1704+
SubjectMappingOperatorEnum,
1705+
} from '@opentdf/sdk';
17021706

17031707
const resp = await platform.v1.subjectMapping.updateSubjectConditionSet({
17041708
id: 'a0b1c2d3-0000-0000-0000-000000000099',
17051709
subjectSets: [
17061710
{
17071711
conditionGroups: [
17081712
{
1709-
booleanOperator: 'CONDITION_BOOLEAN_TYPE_ENUM_AND',
1713+
booleanOperator: ConditionBooleanTypeEnum.AND,
17101714
conditions: [
17111715
{
17121716
subjectExternalSelectorValue: '.clientId',
1713-
operator: 'SUBJECT_MAPPING_OPERATOR_ENUM_IN',
1717+
operator: SubjectMappingOperatorEnum.IN,
17141718
subjectExternalValues: ['my-service', 'my-other-service'],
17151719
},
17161720
],

0 commit comments

Comments
 (0)