feat: several interface changes + new Model ID related methods under …

…client

- make `AuthorizationModelId` not a pointer in `ClientConfiguration`
- add `GetAuthorizationModelId` and `SetAuthorizationModelId` to `OpenFgaClient`
- Change `TupleKey` field in `OpenFgaApi.Assertion` to `AssertionTupleKey`

.openapi-generator/FILES

@@ -22,6 +22,7 @@ configuration.go
 credentials/credentials.go
 docs/Any.md
 docs/Assertion.md
+docs/AssertionTupleKey.md
 docs/AuthorizationModel.md
 docs/CheckRequest.md
 docs/CheckRequestTupleKey.md
@@ -93,6 +94,7 @@ internal/utils/ulid.go
 internal/utils/ulid_test.go
 model_any.go
 model_assertion.go
+model_assertion_tuple_key.go
 model_authorization_model.go
 model_check_request.go
 model_check_request_tuple_key.go

README.md

@@ -113,6 +113,7 @@ func main() {
  fgaClient, err := NewSdkClient(&ClientConfiguration{
  ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
  StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
+ AuthorizationModelId: os.Getenv("FGA_AUTHORIZATION_MODEL_ID"), // optional, recommended to be set for production
  })
 
  if err != nil {
@@ -134,6 +135,7 @@ func main() {
  fgaClient, err := NewSdkClient(&ClientConfiguration{
  ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
  StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
+ AuthorizationModelId: os.Getenv("FGA_AUTHORIZATION_MODEL_ID"), // optional, recommended to be set for production
  Credentials: &credentials.Credentials{
  Method: credentials.CredentialsMethodApiToken,
  Config: &credentials.Config{
@@ -162,7 +164,7 @@ func main() {
  fgaClient, err := NewSdkClient(&ClientConfiguration{
  ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
  StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
- AuthorizationModelId: openfga.PtrString("OPENFGA_AUTHORIZATION_MODEL_ID"),
+ AuthorizationModelId: os.Getenv("FGA_AUTHORIZATION_MODEL_ID"), // optional, recommended to be set for production
  Credentials: &credentials.Credentials{
  Method: credentials.CredentialsMethodClientCredentials,
  Config: &credentials.Config{
@@ -224,7 +226,7 @@ if err != nil {
 
 // store store.Id in database
 // update the storeId of the current instance
-fgaClient.SetStoreId(*store.Id)
+fgaClient.SetStoreId(store.Id)
 // continue calling the API normally, scoped to this store
 ```
 
@@ -796,6 +798,7 @@ Class | Method | HTTP request | Description
 
  - [Any](docs/Any.md)
  - [Assertion](docs/Assertion.md)
+ - [AssertionTupleKey](docs/AssertionTupleKey.md)
  - [AuthorizationModel](docs/AuthorizationModel.md)
  - [CheckRequest](docs/CheckRequest.md)
  - [CheckRequestTupleKey](docs/CheckRequestTupleKey.md)

client/client.go

@@ -37,17 +37,17 @@ type ClientConfiguration struct {
  fgaSdk.Configuration
  // ApiScheme - defines the scheme for the API: http or https
  // Deprecated: use ApiUrl instead of ApiScheme and ApiHost
- ApiScheme string `json:"api_scheme,omitempty"`
+ ApiScheme string `json:"api_scheme"`
  // ApiHost - defines the host for the API without the scheme e.g. (api.fga.example)
  // Deprecated: use ApiUrl instead of ApiScheme and ApiHost
- ApiHost string `json:"api_host,omitempty"`
- ApiUrl string `json:"api_url,omitempty"`
- StoreId string `json:"store_id,omitempty"`
- AuthorizationModelId *string `json:"authorization_model_id,omitempty"`
- Credentials *credentials.Credentials `json:"credentials,omitempty"`
- DefaultHeaders map[string]string `json:"default_headers,omitempty"`
- UserAgent string `json:"user_agent,omitempty"`
- Debug bool `json:"debug,omitempty"`
+ ApiHost string `json:"api_host"`
+ ApiUrl string `json:"api_url"`
+ StoreId string `json:"store_id"`
+ AuthorizationModelId string  `json:"authorization_model_id"`
+ Credentials *credentials.Credentials `json:"credentials"`
+ DefaultHeaders map[string]string `json:"default_headers"`
+ UserAgent string `json:"user_agent"`
+ Debug bool `json:"debug"`
  HTTPClient *_nethttp.Client
  RetryParams *fgaSdk.RetryParams
 }
@@ -94,7 +94,7 @@ func NewSdkClient(cfg *ClientConfiguration) (*OpenFgaClient, error) {
 
  // store id is already validate as part of configuration validation
 
- if cfg.AuthorizationModelId != nil && *cfg.AuthorizationModelId != "" && !internalutils.IsWellFormedUlidString(*cfg.AuthorizationModelId) {
+ if cfg.AuthorizationModelId != "" && !internalutils.IsWellFormedUlidString(cfg.AuthorizationModelId) {
  return nil, FgaInvalidError{param: "AuthorizationModelId", description: "ULID"}
  }
 
@@ -417,16 +417,35 @@ type SdkClient interface {
  WriteAssertionsExecute(request SdkClientWriteAssertionsRequestInterface) (*ClientWriteAssertionsResponse, error)
 }
 
+func (client *OpenFgaClient) SetAuthorizationModelId(authorizationModelId string) error {
+ if authorizationModelId != "" && !internalutils.IsWellFormedUlidString(authorizationModelId) {
+ return FgaInvalidError{param: "AuthorizationModelId", description: "ULID"}
+ }
+
+ client.config.AuthorizationModelId = authorizationModelId
+
+ return nil
+}
+
+func (client *OpenFgaClient) GetAuthorizationModelId() (string, error) {
+ modelId := client.config.AuthorizationModelId
+ if modelId != "" && !internalutils.IsWellFormedUlidString(modelId) {
+ return "", FgaInvalidError{param: "AuthorizationModelId", description: "ULID"}
+ }
+
+ return modelId, nil
+}
+
 func (client *OpenFgaClient) getAuthorizationModelId(authorizationModelId *string) (*string, error) {
  modelId := client.config.AuthorizationModelId
  if authorizationModelId != nil && *authorizationModelId != "" {
- modelId = authorizationModelId
+ modelId = *authorizationModelId
  }
 
- if modelId != nil && *modelId != "" && !internalutils.IsWellFormedUlidString(*modelId) {
+ if modelId != "" && !internalutils.IsWellFormedUlidString(modelId) {
  return nil, FgaInvalidError{param: "AuthorizationModelId", description: "ULID"}
  }
- return modelId, nil
+ return &modelId, nil
 }
 
 // helper function to validate the connection (i.e., get token)
@@ -2226,7 +2245,7 @@ type ClientWriteAssertionsRequest = []ClientAssertion
 
 func (clientAssertion ClientAssertion) ToAssertion() fgaSdk.Assertion {
  return fgaSdk.Assertion{
- TupleKey: fgaSdk.CheckRequestTupleKey{
+ TupleKey: fgaSdk.AssertionTupleKey{
  User: clientAssertion.User,
  Relation: clientAssertion.Relation,
  Object: clientAssertion.Object,

client/client_test.go

@@ -106,7 +106,7 @@ func TestOpenFgaClient(t *testing.T) {
  _, err := NewSdkClient(&ClientConfiguration{
  ApiHost: "api.fga.example",
  StoreId: "01GXSB9YR785C4FYS3C0RTG7B2",
- AuthorizationModelId: openfga.PtrString("BadAuthID"),
+ AuthorizationModelId: "BadAuthID",
  })
  if err == nil {
  t.Fatalf("Expect invalid auth mode ID to result in error but there is none")
@@ -117,7 +117,7 @@ func TestOpenFgaClient(t *testing.T) {
  _, err := NewSdkClient(&ClientConfiguration{
  ApiHost: "api.fga.example",
  StoreId: "01GXSB9YR785C4FYS3C0RTG7B2",
- AuthorizationModelId: openfga.PtrString(""),
+ AuthorizationModelId: "",
  })
  if err != nil {
  t.Fatalf("Expect no error when auth model id is empty but has %v", err)
@@ -126,9 +126,8 @@ func TestOpenFgaClient(t *testing.T) {
 
  t.Run("Allow specifying an ApiUrl with a port and a base path", func(t *testing.T) {
  _, err := NewSdkClient(&ClientConfiguration{
- ApiUrl: "https://api.fga.example:8080/fga",
- StoreId: "01GXSB9YR785C4FYS3C0RTG7B2",
- AuthorizationModelId: openfga.PtrString(""),
+ ApiUrl: "https://api.fga.example:8080/fga",
+ StoreId: "01GXSB9YR785C4FYS3C0RTG7B2",
  })
  if err != nil {
  t.Fatalf("Expect no error when auth model id is empty but has %v", err)

docs/Assertion.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**TupleKey** | [**CheckRequestTupleKey**](CheckRequestTupleKey.md) | | 
+**TupleKey** | [**AssertionTupleKey**](AssertionTupleKey.md) | | 
 **Expectation** | **bool** | | 
 
 ## Methods
 
 ### NewAssertion
 
-`func NewAssertion(tupleKey CheckRequestTupleKey, expectation bool, ) *Assertion`
+`func NewAssertion(tupleKey AssertionTupleKey, expectation bool, ) *Assertion`
 
 NewAssertion instantiates a new Assertion object
 This constructor will assign default values to properties that have it defined,
@@ -28,20 +28,20 @@ but it doesn't guarantee that properties required by API are set
 
 ### GetTupleKey
 
-`func (o *Assertion) GetTupleKey() CheckRequestTupleKey`
+`func (o *Assertion) GetTupleKey() AssertionTupleKey`
 
 GetTupleKey returns the TupleKey field if non-nil, zero value otherwise.
 
 ### GetTupleKeyOk
 
-`func (o *Assertion) GetTupleKeyOk() (*CheckRequestTupleKey, bool)`
+`func (o *Assertion) GetTupleKeyOk() (*AssertionTupleKey, bool)`
 
 GetTupleKeyOk returns a tuple with the TupleKey field if it's non-nil, zero value otherwise
 and a boolean to check if the value has been set.
 
 ### SetTupleKey
 
-`func (o *Assertion) SetTupleKey(v CheckRequestTupleKey)`
+`func (o *Assertion) SetTupleKey(v AssertionTupleKey)`
 
 SetTupleKey sets TupleKey field to given value.
 

docs/AssertionTupleKey.md

@@ -0,0 +1,93 @@
+# AssertionTupleKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Object** | **string** | | 
+**Relation** | **string** | | 
+**User** | **string** | | 
+
+## Methods
+
+### NewAssertionTupleKey
+
+`func NewAssertionTupleKey(object string, relation string, user string, ) *AssertionTupleKey`
+
+NewAssertionTupleKey instantiates a new AssertionTupleKey object
+This constructor will assign default values to properties that have it defined,
+and makes sure properties required by API are set, but the set of arguments
+will change when the set of required properties is changed
+
+### NewAssertionTupleKeyWithDefaults
+
+`func NewAssertionTupleKeyWithDefaults() *AssertionTupleKey`
+
+NewAssertionTupleKeyWithDefaults instantiates a new AssertionTupleKey object
+This constructor will only assign default values to properties that have it defined,
+but it doesn't guarantee that properties required by API are set
+
+### GetObject
+
+`func (o *AssertionTupleKey) GetObject() string`
+
+GetObject returns the Object field if non-nil, zero value otherwise.
+
+### GetObjectOk
+
+`func (o *AssertionTupleKey) GetObjectOk() (*string, bool)`
+
+GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetObject
+
+`func (o *AssertionTupleKey) SetObject(v string)`
+
+SetObject sets Object field to given value.
+
+
+### GetRelation
+
+`func (o *AssertionTupleKey) GetRelation() string`
+
+GetRelation returns the Relation field if non-nil, zero value otherwise.
+
+### GetRelationOk
+
+`func (o *AssertionTupleKey) GetRelationOk() (*string, bool)`
+
+GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetRelation
+
+`func (o *AssertionTupleKey) SetRelation(v string)`
+
+SetRelation sets Relation field to given value.
+
+
+### GetUser
+
+`func (o *AssertionTupleKey) GetUser() string`
+
+GetUser returns the User field if non-nil, zero value otherwise.
+
+### GetUserOk
+
+`func (o *AssertionTupleKey) GetUserOk() (*string, bool)`
+
+GetUserOk returns a tuple with the User field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetUser
+
+`func (o *AssertionTupleKey) SetUser(v string)`
+
+SetUser sets User field to given value.
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/OpenFgaApi.md

@@ -1248,7 +1248,7 @@ import (
 func main() {
 
  authorizationModelId := "authorizationModelId_example" // string | 
- body := *openapiclient.NewWriteAssertionsRequest([]openapiclient.Assertion{*openapiclient.NewAssertion(*openapiclient.NewCheckRequestTupleKey("user:anne", "reader", "document:2021-budget"), false)}) // WriteAssertionsRequest | 
+ body := *openapiclient.NewWriteAssertionsRequest([]openapiclient.Assertion{*openapiclient.NewAssertion(*openapiclient.NewAssertionTupleKey("document:2021-budget", "reader", "user:anne"), false)}) // WriteAssertionsRequest | 
 
  configuration, err := openfga.NewConfiguration(openfga.Configuration{
  ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example

go.mod

@@ -1,6 +1,6 @@
 module github.com/openfga/go-sdk
 
-go 1.21.4
+go 1.21.5
 
 require (
  github.com/jarcoal/httpmock v1.3.1

model_assertion.go

@@ -18,15 +18,15 @@ import (
 
 // Assertion struct for Assertion
 type Assertion struct {
- TupleKey CheckRequestTupleKey `json:"tuple_key"yaml:"tuple_key"`
- Expectation bool  `json:"expectation"yaml:"expectation"`
+ TupleKey AssertionTupleKey `json:"tuple_key"yaml:"tuple_key"`
+ Expectation bool `json:"expectation"yaml:"expectation"`
 }
 
 // NewAssertion instantiates a new Assertion object
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed
-func NewAssertion(tupleKey CheckRequestTupleKey, expectation bool) *Assertion {
+func NewAssertion(tupleKey AssertionTupleKey, expectation bool) *Assertion {
  this := Assertion{}
  this.TupleKey = tupleKey
  this.Expectation = expectation
@@ -42,9 +42,9 @@ func NewAssertionWithDefaults() *Assertion {
 }
 
 // GetTupleKey returns the TupleKey field value
-func (o *Assertion) GetTupleKey() CheckRequestTupleKey {
+func (o *Assertion) GetTupleKey() AssertionTupleKey {
  if o == nil {
- var ret CheckRequestTupleKey
+ var ret AssertionTupleKey
  return ret
  }
 
@@ -53,15 +53,15 @@ func (o *Assertion) GetTupleKey() CheckRequestTupleKey {
 
 // GetTupleKeyOk returns a tuple with the TupleKey field value
 // and a boolean to check if the value has been set.
-func (o *Assertion) GetTupleKeyOk() (*CheckRequestTupleKey, bool) {
+func (o *Assertion) GetTupleKeyOk() (*AssertionTupleKey, bool) {
  if o == nil {
  return nil, false
  }
  return &o.TupleKey, true
 }
 
 // SetTupleKey sets field value
-func (o *Assertion) SetTupleKey(v CheckRequestTupleKey) {
+func (o *Assertion) SetTupleKey(v AssertionTupleKey) {
  o.TupleKey = v
 }