Skip to content

chore(docs): fix typos #1094

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/docs/api-overview/data/read-relationships.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ POST /v1/tenants/{tenant_id}/data/relationships/read
| [ ] | snap_token | string | - | the snap token to avoid stale cache, see more details on [Snap Tokens](../../reference/snap-tokens) |
| [x] | entity | object | - | contains entity type and id of the entity. Example: repository:1”.
| [x] | relation | string | - | relation of the given entity |
| [ ] | subject | object | - | the user or user set. It containes type and id of the subject. ||
| [ ] | subject | object | - | the user or user set. It contains type and id of the subject. ||

<Tabs>
<TabItem value="go" label="Go">
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-overview/permission/check-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Rather than **or**, if we had an **and** relation then Permify Engine waits the

With the right architecture we expect **7-12 ms** latency. Depending on your load, cache usage and architecture you can get up to **30ms**.

Permify implements several cache mechanisms in order to achieve low latency in scaled distributed systems. See more on the section [Cache Mechanisims](../../reference/cache.md)
Permify implements several cache mechanisms in order to achieve low latency in scaled distributed systems. See more in the section [Cache Mechanisms](../../reference/cache.md)

## Need any help ?

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/installation/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ This guide outlines the process of deploying Permify, on Google Compute Engine.
status: {}
```

2. Apply service manfiest
2. Apply service manifest

```bash
kubectl apply -f service.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This section explains the basic concepts that commonly mentioned in Permify, as

[Google Zanzibar] is the global authorization system used at Google for handling authorization for hundreds of its services and products including; YouTube, Drive, Calendar, Cloud and Maps.

Google published Zanzibar back in 2019, and in a short time it gained attention quickly. In fact some big tech companies started to shift their legacy authorization structure to Zanzibar style systems. Additionaly, Zanzibar based solutions increased over the time. All disclosure; [Permify] is an authorization system based on Zanzibar.
Google published Zanzibar back in 2019, and in a short time it gained attention quickly. In fact some big tech companies started to shift their legacy authorization structure to Zanzibar style systems. Additionally, Zanzibar based solutions increased over the time. All disclosure; [Permify] is an authorization system based on Zanzibar.

For more about Zanzibar check our blog post, [Google Zanzibar In A Nutshell]

Expand Down
19 changes: 9 additions & 10 deletions docs/docs/reference/snap-tokens.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

# Snap Tokens & Zookies

A Snap Token is a token that consists of an encoded timestamp, which is used to ensure fresh results in access control checks.
A Snap Token is a token that consists of an encoded timestamp, which is used to ensure fresh results in access control checks.

## Why you should use Snap Tokens ?

Expand All @@ -11,19 +10,19 @@ Performance standards can be achievable with caching. In Permify, the cache mech

Still, all caches suffer from the risk of becoming stale. If some schema update happens, or relations change then all of the caches should be updated according to it to prevent false positive or false negative results.

Permify avoids this problem with an approach of snapshot reads. Simply, it ensures that access control is evaluated at a consistent point in time to prevent inconsistency.
Permify avoids this problem with an approach of snapshot reads. Simply, it ensures that access control is evaluated at a consistent point in time to prevent inconsistency.

To achieve this, we developed tokens called Snap Tokens that consist of a timestamp that is compared in access checks to ensure that the snapshot of the access control is at least as fresh as the resource timestamp - basically its stored snap token.

## How to use Snap Tokens

Snap Tokens used in endpoints to represent the snapshot and get fresh results of the API's. It mainly used in [Write API] and [Check API].
Snap Tokens used in endpoints to represent the snapshot and get fresh results of the API's. It mainly used in [Write API] and [Check API].

The general workflow for using snap token is getting the snap token from the reponse of Write API request - basically when writing a relational tuple - then mapped it with the resource. One way of doing that is storing snap token in the additional column in your relational database.
The general workflow for using snap token is getting the snap token from the response of Write API request - basically when writing a relational tuple - then mapped it with the resource. One way of doing that is storing snap token in the additional column in your relational database.

