Skip to content

Commit

Permalink
chore: ensure consistent spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
@zepatrik
zepatrik committed Apr 1, 2021
1 parent ffea160 commit a7a64e3
Show file tree
Hide file tree
Showing 24 changed files with 54 additions and 36 deletions.
10 changes: 5 additions & 5 deletions docs/docs/examples/olymp-file-sharing.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Now, the user identified by its unique username `demeter` wants to upload a file
containing the most fertile grounds. The file gets assigned the UUID
`ec788a82-a12e-45a4-b906-3e69f78c94e4`. The application adds the following
[relation tuple](../concepts/relation-tuples.mdx) to Ory Keto through the
[write API](../concepts/api-overview.mdx#write-apis):
[write-API](../concepts/api-overview.mdx#write-apis):

```keto-relation-tuples
ec788a82-a12e-45a4-b906-3e69f78c94e4#owner@demeter
Expand All @@ -36,21 +36,21 @@ share the file with fertile grounds with `athena` so that they can both read it.
Therefore, he opens the "Olymp Library" and is presented with a list of all
files he owns. The application will internally request all
[objects](../concepts/objects.mdx) (file IDs) with the owner `demeter` by using
the [list API](../concepts/api-overview.mdx#list-relation-tuples). The response
the [list-API](../concepts/api-overview.mdx#list-relation-tuples). The response
will contain the object `ec788a82-a12e-45a4-b906-3e69f78c94e4`, which the
application maps to the file in question.

The user `demeter` will then ask the application to share the file with
`athena`. The application will translate that request into a
[write API request](../concepts/api-overview.mdx#write-apis) adding the
[write-API request](../concepts/api-overview.mdx#write-apis) adding the
following relation tuple to Ory Keto:

```keto-relation-tuples
ec788a82-a12e-45a4-b906-3e69f78c94e4#access@athena
```

To confirm the successful operation, the application uses Ory Keto's
[expand API](../concepts/api-overview.mdx#expand-subject-sets) to compile a list
[expand-API](../concepts/api-overview.mdx#expand-subject-sets) to compile a list
of everyone who can access the file:

```keto-relation-tuples
Expand All @@ -70,7 +70,7 @@ which returns the expansion tree
The "Olymp Library" can then display this information to `demeter`.

When `athena` wants to get the file containing fertile grounds, the application
uses the [check API](../concepts/api-overview.mdx#check-relation-tuple) to
uses the [check-API](../concepts/api-overview.mdx#check-relation-tuple) to
verify that `athena` has access to the file before it returns the file. This
will allow `demeter` to revoke `athena`'s access at any point by deleting the
corresponding relation tuple.
6 changes: 3 additions & 3 deletions docs/docs/guides/expand-api-display-who-has-access.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ import CodeTabs from '@theme/CodeTabs'
import RelationTuplePrism from '@theme/RelationTuplePrism'
RelationTuplePrism()

This guide will explain how to use Ory Keto's expand API to display who has
This guide will explain how to use Ory Keto's expand-API to display who has
access to an object, and why. Please refer to the
[gRPC](../reference/proto-api.mdx) and [REST](../reference/rest-api.mdx) API
reference documentation for all details. In general, the expand API allows to
reference documentation for all details. In general, the expand-API allows to
expand a given subject set into all its effective subjects.

## Example
Expand Down Expand Up @@ -70,7 +70,7 @@ directories:/photos#parent@(files:/photos/mountains.jpg#_)
```

The user `maureen` now wants to manage `access` for the file
`/photos/beach.jpg`. Therefore, the application uses the expand API to get a
`/photos/beach.jpg`. Therefore, the application uses the expand-API to get a
tree of everyone who has access to that file:

<CodeTabs
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/guides/list-api-display-objects.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ Another view of the chat application has to display all members of a specific
group to the user. This can also be achieved using the list API. In cases where
such a membership would be modeled through
[subject sets](../concepts/subjects.mdx#subject-sets), you have to use the
[expand API](./expand-api-display-who-has-access.mdx).
[expand-API](./expand-api-display-who-has-access.mdx).

:::caution

In this case the application should probably first use the
[check API](./simple-access-check-guide.mdx) to check whether the user is
[check-API](./simple-access-check-guide.mdx) to check whether the user is
allowed to list the members of a group. This step is not part of this example.

:::
Expand All @@ -112,7 +112,7 @@ knowledge of the structure of subject sets like depth or hierarchy, or the UI
context, like a "My Items" view which should probably contain other objects than
a "My Organizations" or "Shared with Me" views. If there really is no way to
narrow down a query, you will have to use the
[expand API](./expand-api-display-who-has-access) instead, or repeatedly call
[expand-API](./expand-api-display-who-has-access) instead, or repeatedly call
the list API. Try to avoid such cases because they require a lot of resources
and can quickly degrade the service quality for all users. Please refer to the
[performance considerations](../performance.mdx).
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/guides/simple-access-check-guide.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import CodeTabs from '@theme/CodeTabs'
RelationTuplePrism()

This guide will explain how you can use Ory Keto's
[check API](../concepts/api-overview.mdx#check-relation-tuple) to determine
[check-API](../concepts/api-overview.mdx#check-relation-tuple) to determine
whether a [subject](../concepts/subjects.mdx) has a specific
[relation](../concepts/relation-tuples.mdx) on an
[object](../concepts/objects.mdx). The result can be used for controlling access
Expand Down Expand Up @@ -52,7 +52,7 @@ system.

The request (here `decypher` of the message `02y_15_4w350m3`) is then translated
into a request to Ory Keto's
[check API](../concepts/api-overview.mdx#check-relation-tuple). Basically, the
[check-API](../concepts/api-overview.mdx#check-relation-tuple). Basically, the
application is asking Keto "Is john allowed to decypher the text
02y_15_4w350m3?"

Expand Down Expand Up @@ -86,7 +86,7 @@ Try this yourself by first adding the relation tuple using the
version="master"
/>

Now, we can use the check API to verify that `john` is allowed to `decypher` the
Now, we can use the check-API to verify that `john` is allowed to `decypher` the
message:

<CodeTabs
Expand Down Expand Up @@ -143,4 +143,4 @@ persists.

We learned how to integrate check requests and access control into an
application using Ory Keto's
[check API](../concepts/api-overview.mdx#check-relation-tuple).
[check-API](../concepts/api-overview.mdx#check-relation-tuple).
2 changes: 1 addition & 1 deletion docs/docs/performance.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ RelationTuplePrism()

This document explains the time complexity of Ory Keto. Main memory complexity
will be analyzed and added at a later point. We only examine the evaluation
engines (check and expand API) as all other parts are mainly determined by
engines (check- and expand-API) as all other parts are mainly determined by
dependencies like your database of choice, or the de-/encoding of messages.
Examples given omit the namespace for clarity.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/quickstart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ to see this in action.
Now `cat lady` wants to change some view permissions of `/cats/1.mp4`. For this,
the video service application has to show all users that are currently allowed
to view the video. It uses Keto's
[Expand API](./concepts/api-overview.mdx#expand-subject-set) to get these data:
[expand-API](./concepts/api-overview.mdx#expand-subject-set) to get these data:

```shell
# Who is allowed to "view" the object "videos":"/cats/2.mp4"?
Expand Down
14 changes: 7 additions & 7 deletions docs/docs/reference/proto-api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ SubjectSet refers to all subjects who have the same `relation` on an `object`.
The service that performs authorization checks based on the stored Access
Control Lists.

This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).

| Method Name | Request Type | Response Type | Description |
| ----------- | --------------------------------------------------- | ----------------------------------------------------- | -------------------------------- |
Expand All @@ -61,7 +61,7 @@ related to an object.

| Field | Type | Label | Description |
| --------- | ----------------------------------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| namespace | [string](#string) | | The namespace to evaluate the check.<br/>Note: If you use the expand API and the check evaluates a RelationTuple specifying a SubjectSet as subject or due to a rewrite rule in a namespace config this check request may involve other namespaces automatically. |
| namespace | [string](#string) | | The namespace to evaluate the check.<br/>Note: If you use the expand-API and the check evaluates a RelationTuple specifying a SubjectSet as subject or due to a rewrite rule in a namespace config this check request may involve other namespaces automatically. |
| object | [string](#string) | | The related object in this check. |
| relation | [string](#string) | | The relation between the Object and the Subject. |
| subject | [Subject](#ory.keto.acl.v1alpha1.Subject) | | The related subject in this check. |
Expand All @@ -84,7 +84,7 @@ The response for a CheckService.Check rpc.
The service that performs subject set expansion based on the stored Access
Control Lists.

This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).

| Method Name | Request Type | Response Type | Description |
| ----------- | ----------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------ |
Expand Down Expand Up @@ -132,7 +132,7 @@ The response for a ExpandService.Expand RPC.

The service to query relation tuples.

This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).

| Method Name | Request Type | Response Type | Description |
| ------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------- |
Expand Down Expand Up @@ -190,8 +190,8 @@ The response of a ReadService.ListRelationTuples RPC.

The service returning the specific Ory Keto instance version.

This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis)
and [write APIs](../concepts/api-overview.mdx#write-apis).
This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis)
and [write-APIs](../concepts/api-overview.mdx#write-apis).

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------- |
Expand All @@ -216,7 +216,7 @@ Response of the VersionService.GetVersion RPC.
The write service to create and delete Access Control Lists.

This service is part of the
[write APIs](../concepts/api-overview.mdx#write-apis).
[write-APIs](../concepts/api-overview.mdx#write-apis).

| Method Name | Request Type | Response Type | Description |
| ---------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
Expand Down
3 changes: 3 additions & 0 deletions proto/ory/keto/acl/v1alpha1/acl_pb.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
/**
* @fileoverview
* @enhanceable
* @suppress {missingRequire} reports error on implicit type usages.
* @suppress {messageConventions} JS Compiler reports an error if a variable or
* field starts with 'MSG_' and isn't a translatable message.
* @public
*/
// GENERATED CODE -- DO NOT EDIT!
/* eslint-disable */
// @ts-nocheck

var jspb = require('google-protobuf');
var goog = jspb;
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/acl/v1alpha1/check_service.pb.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions proto/ory/keto/acl/v1alpha1/check_service.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ option php_namespace = "Ory\\Keto\\Acl\\V1alpha1";
// The service that performs authorization checks
// based on the stored Access Control Lists.
//
// This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).
service CheckService {
// Performs an authorization check.
rpc Check(CheckRequest) returns (CheckResponse);
Expand All @@ -25,7 +25,7 @@ service CheckService {
message CheckRequest {
// The namespace to evaluate the check.
//
// Note: If you use the expand API and the check
// Note: If you use the expand-API and the check
// evaluates a RelationTuple specifying a SubjectSet as
// subject or due to a rewrite rule in a namespace config
// this check request may involve other namespaces automatically.
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/acl/v1alpha1/check_service_grpc_pb.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function deserialize_ory_keto_acl_v1alpha1_CheckResponse(buffer_arg) {
// The service that performs authorization checks
// based on the stored Access Control Lists.
//
// This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).
var CheckServiceService = exports.CheckServiceService = {
// Performs an authorization check.
check: {
Expand Down
3 changes: 3 additions & 0 deletions proto/ory/keto/acl/v1alpha1/check_service_pb.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
/**
* @fileoverview
* @enhanceable
* @suppress {missingRequire} reports error on implicit type usages.
* @suppress {messageConventions} JS Compiler reports an error if a variable or
* field starts with 'MSG_' and isn't a translatable message.
* @public
*/
// GENERATED CODE -- DO NOT EDIT!
/* eslint-disable */
// @ts-nocheck

var jspb = require('google-protobuf');
var goog = jspb;
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/acl/v1alpha1/expand_service.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ option php_namespace = "Ory\\Keto\\Acl\\V1alpha1";
// The service that performs subject set expansion
// based on the stored Access Control Lists.
//
// This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).
service ExpandService {
// Expands the subject set into a tree of subjects.
rpc Expand(ExpandRequest) returns (ExpandResponse);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/acl/v1alpha1/expand_service_grpc_pb.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function deserialize_ory_keto_acl_v1alpha1_ExpandResponse(buffer_arg) {
// The service that performs subject set expansion
// based on the stored Access Control Lists.
//
// This service is part of the [read APIs](../concepts/api-overview.mdx#read-apis).
// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis).
var ExpandServiceService = exports.ExpandServiceService = {
// Expands the subject set into a tree of subjects.
expand: {
Expand Down
3 changes: 3 additions & 0 deletions proto/ory/keto/acl/v1alpha1/expand_service_pb.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
/**
* @fileoverview
* @enhanceable
* @suppress {missingRequire} reports error on implicit type usages.
* @suppress {messageConventions} JS Compiler reports an error if a variable or
* field starts with 'MSG_' and isn't a translatable message.
* @public
*/
// GENERATED CODE -- DO NOT EDIT!
/* eslint-disable */
// @ts-nocheck

var jspb = require('google-protobuf');
var goog = jspb;
Expand Down

0 comments on commit a7a64e3

Please sign in to comment.