docs: design updates for Generated API Docs #308
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**Commit Message**: This removes the test coverage exception of apischema package by adding more unit tests. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message**: This upgrades the Envoy Gateway version used in the end to end tests. Also, this changes the Envoy container tag to use "-latest" without specifying the patch version. --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: ericmariasis <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: Eric Mariasis <[email protected]>
…proxy#264) **Commit Message**: Removal of deprecated kubectl command below from [the installation getting started guide](https://github.com/envoyproxy/ai-gateway/blob/main/site/docs/getting-started/installation.md). `kubectl wait --timeout=2m -n envoy-ai-gateway-system deployment/ai-gateway-controller --for=create ` It seems to include a deprecated arg ```--for=create``` **Related Issues/PRs (if applicable)**: Fixes [Issue 262](envoyproxy#262) **Special notes for reviewers (if applicable)**: Signed-off-by: ericmariasis <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This makes the PR style check stricter than before: * The description's first line must be `**Commit Message**` * The PR title length must be less than 53 characters --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This refactors the PR style check github workflow. * Renamed the file to match the workflow name. * Split the description checks into multiple runs. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This follows up on envoyproxy#266 and relaxes the PR title length restriction to 60 characters. It was too strict. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** Added note for Windows users in basic usage that they can use WSL for commands not working on cmd prompt. **Related Issues/PRs (if applicable)** Fixes envoyproxy#263 --------- Signed-off-by: ericmariasis <[email protected]> Co-authored-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** Apparently, the message was clear enough Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: Eric Mariasis <[email protected]>
….32.3 to 1.32.4 (envoyproxy#281) Signed-off-by: Eric Mariasis <[email protected]>
…0.1.0-alpha.51 (envoyproxy#280) Signed-off-by: Eric Mariasis <[email protected]>
…nvoyproxy#277) Signed-off-by: Eric Mariasis <[email protected]>
…oyproxy#279) Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** Addressed warnings observed during `make test-extproc`, except for the `reuse_port` warning, which is platform-dependent and cannot be fixed on non-Linux systems. - Updated `json_format` to be nested under `log_format` to align with Envoy's expected configuration. - Added `overload_manager` configuration to manage downstream connection limits. - The warning related to `reuse_port` being force disabled on non-Linux platforms was **not** fixed, as it is platform-dependent. Signed-off-by: Sébastien Han <[email protected]> **Related Issues/PRs (if applicable)** envoyproxy#274 **Special notes for reviewers (if applicable)** The warning related to `reuse_port` being force disabled on non-Linux platforms was **not** fixed, as it is platform-dependent. Any suggestions for a fix are welcome. Signed-off-by: Sébastien Han <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
…1.29.4 (envoyproxy#278) Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This introduces a new GitHub Actions workflow to check the length of issue titles and provide feedback if they exceed a specified limit. **Related Issues/PRs (if applicable)** Fixes envoyproxy#270 --------- Signed-off-by: soma00333 <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This adjusts the issue title check as well as the PR style check. For issue title, I adopt the suggestion by @leseb as indeed 60 was too strict. For the PR stuff, it simply changes it to forbid >60. --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This puts stricter permissions on Tests and Style GitHub Actions workflows. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** Mark all volume mounts readonly to ensure security. **Related Issues/PRs (if applicable)** Fix envoyproxy#250 --------- Signed-off-by: Loong <[email protected]> Co-authored-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This add a CEL expression token usage example that is missing from the example as well as the e2e test. **Related Issues/PRs (if applicable)** closes envoyproxy#257 Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This cleans up some logic for old Envoy versions in log parsing. Also, this adds additional test log for debugging a flaky streaming test with openai. **Related Issues/PRs (if applicable)** Related to envoyproxy#290 --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** The weight field does not need to be specified if there's only one backend since envoyproxy#156. This removes it in token_ratelimit.yaml. **Related Issues/PRs (if applicable)** Follow up on envoyproxy#289 Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This refactors the controller package to eliminate all the context.Background usages in the main code path. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This refactors the extproc package and eliminates all context.Background usages. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This eliminates context.Background in config loading code path. **Related Issues/PRs (if applicable)** This is a follow up on envoyproxy#296 Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This makes the lint settings stricter and starts enforcing more rules. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This adds additional doc comments on AIGatewayRoute resource about which k8s resources will be created by Envoy AI Gateway. **Related Issues/PRs (if applicable)** Closes envoyproxy#258 --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This adds a site page for the architecture overview of the project. **Related Issues/PRs (if applicable)** Closes envoyproxy#240 Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** Allow setting AWS session token in the AWS credential file when using AWS temporary credentials to test AWS Bedrock. **Related Issues/PRs (if applicable)** **Special notes for reviewers (if applicable)** TEST_AWS_SESSION_TOKEN is optional if using static AWS credential. Signed-off-by: Dan Sun <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This renames `make test-cel` to `make test-crdcel` to be precise about what it is testing since we are also using CEL for LLM costs. Also, this renames the tests/cel-validation directory to tests/crdcel since it was previously incorrect and didn't match the make target. --------- Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
**Commit Message** This updates several tool dependencies. Signed-off-by: Takeshi Yoneda <[email protected]> Signed-off-by: Eric Mariasis <[email protected]>
Signed-off-by: Erica Hughberg <[email protected]>
Signed-off-by: Erica Hughberg <[email protected]>
…rg/ai-gateway into api-docs-erica-suggestion
missBerg
changed the title
Signed-off-by: Erica Hughberg <[email protected]>
Signed-off-by: Erica Hughberg <[email protected]>
mathetake
approved these changes
Feb 9, 2025
daixiang0
pushed a commit
to daixiang0/ai-gateway
that referenced
this pull request
Feb 19, 2025
Signed-off-by: Loong <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit Message
Styled and formatted API Docs for readability and navigation.
Key changes are:
Related Issues/PRs (if applicable)
#276 - replaces this PR
Fixes #241
Related PR: #276 - replaces this PR