Skip to content

Commit

Permalink
docs: rename index documents
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Dec 17, 2020
1 parent 53bb137 commit 7de0ac3
Show file tree
Hide file tree
Showing 11 changed files with 18,520 additions and 54 deletions.
16 changes: 8 additions & 8 deletions docs/docs/pipeline/index.md → docs/docs/pipeline.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
---
id: index
id: pipeline
title: Access Rule Pipeline
---

Read more about the
[principal components and execution pipeline of access rules](../api-access-rules.md)
[principal components and execution pipeline of access rules](api-access-rules.md)
if you have not already. This chapter explains the different pipeline handlers
available to you:

- [Authentication handlers](authn.md) inspect HTTP requests (e.g. the HTTP
- [Authentication handlers](pipeline/authn.md) inspect HTTP requests (e.g. the HTTP
Authorization Header) and execute some business logic that return true (for
authentication ok) or false (for authentication invalid) as well as a subject
("user"). The subject is typically the "user" that made the request, but it
could also be a machine (if you have machine-2-machine interaction) or
something different.
- [Authorization handlers](authz.md): ensure that a subject ("user") has the
- [Authorization handlers](pipeline/authz.md): ensure that a subject ("user") has the
right permissions. For example, a specific endpoint might only be accessible
to subjects ("users") from group "admin". The authorizer handles that logic.
- [Mutation handlers](mutator.md): transforms the credentials from incoming
- [Mutation handlers](pipeline/mutator.md): transforms the credentials from incoming
requests to credentials that your backend understands. For example, the
`Authorization: basic` header might be transformed to `X-User: <subject-id>`.
This allows you to write backends that do not care if the original request was
an anonymous one, an OAuth 2.0 Access Token, or some other credential type.
All your backend has to do is understand, for example, the `X-User:`.
- [Error handlers](error.md): are responsible for executing logic after, for
- [Error handlers](pipeline/error.md): are responsible for executing logic after, for
example, authentication or authorization failed. ORY Oathkeeper supports
different error handlers and we will add more as the project progresses.

## Templating

Some handlers such as the [ID Token Mutator](mutator.md#id_token) support
Some handlers such as the [ID Token Mutator](pipeline/mutator.md#id_token) support
templating using [Golang Text Templates](https://golang.org/pkg/text/template/)
([examples](https://blog.gopheracademy.com/advent-2017/using-go-templates/)).
The [sprig](http://masterminds.github.io/sprig/) is also supported, on top of
Expand Down Expand Up @@ -97,7 +97,7 @@ claim)
{ "config_field": "{{ print .Extra.some.arbitrary.data }}" }
```

To use a Regex capture from the request URL
To use a Regex capture from the request URL
Note the usage of `printIndex` to print a value from the array

```json
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/pipeline/authz.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ If `subject` is not specified it will default to
`AuthenticationSession.Subject`.

For more details about supported Go template substitution, see.
[How to use session variables](index.md#session)
[How to use session variables](../pipeline.md#session)

#### Example

Expand Down Expand Up @@ -291,7 +291,7 @@ if it returns a "403 Forbidden" response code, the access is denied.
[`text/template`](https://golang.org/pkg/text/template/) package and applied
to an
[`AuthenticationSession`](https://github.com/ory/oathkeeper/blob/master/pipeline/authn/authenticator.go#L40)
object. See [Session](index.md#session) for more details.
object. See [Session](../pipeline.md#session) for more details.

#### Example

Expand Down Expand Up @@ -372,7 +372,7 @@ Forbidden" response code, the access is denied.
[`text/template`](https://golang.org/pkg/text/template/) package and applied
to an
[`AuthenticationSession`](https://github.com/ory/oathkeeper/blob/master/pipeline/authn/authenticator.go#L40)
object. See [Session](index.md#session) for more details.
object. See [Session](../pipeline.md#session) for more details.

#### Example

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/pipeline/mutator.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ represent names of claims and the values are arbitrary data structures which
will be parsed by the Go [text/template](https://golang.org/pkg/text/template/)
package for value substitution, receiving the `AuthenticationSession` struct.

For more details please check [Session variables](index.md#session)
For more details please check [Session variables](../pipeline.md#session)

The claims configuration expects a string which is expected to be valid JSON:

Expand Down Expand Up @@ -322,7 +322,7 @@ field. The keys are the header name and the values are a string which will be
parsed by the Go [`text/template`](https://golang.org/pkg/text/template/)
package for value substitution, receiving the `AuthenticationSession` struct.

For more details please check [Session variables](index.md#session)
For more details please check [Session variables](../pipeline.md#session)

### Access Rule Example

Expand Down Expand Up @@ -401,7 +401,7 @@ field. The keys are the cookie name and the values are a string which will be
parsed by the Go [`text/template`](https://golang.org/pkg/text/template/)
package for value substitution, receiving the `AuthenticationSession` struct.

For more details please check [Session variables](index.md#session)
For more details please check [Session variables](../pipeline.md#session)

##### Example

Expand Down
7 changes: 4 additions & 3 deletions docs/docs/sdk/index.md → docs/docs/sdk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: index
title: Overview
id: sdk
title: ORY Oathkeeper SDKs
sidebar_label: Overview
---

All SDKs use automated code generation provided by
Expand All @@ -10,7 +11,7 @@ code when upgrading versions. Therefore, we do not make backwards compatibility
promises with regards to the generated SDKs. We hope to improve this process in
the future.

Before you check out the SDKs, head over to the [REST API](../reference/api)
Before you check out the SDKs, head over to the [REST API](reference/api.mdx)
documentation which includes code samples for common programming languages for
each REST endpoint.

Expand Down
Loading

0 comments on commit 7de0ac3

Please sign in to comment.