Skip to content

Commit

Permalink
remove the consistency best practice
Browse files Browse the repository at this point in the history
  • Loading branch information
miparnisari committed Nov 26, 2024
1 parent 98bc858 commit 6b2ab27
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions docs/content/getting-started/tuples-api-best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ import {
The following list outlines some guidelines and best practices for using <ProductName format={ProductNameFormat.ShortForm}/>:

- Do not store Personal Identifiable Information in tuples
- Always specify authorization model ID in requests
- Specify the desired consistency in requests
- Always specify authorization model ID whenever possible

## Do Not Store Personal Identifiable Information in Tuples

Expand All @@ -30,20 +29,14 @@ You can use any string for user and object identifiers, however you should not i
The documentation and samples uses first names and simple ids to illustrate easy-to-follow examples.
:::

## Always specify authorization model ID in requests
## Always specify authorization model ID whenever possible

It is strongly recommended that authorization model ID be specified in your Relationship Queries (such as [Check](./perform-check.mdx) and [ListObjects](../interacting/relationship-queries.mdx#listobjects)) and Relationship Commands (such as [Write](./update-tuples.mdx)).

Specifying authorization model ID in API calls have the following advantages:
1. Better performance as <ProductName format={ProductNameFormat.ShortForm}/> will not need to perform a database query to get the latest authorization model ID.
2. Allows consistent behavior in your production system until you are ready to switch to the new model.

## Specify the desired consistency in requests

It is strongly recommended that you specify the `Consistency` value in each individual request. Please see [Query Consistency Modes](../interacting/consistency.mdx) for more details.

In addition, if speed matters to you, we recommend that you follow [Production Best Practices](./production-best-practices.mdx).

## Related Sections

<RelatedSection
Expand Down

0 comments on commit 6b2ab27

Please sign in to comment.