Skip to content

Commit

Permalink
docs: add link endings. (#2313)
Browse files Browse the repository at this point in the history
Closes #38
  • Loading branch information
vinckr authored Jan 21, 2021
1 parent 3027833 commit 1316cc0
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 39 deletions.
11 changes: 6 additions & 5 deletions docs/docs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,12 @@ accepting the latter login request in your login provider will make hydra reply:

The suggested flow is:

Check the response from [GET login request](reference/api#get-a-login-request),
if both the `subject` and `login_hint` are NOT empty and also NOT the same user,
redirect UserAgent to `request_url` which is appended with '?prompt=login'. This
will make hydra ignore the existing authentication, and allow your login
provider to login a different subject.
Check the response from
[GET login request](reference/api.mdx#get-a-login-request), if both the
`subject` and `login_hint` are NOT empty and also NOT the same user, redirect
UserAgent to `request_url` which is appended with '?prompt=login'. This will
make hydra ignore the existing authentication, and allow your login provider to
login a different subject.

For more information on `prompt=login` and other options, please check
[Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).
18 changes: 9 additions & 9 deletions docs/docs/concepts/consent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ includes both login and consent.

:::info

Please read [Login Flow](./login) first, as the Login Flow happens before the
consent flow.
Please read [Login Flow](./login.mdx) first, as the Login Flow happens before
the consent flow.

:::

Expand Down Expand Up @@ -94,7 +94,7 @@ A consent has four distinctive attributes:
- The requested scope
(`/oauth2/auth?...&...&scope=email+profile+offline_access`);
- The OAuth2 Client (`/oauth2/auth?client_id=abcd`);
- The End-User (this is the `subject` set in the [Login Flow](./login));
- The End-User (this is the `subject` set in the [Login Flow](./login.mdx));
- Whether or not a previous consent exists, the previous consent has
`remember: true`, and the scope granted by the user (did the user accept all
of `email`, `profile`, `offline_access`?)
Expand Down Expand Up @@ -140,7 +140,7 @@ information about the consent request. The body contains a `skip` value. If the
value is `false`, the user interface must be shown. If `skip` is true, you
should not show the user interface but instead just accept or reject the consent
request! For more details about the implementation check the
["Implementing the Consent Endpoint" Guide](../guides/login).
["Implementing the Consent Endpoint" Guide](../guides/login.mdx).
<Tabs
defaultValue="ui"
Expand All @@ -161,7 +161,7 @@ $ curl \
"http://127.0.0.1:4445/oauth2/auth/requests/consent?consent_challenge=7bb518c4eec2454dbb289f5fdb4c0ee2"
```

Check the ["Implementing the Consent Endpoint" Guide](../guides/consent) for
Check the ["Implementing the Consent Endpoint" Guide](../guides/consent.mdx) for
examples using the ORY Hydra SDK in different languages.

</TabItem>
Expand Down Expand Up @@ -228,7 +228,7 @@ most cases, you will show an HTML form similar to:

To accept the Consent Challenge, make an HTTP PUT request with
`Content-Type: application/json` and a JSON payload (see
[Accept Consent Request HTTP API Reference](../reference/api#schemaacceptconsentrequest))
[Accept Consent Request HTTP API Reference](../reference/api.mdx#schemaacceptconsentrequest))

```json
{
Expand Down Expand Up @@ -280,14 +280,14 @@ The server responds with JSON

which is the URL your application must the End-User's browser to.

Check the ["Implementing the Consent Endpoint" Guide](../guides/consent) for
Check the ["Implementing the Consent Endpoint" Guide](../guides/consent.mdx) for
examples using the ORY Hydra SDK in different languages.

### Rejecting the Consent Flow

To reject the Login Challenge, make a HTTP PUT request with
`Content-Type: application/json` and a JSON payload (see
[Reject Consent Request HTTP API Reference](../reference/api#schemarejectrequest))
[Reject Consent Request HTTP API Reference](../reference/api.mdx#schemarejectrequest))

```json
{
Expand Down Expand Up @@ -335,7 +335,7 @@ The server responds with JSON

which is the URL your application must the End-User's browser to.

Check the ["Implementing the Login Endpoint" Guide](../guides/login) for
Check the ["Implementing the Login Endpoint" Guide](../guides/login.mdx) for
examples using the ORY Hydra SDK in different languages.

## Revoking Consent
Expand Down
20 changes: 10 additions & 10 deletions docs/docs/concepts/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ that URL.

:::note

This guide uses URLs from the [5 Minute Tutorial](../5min-tutorial):
This guide uses URLs from the [5 Minute Tutorial](../5min-tutorial.mdx):

- ORY Hydra Public Endpoint: http://127.0.0.1:4444
- ORY Hydra Admin Endpoint: http://127.0.0.1:4445
Expand Down Expand Up @@ -154,7 +154,7 @@ ORY Hydra supports the following OpenID Connect query parameters:
Login HTML Form in the Login Endpoint.
- `prompt=consent` instructs ORY Hydra to force the End-User to re-authorize
(give consent) the OAuth2 Client using the
[Consent HTML Form in the Consent Endpoint](./consent).
[Consent HTML Form in the Consent Endpoint](./consent.mdx).
- `prompt=select_account` is currently not supported in ORY Hydra, see [#].
- `max_age` (optional) specifies the allowable elapsed time in seconds since the
last time the End-User was actively authenticated by ORY Hydra. If the elapsed
Expand Down Expand Up @@ -191,7 +191,7 @@ about the login request. The body contains a `skip` value. If the value is
`false`, the user interface must be shown. If `skip` is true, you should not
show the user interface but instead just accept or reject the login request! For
more details about the implementation check the
["Implementing the Login Endpoint" Guide](../guides/login).
["Implementing the Login Endpoint" Guide](../guides/login.mdx).
<Tabs
defaultValue="ui"
Expand All @@ -211,7 +211,7 @@ more details about the implementation check the
curl "http://127.0.0.1:4445/oauth2/auth/requests/login?login_challenge=7bb518c4eec2454dbb289f5fdb4c0ee2"
```
Check the ["Implementing the Login Endpoint" Guide](../guides/login) for
Check the ["Implementing the Login Endpoint" Guide](../guides/login.mdx) for
examples using the ORY Hydra SDK in different languages.
</TabItem>
Expand Down Expand Up @@ -281,7 +281,7 @@ flows) the login challenge.

To accept the Login Challenge, make a HTTP PUT request with
`Content-Type: application/json` and a JSON payload (see
[Accept Login Request HTTP API Reference](../reference/api#schemaacceptloginrequest))
[Accept Login Request HTTP API Reference](../reference/api.mdx#schemaacceptloginrequest))

:::warning

Expand Down Expand Up @@ -351,14 +351,14 @@ The server responds with JSON

which is the URL your application must redirect the End-User's browser to.

Check the ["Implementing the Login Endpoint" Guide](../guides/login) for
Check the ["Implementing the Login Endpoint" Guide](../guides/login.mdx) for
examples using the ORY Hydra SDK in different languages.

### Rejecting the Login Flow

To reject the Login Challenge, make a HTTP PUT request with
`Content-Type: application/json` and a JSON payload (see
[Reject Login Request HTTP API Reference](../reference/api#schemarejectrequest))
[Reject Login Request HTTP API Reference](../reference/api.mdx#schemarejectrequest))

```json
{
Expand Down Expand Up @@ -406,12 +406,12 @@ The server responds with JSON

which is the URL your application must the End-User's browser to.

Check the ["Implementing the Login Endpoint" Guide](../guides/login) for
Check the ["Implementing the Login Endpoint" Guide](../guides/login.mdx) for
examples using the ORY Hydra SDK in different languages.

## Redirection to the Consent Endpoint

Please head over to [Consent Flow](./consent)!
Please head over to [Consent Flow](./consent.mdx)!

## Revoking ORY Hydra Login Sessions

Expand All @@ -429,7 +429,7 @@ If you log out of GitHub, you will not be logged out of CircleCI/TravisCI.

Revoking the login sessions of a user is as easy as sending `DELETE` to
`/oauth2/auth/sessions/login?subject={subject}` (see
[full API documentation](../reference/api#opIdrevokeAuthenticationSession)).
[full API documentation](../reference/api.mdx#opIdrevokeAuthenticationSession)).

This endpoint is not compatible with OpenID Connect Front-/Backchannel logout
and does not revoke any tokens.
2 changes: 1 addition & 1 deletion docs/docs/concepts/openid-connect-oidc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: OpenID Connect
---

Before you start reading this document, please make sure to have covered all
topics in [OAuth 2.0 Concepts](./oauth2).
topics in [OAuth 2.0 Concepts](./oauth2.mdx).

OpenID Connect works exactly like OAuth2. The primary use case for OpenID
Connect is to solve "Login with <Google|Facebook|Hydra>" flows.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/configure-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ endpoint in your login or consent provider.
:::note

We only used environmental variables to configure ORY Hydra in this example. If
you use a [configuration file](reference/configuration) instead, remember to
you use a [configuration file](reference/configuration.md) instead, remember to
mount it in the container. For example:

```shell
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Or by specifying the following flags:

## Is there an HTTP API Documentation?

[Yes](https://www.ory.sh/docs/api/hydra).
[Yes](https://www.ory.sh/docs/hydra/reference/api.mdx). bro

## How can I disable HTTPS for testing?

Expand Down Expand Up @@ -251,7 +251,7 @@ the same config. Please check the documentation section for 12 factor principles
for more information: https://www.ory.sh/docs/ecosystem/cloud-native. There is
also some information on collecting statistics in the section on
[prometheus](https://github.com/prometheus) in the
[five minute tutorial](./5min-tutorial).
[five minute tutorial](./5min-tutorial.mdx).

## Is it possible to disable/enable certain flows in Hydra?

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ gitlab_rails['omniauth_allow_single_sign_on'] = ['ORY_Hydra']
```

In order to get the necessary data for the user, gitlab needs to call to hydra's
[userinfo-endpoint](../reference/api#openid-connect-userinfo). The most
[userinfo-endpoint](../reference/api.mdx#openid-connect-userinfo). The most
important attribute is the sub-attribute which provides, according to the
[specification](https://openid.net/specs/openid-connect-core-1_0.html#IDToken),
the ID of a user which is (in this case) the email-address. However, the
Expand Down
7 changes: 3 additions & 4 deletions docs/docs/guides/kubernetes-helm-chart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The source code is available on
## Installation

To install ORY Hydra, the following
[configuration values](https://www.ory.sh/hydra/docs/reference/configuration)
[configuration values](https://www.ory.sh/hydra/docs/reference/configuration.md)
must be set:

- `hydra.config.dsn`
Expand Down Expand Up @@ -105,7 +105,7 @@ $ helm install \
## Configuration

You can pass your
[ORY Hydra configuration file](https://www.ory.sh/hydra/docs/reference/configuration)
[ORY Hydra configuration file](https://www.ory.sh/hydra/docs/reference/configuration.md)
by creating a yaml file with key `hydra.config`

```yaml
Expand Down Expand Up @@ -231,8 +231,7 @@ $ curl http://example-idp.localhost/
http://public.hydra.localhost/.well-known/openid-configuration
```

Next, you can follow the
[5 Minute Tutorial](https://www.ory.sh/docs/hydra/5min-tutorial), skipping the
Next, you can follow the [5 Minute Tutorial](../5min-tutorial.mdx), skipping the
`git` and `docker-compose` set up sections. Assuming you have ORY Hydra
installed locally, you can rewrite commands from, for example,

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/oauth2-clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Creating OAuth 2.0 Clients
You can manage _OAuth 2.0 clients_ using the cli or the HTTP REST API:

- **CLI:** `hydra help clients`
- **REST:** Read the [API Docs](../reference/api)
- **REST:** Read the [API Docs](../reference/api.mdx)

## Authorize Code Flow with Refresh Token

Expand Down
10 changes: 5 additions & 5 deletions docs/docs/jwks.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,16 @@ GEs=
```

ORY Hydra offers an API for generating and managing JWKs, the
[JSON Web Keys API](./reference/api). When using persistent storage backends,
the keys are encrypted at rest using AES256-GCM and _the system secret_. The
system secret is generated by default and overridden by the environment variable
`SYSTEM_SECRET`.
[JSON Web Keys API](./reference/api.mdx). When using persistent storage
backends, the keys are encrypted at rest using AES256-GCM and _the system
secret_. The system secret is generated by default and overridden by the
environment variable `SYSTEM_SECRET`.

JWKs are well supported amongst all languages. This endpoint helps you managing
certificates, private, public and symmetric keys. It is important to never
transport keys over insecure channels such as http.

The [REST API Documentation](./reference/api) will give you details on the
The [REST API Documentation](./reference/api.mdx) will give you details on the
various endpoints.

## Auto-generated JWKs
Expand Down

0 comments on commit 1316cc0

Please sign in to comment.