v0.7.1

0.7.1 (2024-09-16)

This release includes fixes for several bugs identified in the previous release related to OpenTelemetry metrics reporting: (#124)

• fix: attribute values are now correctly exported as their intended types (previously, these were all sent as string values)
• fix: http_client_request_duration being reported in seconds rather than the intended milliseconds
• fix: sync client mistakenly passing the entire configuration (rather than just the OpenTelemetry configuration as intended) to queryDuration() and requestDuration()
• fix: some attributes may not have been exported as expected under some conditions
• fix: queryDuration() and requestDuration() may not have updated their histograms reliably when attr_http_client_request_duration or attr_http_server_request_duration (respectively) were not enabled (which is the default)

Please note that if you use third-party OpenTelemetry tooling to visualize the attributes mentioned above, you may need to update your queries to account for these changes.

v0.7.0

0.7.0 (2024-08-30)

• feat: enhancements to OpenTelemetry support (#120)

Breaking Changes

Note this introduces some breaking changes to our metrics:

1. fga-client.request.method is now in TitleCase to match the naming conventions in the Protos, e.g., Check, ListObjects, etc.
2. Due to possible high costs for attributes with high cardinality, we are no longer including the following attributes by default:
   • fga-client.user
   • http.client.request.duration
   • http.server.request.duration
     We added configuration options to allow you to set which specific metrics and attributes you care about in case the defaults don't work for your use case.

v0.6.1

0.6.1 (2024-07-31)

• feat: add support for specifying consistency when evaluating or reading (#113)
  Note: To use this feature, you need to be running OpenFGA v1.5.7+ with the experimental flag enable-consistency-params enabled.
  See the OpenFGA v1.5.7 release notes for details.

v0.6.0

0.6.0 (2024-06-28)

• feat: add OpenTelemetry metrics reporting (#107)

v0.5.0

0.5.0 (2024-06-17)

• fix: ClientTuple condition property type
• fix: list_users should accept FgaObject type
• fix: remove ReadAuthorizationModel calls from BatchCheck and writes
• chore!: remove excluded users from ListUsers response

v0.4.3

0.4.3 (2024-06-07)

• feat: support for list users

v0.4.2

0.4.2 (2024-04-04)

• feat: support for modular models metadata
• feat: support auto-retry of failed network requests
• refactor: remove Python 2 code
• fix: limit the number of network retries
• fix: Configuration class api_scheme, min_wait_in_ms and disabled_client_side_validations validation issues
• chore: update aiohttp to 3.9.2
• chore: update black to 24.3.0

v0.4.1

0.4.1 (2024-02-13)

• feat: support api_url configuration option and deprecate api_scheme and api_host
• fix: use correct content type for token request

v0.4.0

0.4.0 (2024-01-11)

• feat: support for conditions
• chore!: use latest API interfaces for type info
• chore: add example project
• chore: dependency updates

BREAKING CHANGES:
Note: This release comes with substantial breaking changes, especially to the interfaces due to the protobuf changes in the last release.

While the http interfaces did not break (you can still use v0.3.3 SDK with a v1.3.8+ server),
the grpc interface did and this caused a few changes in the interfaces of the SDK.

If you are using OpenFgaClient, the changes required should be smaller, if you are using OpenFgaApi a bit more changes will be needed.

You will have to modify some parts of your code, but we hope this will be to the better as a lot of the parameters are now correctly marked as required,

Some of the changes to expect:

• The following request interfaces changed:
  • CheckRequest: the TupleKey field is now of interface CheckRequestTupleKey, you can also now pass in Context
  • ExpandRequest: the TupleKey field is now of interface ExpandRequestTupleKey
  • ReadRequest: the TupleKey field is now of interface ReadRequestTupleKey
  • WriteRequest: now takes WriteRequestWrites and WriteRequestDeletes, the latter of which accepts TupleKeyWithoutCondition
  • And more
• The following interfaces had fields that were optional are are now required:
  • CreateStoreResponse
  • GetStoreResponse
  • ListStoresResponse
  • ListObjectsResponse
  • ReadChangesResponse
  • ReadResponse
  • AuthorizationModel
  • And more

Take a look at the changes in models in 9ed1f70 and https://github.com/openfga/python-sdk/pull/59/files for more.

v0.3.3

0.3.3 (2024-01-02)

• fix: correct type hints for list_relations
• fix: handle empty TupleKey in read
• chore: add example project