Skip to content

Commit

Permalink
broken docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonmadigan committed Jul 5, 2024
1 parent 4e9741b commit db1726a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions doc/generate-kuadrant-auth-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Generate Kuadrant AuthPolicy object from OpenAPI 3

The `kuadrantctl generate kuadrant authpolicy` command generates an [Kuadrant AuthPolicy](https://docs.kuadrant.io/kuadrant-operator/doc/auth/)
The `kuadrantctl generate kuadrant authpolicy` command generates an [Kuadrant AuthPolicy](https://docs.kuadrant.io/latest/kuadrant-operator/doc/auth/)
from your [OpenAPI Specification (OAS) 3.x](https://spec.openapis.org/oas/latest.html) powered with [kuadrant extensions](openapi-kuadrant-extensions.md).

### OpenAPI specification
Expand Down Expand Up @@ -160,7 +160,7 @@ type: Opaque
```
> **Note**: Kuadrant validates tokens against api keys found in secrets. The label selector format `kuadrant.io/apikeys-by: ${sec scheme name}` is arbitrary and designed for this CLI command.

For more information about Kuadrant auth based on api key: https://docs.kuadrant.io/authorino/docs/user-guides/api-key-authentication/
For more information about Kuadrant auth based on api key: https://docs.kuadrant.io/latest/authorino/docs/user-guides/api-key-authentication/

### Usage

Expand Down Expand Up @@ -213,7 +213,7 @@ cd kuadrantctl

* Setup a cluster, Istio and Gateway API CRDs and Kuadrant

Use our single-cluster quick start script - this will install Kuadrant in a local `kind` cluster: https://docs.kuadrant.io/getting-started-single-cluster/
Use our single-cluster quick start script - this will install Kuadrant in a local `kind` cluster: https://docs.kuadrant.io/latest/getting-started-single-cluster/

* Build and install CLI in `bin/kuadrantctl` path

Expand Down
4 changes: 2 additions & 2 deletions doc/generate-kuadrant-rate-limit-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Generate Kuadrant RateLimitPolicy object from OpenAPI 3

The `kuadrantctl generate kuadrant ratelimitpolicy` command generates a [Kuadrant RateLimitPolicy](https://docs.kuadrant.io/kuadrant-operator/doc/rate-limiting/)
The `kuadrantctl generate kuadrant ratelimitpolicy` command generates a [Kuadrant RateLimitPolicy](https://docs.kuadrant.io/latest/kuadrant-operator/doc/rate-limiting/)
from your [OpenAPI Specification (OAS) 3.x document](https://spec.openapis.org/oas/latest.html) powered with [Kuadrant extensions](openapi-kuadrant-extensions.md).

### OpenAPI specification
Expand Down Expand Up @@ -39,7 +39,7 @@ cd kuadrantctl
```
2. Set up a cluster, Istio and Gateway API CRDs, and Kuadrant as follows:

* Use the single-cluster quick start script to install Kuadrant in a local `kind` cluster: https://docs.kuadrant.io/getting-started-single-cluster/.
* Use the single-cluster quick start script to install Kuadrant in a local `kind` cluster: https://docs.kuadrant.io/latest/getting-started-single-cluster/.

3. Build and install the CLI in `bin/kuadrantctl` path as follows:
```bash
Expand Down
4 changes: 2 additions & 2 deletions doc/openapi-apicurio.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ For more details, see [Generate Gateway API HTTPRoute object from OpenAPI 3](./g
#### Generate an AuthPolicy
To generate an [AuthPolicy](https://docs.kuadrant.io/kuadrant-operator/doc/auth/), add a `securityScheme` to the `components` block in your API definition. The following `securityScheme` requires that an API key header is set:
To generate an [AuthPolicy](https://docs.kuadrant.io/latest/kuadrant-operator/doc/auth/), add a `securityScheme` to the `components` block in your API definition. The following `securityScheme` requires that an API key header is set:

```yaml
securitySchemes:
Expand All @@ -59,7 +59,7 @@ For more details, see [Generate Kuadrant AuthPolicy object from OpenAPI 3](./gen

#### Generate a RateLimitPolicy

To generate a [RateLimitPolicy](https://docs.kuadrant.io/kuadrant-operator/doc/rate-limiting/) for the API, add the following `x-kuadrant` block to a path in your API definition, replacing values to match your API details.
To generate a [RateLimitPolicy](https://docs.kuadrant.io/latest/kuadrant-operator/doc/rate-limiting/) for the API, add the following `x-kuadrant` block to a path in your API definition, replacing values to match your API details.

```yaml
paths:
Expand Down

0 comments on commit db1726a

Please sign in to comment.