netlify[bot]
commented
1 month ago PS. Pls add /docs/nightly to the end of url
| Name | Link |
|---|---|
| Latest commit | 318f3d33bc63aa0a4ec2a95af19baac14329a64e |
| Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/66dec13ac4f0a4000811fc09 |
| Deploy Preview | https://deploy-preview-5368--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.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master.Implement error handling for missing certificates
___ **Add error handling for missing certificates when configuringupstream_certificate_refsto improve reliability and user feedback.** [tyk-docs/content/basic-config-and-security/security/mutual-tls/upstream-mtls.md [71]](https://github.com/TykTechnologies/tyk-docs/pull/5368/files#diff-d10e3c91cc749978a2a48912a3fc9b3a3ea4fbc456c7bdc9dde2839a30b32c94R71-R71) ```diff upstream_certificate_refs: - "*": my-test-tls + "*": my-test-tls # Add error handling if certificate is missing ```Suggestion importance[1-10]: 8
Why: Adding error handling for missing certificates is a significant enhancement that improves reliability and user feedback, addressing a potential issue in the configuration process.Validate
___ **Add a validation to ensure that therateandperfields to be integersrateandpervalues inglobal_rate_limitareintegers to prevent runtime errors.** [tyk-docs/content/basic-config-and-security/control-limit-traffic/rate-limiting.md [101-103]](https://github.com/TykTechnologies/tyk-docs/pull/5368/files#diff-1d63c4783ce4de0d1fbaed0b2a6e1ed70cf4a5c0557f1790439e294463127572R101-R103) ```diff global_rate_limit: - rate: 10 - per: 60 + rate: 10 # Ensure this is an integer + per: 60 # Ensure this is an integer ```
Suggestion importance[1-10]: 7
Why: Adding a comment to ensure `rate` and `per` are integers is a good practice to prevent potential runtime errors, enhancing code robustness.Ensure proper formatting of the
___ **Ensure that thetagsfield as a listtagsfield in the API definition is properly formatted as a list.The current implementation might be prone to errors if not handled as a list
explicitly.** [tyk-docs/content/advanced-configuration/manage-multiple-environments/with-tyk-multi-cloud.md [58-59]](https://github.com/TykTechnologies/tyk-docs/pull/5368/files#diff-19a2c34107181ccee3dc99cb4e639868ae543027dee22aa994a78fb356e36913R58-R59) ```diff tags: - - edge + - "edge" ```
Suggestion importance[1-10]: 5
Why: The suggestion to ensure the `tags` field is formatted as a list is valid for clarity, although the existing YAML format is already correct. This suggestion improves readability but is not crucial.