You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The file needs removing and a redirect added for path /advanced-configuration/compose-apis to content file tyk-docs/content/advanced-configuration/compose-apis/virtual-endpoints.md
Screenshots (if appropriate)
Checklist
I have added a preview link to the PR description.
2, because the PR involves file deletion, content modification, and redirection which are straightforward but require careful verification to ensure that all references are correctly updated and that the redirection works as intended.
🧪 Relevant tests
No
🔍 Possible issues
Broken Link: The deletion of compose-apis.md and the update in references might lead to broken links if not all instances where the old path is used are updated.
🔒 Security concerns
No
Code feedback:
relevant file
tyk-docs/content/advanced-configuration.md
suggestion
Ensure that all internal and external references to the "Compose APIs" page are updated to point to the new "Virtual Endpoints" page to avoid broken links. [important]
Verify that the newly added alias (/advanced-configuration/compose-apis) correctly redirects from the old page to the new "Virtual Endpoints" page without any issues. Testing this in a staging environment before deployment is recommended. [important]
Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
Examples for extra instructions:
[pr_reviewer] # /review #
extra_instructions="""
In the 'possible issues' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation
When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]
meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels
The review tool can auto-generate two specific types of labels for a PR:
a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools
The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.
Auto-approve PRs
By invoking:
/review auto_approve
The tool will automatically approve the PR, and add a comment with the approval.
To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
[pr_reviewer]
enable_auto_approval = true
(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:
[pr_reviewer]
maximal_review_effort = 5
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
Remove or update the link to compose-apis to align with the PR's intention.
The title of the PR suggests removing the compose-apis page, but the diff shows an addition of a link to compose-apis/virtual-endpoints under the advanced-configuration.md file. If the intention is to remove references to compose-apis, this link should also be removed or updated to reflect the new structure.
-* [Compose APIs]({{< ref "advanced-configuration/compose-apis/virtual-endpoints" >}}). How to make multiple API calls and the batch processing.+* [New Relevant Section]({{< ref "new-section/new-subsection" >}}). Description of the new or updated content.
Update or remove the alias to avoid confusion and ensure link consistency.
Adding an alias /advanced-configuration/compose-apis to the virtual-endpoints.md might create confusion or broken links if the compose-apis section is being removed or restructured. Consider updating or removing this alias to ensure consistency and avoid dead links.
-- /advanced-configuration/compose-apis+# If the section is being moved or renamed, update the alias accordingly+- /new-section/new-subsection+# If the alias is no longer needed, it can be removed
Correct the front matter formatting to ensure proper rendering.
The front matter of the markdown file starts with --- traditionally. The addition of a single + might be a typo or formatting error. Ensure that the front matter is correctly formatted to avoid rendering issues.
Update all references to the new alias to maintain link integrity.
Given the addition of a new alias, ensure that all references throughout the documentation are updated to reflect this change. This includes links in other documents, navigation structures, and any hardcoded URLs in examples or guides.
-- /advanced-configuration/compose-apis+# Example of updating a reference in another document+[Virtual Endpoints]({{< ref "/new-section/new-subsection" >}})
Add summaries for each item in the list to enhance readability and user experience.
Consider adding a brief description or summary for each listed item under the "This section covers" list. This would provide readers with a quick overview of what each link entails without needing to click through, enhancing the user experience.
-* [Compose APIs]({{< ref "advanced-configuration/compose-apis/virtual-endpoints" >}}). How to make multiple API calls and the batch processing.+* [Compose APIs]({{< ref "advanced-configuration/compose-apis/virtual-endpoints" >}}) - This section explains how to efficiently make multiple API calls and process them in batches, optimizing your API's performance.
✨ Improve tool usage guide:
Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions
Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
Examples for extra instructions:
[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality
While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
@andyo-tyk This PR will fix the CI error in JS Virtual Endpoints PR
The error was happening because the /advanced-configuration/compose-apis page is no longer used in menu.yaml and needs removing with an alias setup. This PR does that
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.
titpetric
force-pushed
the
Improved-virtual-endpoint-and-javascript
branch
2 times, most recently
from
letzya
force-pushed
the
Improved-virtual-endpoint-and-javascript
branch
from
For internal users - Please add a Jira DX PR ticket to the subject!
DX-1156
Preview Link
This link advanced-configuration/compose-apis should redirect to the /advanced-configuration/compose-apis/demo-virtual-endpoint page
Description
Fix CI checks in 5.3 JS virtual endpoints PR
/advanced-configuration/compose-apis page is not referenced in menu.yaml in this PR Update virtual endpoint and JS docs
The file needs removing and a redirect added for path /advanced-configuration/compose-apis to content file tyk-docs/content/advanced-configuration/compose-apis/virtual-endpoints.md
Screenshots (if appropriate)
Checklist
master.