Skip to content
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

Fix typo in JSON #5875

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Fix typo in JSON #5875

merged 1 commit into from
Jan 8, 2025

Conversation

buraksekili
Copy link
Contributor

@buraksekili buraksekili commented Jan 7, 2025

User description

For internal users - Please add a Jira DX PR ticket to the subject!


This PR fixes a minor typo in JSON sample used in https://tyk.io/docs/product-stack/tyk-gateway/middleware/allow-list-tyk-classic/

Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

PR Type

Documentation


Description

  • Fixed a minor typo in JSON example for clarity.

  • Updated documentation for the Allow List middleware.


Changes walkthrough 📝

Relevant files
Documentation
allow-list-tyk-classic.md
Fixed JSON formatting typo in documentation                           

tyk-docs/content/product-stack/tyk-gateway/middleware/allow-list-tyk-classic.md

  • Corrected a JSON formatting typo by adding a missing comma.
  • Improved the accuracy of the JSON example for better understanding.
  • +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    github-actions bot commented Jan 7, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    JSON Syntax Correction

    Ensure that the added comma in the JSON structure is correct and does not introduce any syntax errors or unintended changes in the documentation example.

    },

    Copy link
    Contributor

    github-actions bot commented Jan 7, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Verify the correctness of the added comma to prevent JSON parsing issues

    Ensure the added comma after the closing curly brace is intentional and aligns with
    the expected JSON syntax, as an extra or misplaced comma could lead to JSON parsing
    errors.

    tyk-docs/content/product-stack/tyk-gateway/middleware/allow-list-tyk-classic.md [53]

    -},
    +}
    Suggestion importance[1-10]: 7

    Why: The suggestion is valid as it highlights a potential issue with JSON syntax, which could lead to parsing errors if the comma is misplaced. However, it is not actionable beyond verification, which slightly reduces its impact.

    7

    Copy link

    netlify bot commented Jan 7, 2025

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

    Name Link
    🔨 Latest commit a3dddfd
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/677d605099f8130008d676c4
    😎 Deploy Preview https://deploy-preview-5875--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

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

    @sharadregoti sharadregoti merged commit 20f0a9d into master Jan 8, 2025
    9 checks passed
    @sharadregoti sharadregoti deleted the buraksekili-patch-2 branch January 8, 2025 05:14
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.7

    Copy link

    tykbot bot commented Jan 8, 2025

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jan 8, 2025
    (cherry picked from commit 20f0a9d)
    Copy link

    tykbot bot commented Jan 8, 2025

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Jan 8, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants