Skip to content

chore(docs): use shorthand enum names in subject mapping docs #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marythought merged 3 commits into from
Apr 30, 2026
Merged

chore(docs): use shorthand enum names in subject mapping docs #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab3dd1a
chore(docs): DSPX-2959 use shorthand enum constants in Go SDK examples
marythought Apr 27, 2026
4903cd3
chore(docs): DSPX-2959 add Java/JS shorthand enum updates and version…
marythought Apr 28, 2026
53d6526
chore(docs): replace NEXT version placeholders with target SDK versions
marythought Apr 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions code_samples/policy_code/create_attribute.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SdkVersion from '@site/src/components/SdkVersion';

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

<SdkVersion language="go" version="0.18.0" source="opentdf" />

```go
import (
"github.com/opentdf/platform/protocol/go/policy"
Expand All @@ -55,7 +58,7 @@ resp, err := client.Attributes.CreateAttribute(context.Background(),
&attributes.CreateAttributeRequest{
NamespaceId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
Name: "classification",
Rule: policy.AttributeRuleTypeEnum_ATTRIBUTE_RULE_TYPE_ENUM_ANY_OF,
Rule: policy.RuleAnyOf,
Values: []string{"public", "confidential", "secret"},
},
)
Expand All @@ -69,15 +72,19 @@ log.Printf("Created attribute: %s (ID: %s)\n",
</TabItem>
<TabItem value="java" label="Java">

<SdkVersion language="java" version="0.15.0" source="opentdf" />

import CreateAttributeExample from '@site/code_samples/java/create-attribute.mdx';

<CreateAttributeExample />

</TabItem>
<TabItem value="js" label="JavaScript">

<SdkVersion language="js" version="0.17.0" source="opentdf" />

```typescript
import { AttributeRuleTypeEnum } from '@opentdf/sdk/platform/policy/objects_pb.js';
import { AttributeRuleTypeEnum } from '@opentdf/sdk';

