[DX-1008, TT-11562] Updated Internal Endpoint middleware

[andyo-tyk]

User description

Preview Link

https://deploy-preview-4046--tyk-docs.netlify.app/docs/nightly/product-stack/tyk-gateway/middleware/internal-endpoint-middleware/

Description

Updated documentation of the Internal Endpoint middleware

---

Type

Documentation

---

Description

• Updated the description of the Internal Endpoint middleware in the Endpoint Designer documentation.
• Added comprehensive documentation for the Internal Endpoint middleware, explaining its use cases, how it works, and how to address an internal endpoint.
• Added guides on how to use the Internal Endpoint middleware with Tyk Classic APIs and Tyk OAS APIs, including how to configure the middleware in the API definition and in the API Designer.
• Updated the menu to include new items for the Internal Endpoint middleware documentation.

---

Changes walkthrough

	Relevant files
Documentation	endpoint-designer.md Update Internal Endpoint middleware description in Endpoint Designer documentation tyk-docs/content/advanced-configuration/transform-traffic/endpoint-designer.md Updated the description of the Internal Endpoint middleware. +1/-1      internal-endpoint-middleware.md Add Internal Endpoint middleware documentation                                      tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-middleware.md Added a comprehensive documentation for the Internal Endpoint middleware. +58/-0    internal-endpoint-tyk-classic.md Add guide for using Internal Endpoint middleware with Tyk Classic APIs tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-classic.md Added a guide on how to use the Internal Endpoint middleware with Tyk Classic APIs. +47/-0    internal-endpoint-tyk-oas.md Add guide for using Internal Endpoint middleware with Tyk OAS APIs tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-oas.md Added a guide on how to use the Internal Endpoint middleware with Tyk OAS APIs. +102/-0
Configuration changes	menu.yaml Update menu with Internal Endpoint middleware documentation links tyk-docs/data/menu.yaml Added new menu items for the Internal Endpoint middleware documentation. +16/-0

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. 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 describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

Utilizing extra instructions The describe tool can be configured with extra instructions, 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. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: [pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

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. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

---

Type

Documentation

---

Description

• Updated the description of the Internal Endpoint middleware in the Endpoint Designer documentation.
• Added comprehensive documentation for the Internal Endpoint middleware, explaining its use cases, how it works, and how to address an internal endpoint.
• Added guides on how to use the Internal Endpoint middleware with Tyk Classic APIs and Tyk OAS APIs, including how to configure the middleware in the API definition and in the API Designer.
• Updated the menu to include new items for the Internal Endpoint middleware documentation.

---

Changes walkthrough

	Relevant files
Documentation	endpoint-designer.md Update Internal Endpoint Middleware Description                    tyk-docs/content/advanced-configuration/transform-traffic/endpoint-designer.md Updated the description of the Internal Endpoint middleware. +1/-1      ignore-tyk-classic.md Add Illustration for Ignore Authentication Middleware        tyk-docs/content/product-stack/tyk-gateway/middleware/ignore-tyk-classic.md Added an image illustrating how to add the ignore authentication middleware to a Tyk Classic API endpoint. +2/-0      ignore-tyk-oas.md Correct Configuration Steps for Ignore Authentication Middleware tyk-docs/content/product-stack/tyk-gateway/middleware/ignore-tyk-oas.md Corrected section titles and steps for configuring the middleware. Added images for configuring the Ignore Authentication middleware. +9/-9      internal-endpoint-middleware.md Introduce Internal Endpoint Middleware Documentation          tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-middleware.md Introduced documentation for the Internal Endpoint middleware. Explained the use cases, how it works, and addressing internal endpoints. +58/-0    internal-endpoint-tyk-classic.md Document Using Internal Endpoint Middleware with Tyk Classic APIs tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-classic.md Added documentation on using the Internal Endpoint middleware with Tyk Classic APIs. Provided configuration examples and steps. +49/-0    internal-endpoint-tyk-oas.md Document Using Internal Endpoint Middleware with Tyk OAS APIs tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-oas.md Added documentation on using the Internal Endpoint middleware with Tyk OAS APIs. Provided configuration examples and steps. +119/-0
Configuration changes	menu.yaml Update Menu for Internal Endpoint Middleware Documentation tyk-docs/data/menu.yaml Updated the menu to include new items for the Internal Endpoint middleware documentation. +16/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Description updated to latest commit (001dd27)

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	5e14da1
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/65fd6f713d846d000872a544
😎 Deploy Preview	https://deploy-preview-4046--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[github-actions]

PR Analysis

• 🎯 Main theme: Updating and expanding the documentation for the Internal Endpoint middleware in Tyk Gateway.
• 📝 PR summary: This PR updates the documentation for the Internal Endpoint middleware in Tyk Gateway. It provides a more comprehensive explanation of the middleware, its use cases, and how it works. It also includes guides on how to use the middleware with Tyk Classic APIs and Tyk OAS APIs, and how to configure it in the API definition and in the API Designer. The menu has been updated to include new items for the Internal Endpoint middleware documentation.
• 📌 Type of PR: Documentation
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 1, because the PR is purely documentation updates, which are generally straightforward to review.
• 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the documentation updates are comprehensive and clear. It would be beneficial to ensure that all the new links in the documentation are working correctly and lead to the right places. Also, make sure that the new menu items are correctly displayed and accessible.

🤖 Code feedback:

---

relevant file	tyk-docs/content/advanced-configuration/transform-traffic/endpoint-designer.md
suggestion	Consider adding a brief explanation of what an "internal request" is in the context of Tyk Gateway, as this term is used frequently in the documentation but may not be clear to all readers. [medium]
relevant line	The [Internal Endpoint

---

relevant file	tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-middleware.md
suggestion	It might be helpful to provide a brief example or use case for each of the three different identifiers (self, api_id, listen path) that can be used to address an internal endpoint. This would make it easier for users to understand when and how to use each identifier. [medium]
relevant line	An internal endpoint can be addressed using three different identifiers in using the format tyk://{identifier}/{endpoint}.

---

---

✨ Usage guide:

---

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:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions 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 'general suggestions' 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.

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. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

No suggestions found to improve this PR.

---

✨ 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:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] 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. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[dcs3spp]

PR LGTM Andy, I've suggested minor changes. Once images and placeholder videos are added and PR peer reviewed then willapprove and ready as ready for merge and release.

[andyo-tyk]

Adjusted suggestions following review

[dcs3spp]

Thanks Andy! PR LGTM, have resolved comments apart from image and video to add. Once peer reviewed and image and video has been added then we can mark as ready for release. I'll mark the PR as draft until image and video added.

[andyo-tyk]

Minor improvements

[dcs3spp]

@andyo-tyk To facilitate reviewing the PR queue we are closing some PRs that are in draft status, e.g. awaiting docker images, videos, images etc. You can still update the PR and then open it again when ready for review.

cc: @letzya

[andyo-tyk]

I spotted a typo and missing image in Ignore Auth, so picked these up in this PR as simple edits.

[github-actions]

PR Description updated to latest commit (0be9b0e)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the PR primarily involves documentation updates, which are generally easier and quicker to review than code changes. However, it introduces several new pages and updates existing ones, requiring attention to detail in verifying the accuracy and clarity of the information provided.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

---

✨ Review tool usage guide:

---

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:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions 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, require_can_be_split_review, 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. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

No code suggestions found for PR.