Skip to content

fix: SDK Quickstart #628

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
dmihalcik-virtru merged 6 commits into from
Apr 19, 2024
Merged

fix: SDK Quickstart #628

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2438608
Syntax: quote imports
cakeholeDC Apr 19, 2024
965bd9f
Add missing import
cakeholeDC Apr 19, 2024
c3d4f1a
Adds blank identifier for sdk.New
cakeholeDC Apr 19, 2024
55ff36c
Add comment about replace directives in a submodule
cakeholeDC Apr 19, 2024
b542b65
Update sdk/README.md
cakeholeDC Apr 19, 2024
b61f492
Fix syntax
cakeholeDC Apr 19, 2024
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
24 changes: 19 additions & 5 deletions sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,34 @@
A Go implementation of the OpenTDF protocol, and access library for services
included in the Data Security Platform.

Note: if you are consuming the SDK as a submodule you may need to add replace directives as follows:

```go
replace (
github.com/opentdf/platform/service => ./opentdf/service
github.com/opentdf/platform/lib/fixtures => ./opentdf/lib/fixtures
github.com/opentdf/platform/protocol/go => ./opentdf/protocol/go
github.com/opentdf/platform/lib/ocrypto => ./opentdf/lib/ocrypto
github.com/opentdf/platform/sdk => ./opentdf/sdk
github.com/opentdf/platform/service => ./opentdf/service
)
```

## Quick Start of the Go SDK

```go
package main

import bytes
import io
import os
import strings
import "fmt"
import "bytes"
import "io"
import "os"
import "strings"
import "github.com/opentdf/platform/sdk"


func main() {
s := sdk.New(
s, _ := sdk.New(
sdk.WithAuth(mtls.NewGRPCAuthorizer(creds) /* or OIDC or whatever */),
sdk.WithDataSecurityConfig(/* attribute schemas, kas multi-attribute mapping */),
)
Expand Down