Skip to content

Commit

Permalink
Merge pull request #60 from david-martin/kaudrantctl-guides
Browse files Browse the repository at this point in the history
Some tidyup of links and usage guide wording for docs site
  • Loading branch information
jasonmadigan authored Mar 8, 2024
2 parents 5ec96a0 + 8e04933 commit b710c93
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
14 changes: 10 additions & 4 deletions doc/generate-gateway-api-httproute.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
## Generate Gateway API HTTPRoute object from OpenAPI 3

The `kuadrantctl generate gatewayapi httproute` command generates an [Gateway API HTTPRoute](https://gateway-api.sigs.k8s.io/v1alpha2/guides/http-routing/)
from your [OpenAPI Specification (OAS) 3.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md) powered with [kuadrant extensions](openapi-kuadrant-extensions.md).
The `kuadrantctl generate gatewayapi httproute` command generates an [Gateway API HTTPRoute](https://gateway-api.sigs.k8s.io/api-types/httproute/)
from your [OpenAPI Specification (OAS) 3.x](https://spec.openapis.org/oas/latest.html) powered with [kuadrant extensions](openapi-kuadrant-extensions.md).

### OpenAPI specification

[OpenAPI `v3.0`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md)
An OpenAPI document resource can be provided to the cli by one of the following channels:

OpenAPI document resource can be provided by one of the following channels:
* Filename in the available path.
* URL format (supported schemes are HTTP and HTTPS). The CLI will try to download from the given address.
* Read from stdin standard input stream.
Expand All @@ -30,3 +29,10 @@ Global Flags:
```

> Under the example folder there are examples of OAS 3 that can be used to generate the resources
As an AuthPolicy and RateLimitPolicy both require a HTTPRoute to target, the user guides for generating those policies include examples of running the `kuadrantctl generate gatewayapi httproute` command.

You can find those guides here:

* [Generate Kuadrant AuthPolicy](./generate-kuadrant-auth-policy.md)
* [Generate Kuadrant RateLimitPolicy](./generate-kuadrant-rate-limit-policy.md)
11 changes: 5 additions & 6 deletions doc/generate-kuadrant-auth-policy.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
## Generate Kuadrant AuthPolicy object from OpenAPI 3

The `kuadrantctl generate kuadrant authpolicy` command generates an [Kuadrant AuthPolicy](https://github.com/Kuadrant/kuadrant-operator/blob/v0.4.1/doc/auth.md)
from your [OpenAPI Specification (OAS) 3.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md) powered with [kuadrant extensions](openapi-kuadrant-extensions.md).
The `kuadrantctl generate kuadrant authpolicy` command generates an [Kuadrant AuthPolicy](https://docs.kuadrant.io/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

[OpenAPI `v3.0`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md)
An OpenAPI document resource can be provided to the cli by one of the following channels:

OpenAPI document resource can be provided by one of the following channels:
* Filename in the available path.
* URL format (supported schemes are HTTP and HTTPS). The CLI will try to download from the given address.
* Read from stdin standard input stream.

OpenAPI [Security Scheme Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object) types
OpenAPI [Security Scheme Object](https://spec.openapis.org/oas/latest.html#security-scheme-object) types

| Types | Implemented |
| --- | --- |
Expand Down Expand Up @@ -415,7 +414,7 @@ curl -H "Host: example.com" -H "api_key: I_LIKE_SNAKES" -X POST -i "http://127.
```

```
TTP/1.1 401 Unauthorized
HTTP/1.1 401 Unauthorized
www-authenticate: Bearer realm="getDog_oidc"
www-authenticate: Bearer realm="getSnake_oidc"
www-authenticate: snake_token realm="getSnake_snakes_api_key"
Expand Down
7 changes: 3 additions & 4 deletions doc/generate-kuadrant-rate-limit-policy.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
## Generate Kuadrant RateLimitPolicy object from OpenAPI 3

The `kuadrantctl generate kuadrant ratelimitpolicy` command generates an [Kuadrant RateLimitPolicy](https://github.com/Kuadrant/kuadrant-operator/blob/v0.4.1/doc/rate-limiting.md)
from your [OpenAPI Specification (OAS) 3.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md) powered with [kuadrant extensions](openapi-kuadrant-extensions.md).
The `kuadrantctl generate kuadrant ratelimitpolicy` command generates an [Kuadrant RateLimitPolicy](https://docs.kuadrant.io/kuadrant-operator/doc/rate-limiting/)
from your [OpenAPI Specification (OAS) 3.x](https://spec.openapis.org/oas/latest.html) powered with [kuadrant extensions](openapi-kuadrant-extensions.md).

### OpenAPI specification

[OpenAPI `v3.0`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md)
An OpenAPI document resource can be provided to the cli by one of the following channels:

OpenAPI document resource can be provided by one of the following channels:
* Filename in the available path.
* URL format (supported schemes are HTTP and HTTPS). The CLI will try to download from the given address.
* Read from stdin standard input stream.
Expand Down

0 comments on commit b710c93

Please sign in to comment.