Then this snap token can be used in endpoints. For example it can be used in access control check with sending via `snap_token` field to ensure getting check result as fresh as previous request.

```json
```json
{
"schema_version": "ce8siqtmmud16etrelag",
"snap_token": "gp/twGSvLBc=",
Expand All @@ -34,8 +33,8 @@ Then this snap token can be used in endpoints. For example it can be used in acc
"permission": "edit",
"subject": {
"type": "user",
"id": "1",
},
"id": "1"
}
}
```

Expand All @@ -54,6 +53,6 @@ check_{TRANSACTION_ID}_{schema_version}_{context}_organization:1#admin@user:1 ->

When the second request arrives, since a transaction ID was not provided, the latest transaction ID will again be requested from the database. However, since the first request has already written the example above to the cache, and the second request will generate the same hash, this result will be retrieved from the cache.

## More on Cache Mechanism
## More on Cache Mechanism

Permify implements several cache mecnanisims in order to achieve low latency in scaled distributed systems. See more on the section [Cache Mechanisims](./cache.md)
Permify implements several cache mecnanisims in order to achieve low latency in scaled distributed systems. See more in the section [Cache Mechanisms](./cache.md)
2 changes: 1 addition & 1 deletion docs/docs/use-cases/_list.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"id": 1,
"title": "Role Based Access Control (RBAC)",
"description": "Want to implement role to your application ? Define an entity and manage your roles throught your applications.",
"description": "Want to implement role to your application ? Define an entity and manage your roles throughout your applications.",
"link": "./simple-rbac"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In this section we'll investigate proior check request of Permify: **resource ba
| [ ] | snap_token | string | - | the snap token to avoid stale cache, see more details on [Snap Tokens](../../reference/snap-tokens) |
| [x] | entity | object | - | contains entity type and id of the entity. Example: repository:1”.
| [x] | permission | string | - | the action the user wants to perform on the resource |
| [x] | subject | object | - | the user or user set who wants to take the action. It containes type and id of the subject. |
| [x] | subject | object | - | the user or user set who wants to take the action. It contains type and id of the subject. |
| [ ] | depth | integer | 8 | Timeout limit when if recursive database queries got in loop|

#### Request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can delete any stored relation tuples with following path
|----------|----------|---------|---------|-------------------------------------------------------------------------------------------|
| [x] | entity | object | - | contains entity type and id of the entity. Example: repository:1”.
| [x] | relation | string | - | relation of the given entity |
| [ ] | subject | object | - | the user or user set. It containes type and id of the subject. ||
| [ ] | subject | object | - | the user or user set. It contains type and id of the subject. ||

#### Request

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.2.x/api-overview/read-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Read API allows for directly querying the stored graph data to display and filte
| [ ] | snap_token | string | - | the snap token to avoid stale cache, see more details on [Snap Tokens](../reference/snap-tokens) |
| [x] | entity | object | - | contains entity type and id of the entity. Example: repository:1”.
| [x] | relation | string | - | relation of the given entity |
| [ ] | subject | object | - | the user or user set. It containes type and id of the subject. ||
| [ ] | subject | object | - | the user or user set. It contains type and id of the subject. ||

#### Request

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ We want only,
- Students that take that class
- Teachers, whom is teacher of the student that takes that specific class (class member).

can access to calendar of that spesific class.
can access to calendar of that specific class.

```perm
entity class {
Expand All @@ -104,7 +104,7 @@ entity class {
}
```

Since ``member` represents the relation with student entitiy. It can reach its relations with comma. So,
Since ``member` represents the relation with student entity. It can reach its relations with comma. So,

- ``member.self``
indicates student itself, whom takes that class.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ entity team {

#### project entity

Project entity has ``team`` and ``org`` relations. Both these relations represents parent relationship with other entites, parent team and parent organization.
Project entity has ``team`` and ``org`` relations. Both these relations represents parent relationship with other entities, parent team and parent organization.

```perm
entity project {
Expand All @@ -129,7 +129,7 @@ Permify Schema supports ***and***, ***or***, ***and not*** and ***or not*** oper

#### team actions

- Only organization ***admin (admin role)*** and ***team owner*** can perform editing and deleting team spesific resources.
- Only organization ***admin (admin role)*** and ***team owner*** can perform editing and deleting team specific resources.

- Moreover, for inviting a colleague to a team you must have ***admin role*** and either be a ***owner*** or ***member*** on that team.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Rather than **or**, if we had an **and** relation then Permify Engine waits the

For this access check you can ask questions in form of “Which resources can user:X do action Y?” And you’ll get a entity results in a format of string array or as a streaming response depending on the endpoint you're using.

So we have a 2 seperate endpoints for data filtering check request,
So we have a 2 separate endpoints for data filtering check request,

- [/v1/permissions/lookup-entity](#lookup-entity)
- [/v1/permissions/lookup-entity-stream](#lookup-entity-streaming)
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.2.x/installation/brew.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Brew (With Conf)"

# Brew With Configurations

This section shows how to intall and run Permify Service with using brew.
This section shows how to install and run Permify Service with using brew.

### Install Permify

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.2.x/installation/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Guide

Permify is an open-source authorization service that you can run in your environment and works as an API. This guide shows how to set up Permify in your servers and use it accross your applications. Set up and implementation consists of 4 steps,
Permify is an open-source authorization service that you can run in your environment and works as an API. This guide shows how to set up Permify in your servers and use it across your applications. Set up and implementation consists of 4 steps,

1. [Set Up & Run Permify Service](#run-permify-api)
2. [Model your Authorization with Permify's DSL, Permify Schema](#model-your-authorization-with-permify-schema)
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.2.x/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This section explains the basic concepts that commonly mentioned in Permify, as

[Google Zanzibar] is the global authorization system used at Google for handling authorization for hundreds of its services and products including; YouTube, Drive, Calendar, Cloud and Maps.

Google published Zanzibar back in 2019, and in a short time it gained attention quickly. In fact some big tech companies started to shift their legacy authorization structure to Zanzibar style systems. Additionaly, Zanzibar based solutions increased over the time. All disclosure; [Permify] is an authorization system based on Zanzibar.
Google published Zanzibar back in 2019, and in a short time it gained attention quickly. In fact some big tech companies started to shift their legacy authorization structure to Zanzibar style systems. Additionally, Zanzibar based solutions increased over the time. All disclosure; [Permify] is an authorization system based on Zanzibar.

For more about Zanzibar check our blog post, [Google Zanzibar In A Nutshell]

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.2.x/reference/snap-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To achieve this, we developed tokens called Snap Tokens that consist of a timest

Snap Tokens used in endpoints to represent the snapshot and get fresh results of the API's. It mainly used in [Write API] and [Check API].

The general workflow for using snap token is getting the snap token from the reponse of Write API request - basically when writing a relational tuple - then mapped it with the resource. One way of doing that is storing snap token in the additioanl column in your relational database.
The general workflow for using snap token is getting the snap token from the response of Write API request - basically when writing a relational tuple - then mapped it with the resource. One way of doing that is storing snap token in the additional column in your relational database.

Then this snap token can be used in endpoints. For example it can be used in access control check with sending via `snap_token` field to ensure getting check result as fresh as previous request.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can delete any stored relation tuples with following API
| [x] | tenant_id | string | - | identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant `t1` for this field.
| [x] | entity | object | - | contains entity type and id of the entity. Example: repository:1”.
| [x] | relation | string | - | relation of the given entity |
| [ ] | subject | object | - | the user or user set. It containes type and id of the subject. ||
| [ ] | subject | object | - | the user or user set. It contains type and id of the subject. ||

<Tabs>
<TabItem value="go" label="Go">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Read API allows for directly querying the stored graph data to display and filte
| [ ] | snap_token | string | - | the snap token to avoid stale cache, see more details on [Snap Tokens](../../reference/snap-tokens) |
| [x] | entity | object | - | contains entity type and id of the entity. Example: repository:1”.
| [x] | relation | string | - | relation of the given entity |
| [ ] | subject | object | - | the user or user set. It containes type and id of the subject. ||
| [ ] | subject | object | - | the user or user set. It contains type and id of the subject. ||

<Tabs>
<TabItem value="go" label="Go">
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.3.x/installation/brew.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Install with Brew"

# Brew With Configurations

This section shows how to intall and run Permify Service with using brew.
This section shows how to install and run Permify Service with using brew.

### Install Permify

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ For feature requests, bugs, or any improvements you can always open an issue.
### Want to Contribute? Here are the ways to contribute to Permify

* **Contribute to codebase:** We're collaboratively working with our community to make Permify the best it can be! You can develop new features, fix existing issues or make third-party integrations/packages.
* **Improve documentation:** Alongside our codebase, documentation one of the most significant part in our open-source journey. We're trying to give the best DX possible to explain ourselfs and Permify. And you can help on that with importing resources or adding new ones.
* **Improve documentation:** Alongside our codebase, documentation one of the most significant part in our open-source journey. We're trying to give the best DX possible to explain ourselves and Permify. And you can help on that with importing resources or adding new ones.
* **Contribute to playground:** Permify playground allows you to visualize and test your authorization logic. You can contribute to our playground by improving its user interface, fixing glitches, or adding new features.

You can find more details about contributions on [CONTRIBUTING.md](https://github.com/Permify/permify/blob/master/CONTRIBUTING.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.3.x/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This section explains the basic concepts that commonly mentioned in Permify, as

[Google Zanzibar] is the global authorization system used at Google for handling authorization for hundreds of its services and products including; YouTube, Drive, Calendar, Cloud and Maps.

Google published Zanzibar back in 2019, and in a short time it gained attention quickly. In fact some big tech companies started to shift their legacy authorization structure to Zanzibar style systems. Additionaly, Zanzibar based solutions increased over the time. All disclosure; [Permify] is an authorization system based on Zanzibar.
Google published Zanzibar back in 2019, and in a short time it gained attention quickly. In fact some big tech companies started to shift their legacy authorization structure to Zanzibar style systems. Additionally, Zanzibar based solutions increased over the time. All disclosure; [Permify] is an authorization system based on Zanzibar.

For more about Zanzibar check our blog post, [Google Zanzibar In A Nutshell]

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.3.x/reference/snap-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To achieve this, we developed tokens called Snap Tokens that consist of a timest

Snap Tokens used in endpoints to represent the snapshot and get fresh results of the API's. It mainly used in [Write API] and [Check API].

The general workflow for using snap token is getting the snap token from the reponse of Write API request - basically when writing a relational tuple - then mapped it with the resource. One way of doing that is storing snap token in the additional column in your relational database.
The general workflow for using snap token is getting the snap token from the response of Write API request - basically when writing a relational tuple - then mapped it with the resource. One way of doing that is storing snap token in the additional column in your relational database.

Then this snap token can be used in endpoints. For example it can be used in access control check with sending via `snap_token` field to ensure getting check result as fresh as previous request.

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-0.3.x/use-cases/_list.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"id": 1,
"title": "Role Based Access Control (RBAC)",
"description": "Want to implement role to your application ? Define an entity and manage your roles throught your applications.",
"description": "Want to implement role to your application ? Define an entity and manage your roles throughout your applications.",
"link": "./simple-rbac"
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-0.3.x/use-cases/user-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ entity team {

#### project entity

Project entity has ``team`` and ``org`` relations. Both these relations represents parent relationship with other entites, parent team and parent organization.
Project entity has ``team`` and ``org`` relations. Both these relations represents parent relationship with other entities, parent team and parent organization.

```perm
entity project {
Expand All @@ -127,7 +127,7 @@ Permify Schema supports ***and***, ***or***, ***and not*** and ***or not*** oper

#### team actions

- Only organization ***admin (admin role)*** and ***team owner*** can perform editing and deleting team spesific resources.
- Only organization ***admin (admin role)*** and ***team owner*** can perform editing and deleting team specific resources.

- Moreover, for inviting a colleague to a team you must have ***admin role*** and either be a ***owner*** or ***member*** on that team.

Expand Down
Loading