const resp = await platform.v1.attributes.createAttribute({
namespaceId: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
Expand Down
13 changes: 10 additions & 3 deletions code_samples/policy_code/create_subject_condition_set.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SdkVersion from '@site/src/components/SdkVersion';

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

<SdkVersion language="go" version="0.18.0" source="opentdf" />

```go
import (
"github.com/opentdf/platform/protocol/go/policy"
Expand All @@ -56,11 +59,11 @@ conditionset := &subjectmapping.CreateSubjectConditionSetRequest{
{
ConditionGroups: []*policy.ConditionGroup{
{
BooleanOperator: policy.ConditionBooleanTypeEnum_CONDITION_BOOLEAN_TYPE_ENUM_AND,
BooleanOperator: policy.BooleanAnd,
Conditions: []*policy.Condition{
{
SubjectExternalSelectorValue: ".clientId",
Operator: policy.SubjectMappingOperatorEnum_SUBJECT_MAPPING_OPERATOR_ENUM_IN,
Operator: policy.OperatorIn,
SubjectExternalValues: []string{"opentdf"},
},
},
Expand All @@ -83,19 +86,23 @@ log.Printf("Created Subject Condition Set with ID: %s\n", resp.GetSubjectConditi
</TabItem>
<TabItem value="java" label="Java">

<SdkVersion language="java" version="0.15.0" source="opentdf" />

import CreateSubjectConditionSetExample from '@site/code_samples/java/create-subject-condition-set.mdx';

<CreateSubjectConditionSetExample />

</TabItem>
<TabItem value="js" label="JavaScript">

<SdkVersion language="js" version="0.17.0" source="opentdf" />

```typescript
import { create } from '@bufbuild/protobuf';
import {
ConditionBooleanTypeEnum,
SubjectMappingOperatorEnum,
} from '@opentdf/sdk/platform/policy/objects_pb.js';
} from '@opentdf/sdk';
import {
CreateSubjectConditionSetRequestSchema,
} from '@opentdf/sdk/platform/policy/subjectmapping/subject_mapping_pb.js';
Expand Down
18 changes: 11 additions & 7 deletions docs/sdks/policy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1639,11 +1639,11 @@ resp, err := client.SubjectMapping.UpdateSubjectConditionSet(context.Background(
{
ConditionGroups: []*policy.ConditionGroup{
{
BooleanOperator: policy.ConditionBooleanTypeEnum_CONDITION_BOOLEAN_TYPE_ENUM_AND,
BooleanOperator: policy.BooleanAnd,
Conditions: []*policy.Condition{
{
SubjectExternalSelectorValue: ".clientId",
Operator: policy.SubjectMappingOperatorEnum_SUBJECT_MAPPING_OPERATOR_ENUM_IN,
Operator: policy.OperatorIn,
SubjectExternalValues: []string{"my-service", "my-other-service"},
},
},
Expand All @@ -1666,16 +1666,17 @@ log.Printf("Updated SCS ID: %s\n", resp.GetSubjectConditionSet().GetId())
```java
import io.opentdf.platform.policy.*;
import io.opentdf.platform.policy.subjectmapping.UpdateSubjectConditionSetRequest;
import static io.opentdf.platform.sdk.PolicyEnums.*;

var condition = Condition.newBuilder()
.setSubjectExternalSelectorValue(".clientId")
.setOperator(SubjectMappingOperatorEnum.SUBJECT_MAPPING_OPERATOR_ENUM_IN)
.setOperator(OPERATOR_IN)
.addSubjectExternalValues("my-service")
.addSubjectExternalValues("my-other-service")
.build();

var conditionGroup = ConditionGroup.newBuilder()
.setBooleanOperator(ConditionBooleanTypeEnum.CONDITION_BOOLEAN_TYPE_ENUM_AND)
.setBooleanOperator(BOOLEAN_AND)
.addConditions(condition)
.build();

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

```typescript
import { authTokenInterceptor, clientCredentialsTokenProvider } from '@opentdf/sdk';
import {
ConditionBooleanTypeEnum,
SubjectMappingOperatorEnum,
} from '@opentdf/sdk';

const resp = await platform.v1.subjectMapping.updateSubjectConditionSet({
id: 'a0b1c2d3-0000-0000-0000-000000000099',
subjectSets: [
{
conditionGroups: [
{
booleanOperator: 'CONDITION_BOOLEAN_TYPE_ENUM_AND',
booleanOperator: ConditionBooleanTypeEnum.AND,
conditions: [
{
subjectExternalSelectorValue: '.clientId',
operator: 'SUBJECT_MAPPING_OPERATOR_ENUM_IN',
operator: SubjectMappingOperatorEnum.IN,
subjectExternalValues: ['my-service', 'my-other-service'],
},
],
Expand Down
12 changes: 6 additions & 6 deletions docs/sdks/quickstart/go.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ if getAttrResp == nil {
&attributes.CreateAttributeRequest{
NamespaceId: nsResp.GetNamespace().GetId(),
Name: "department",
Rule: policy.AttributeRuleTypeEnum_ATTRIBUTE_RULE_TYPE_ENUM_ANY_OF,
Rule: policy.RuleAnyOf,
})
if err != nil {
log.Fatalf("Failed to create attribute: %v", err)
Expand Down Expand Up @@ -360,11 +360,11 @@ scsResp, err := client.SubjectMapping.CreateSubjectConditionSet(context.Backgrou
{
ConditionGroups: []*policy.ConditionGroup{
{
BooleanOperator: policy.ConditionBooleanTypeEnum_CONDITION_BOOLEAN_TYPE_ENUM_AND,
BooleanOperator: policy.BooleanAnd,
Conditions: []*policy.Condition{
{
SubjectExternalSelectorValue: ".clientId",
Operator: policy.SubjectMappingOperatorEnum_SUBJECT_MAPPING_OPERATOR_ENUM_IN,
Operator: policy.OperatorIn,
SubjectExternalValues: []string{"opentdf"},
},
},
Expand Down Expand Up @@ -514,7 +514,7 @@ func main() {
&attributes.CreateAttributeRequest{
NamespaceId: nsResp.GetNamespace().GetId(),
Name: "department",
Rule: policy.AttributeRuleTypeEnum_ATTRIBUTE_RULE_TYPE_ENUM_ANY_OF,
Rule: policy.RuleAnyOf,
Values: []string{"marketing"},
})
if err != nil {
Expand Down Expand Up @@ -583,11 +583,11 @@ func main() {
{
ConditionGroups: []*policy.ConditionGroup{
{
BooleanOperator: policy.ConditionBooleanTypeEnum_CONDITION_BOOLEAN_TYPE_ENUM_AND,
BooleanOperator: policy.BooleanAnd,
Conditions: []*policy.Condition{
{
SubjectExternalSelectorValue: ".clientId",
Operator: policy.SubjectMappingOperatorEnum_SUBJECT_MAPPING_OPERATOR_ENUM_IN,
Operator: policy.OperatorIn,
SubjectExternalValues: []string{"opentdf"},
},
},
Expand Down
Loading