-
Notifications
You must be signed in to change notification settings - Fork 18
Documentation for the new Proxy improvements #623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Deploying configcat-docs with
|
| Latest commit: |
2122d85
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c1461fee.docs-xmy.pages.dev |
| Branch Preview URL: | https://proxy-docs-update.docs-xmy.pages.dev |
Deploying configcat-docs with
|
| Latest commit: |
d956728
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://632afd1b.docs-xmy.pages.dev |
| Branch Preview URL: | https://proxy-docs-update.docs-xmy.pages.dev |
|
🤖 Hi @z4kn4fein, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
|
@gemini-cli /review |
|
🤖 Hi @adams85, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📋 Review Summary
This pull request provides comprehensive and well-structured documentation for the new Proxy improvements. The changes are clear, detailed, and easy to follow.
🔍 General Feedback
- The documentation for the new API, OFREP, and SSE endpoints is excellent, with clear distinctions between SDK key and SDK identifier usage.
- The expanded section on Proxy Profiles, including selection rules, is a great addition and will be very helpful for users.
- The updates to the monitoring and gRPC documentation are also very clear and informative.
I found one minor copy-paste error in an example, which I've commented on. Overall, this is an excellent documentation update.
|
|
||
| The following endpoints are using an [SDK identifier](overview.mdx#sdk-identifier--sdk-key) to determine which config / environment is the target of the desired action. | ||
| The SDK identifier must be provided as a route parameter of the HTTP request. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟢 It seems like there's a copy-paste error in the example response for this endpoint. The same feature flag key is listed twice.
| "feature-flag-key-2" |
Describe the purpose of your pull request
Requirement checklist