Skip to content

remove tabs, add collapses, add images #6294

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

Merged
merged 4 commits into from
Apr 15, 2025

Conversation

letzya
Copy link
Collaborator

@letzya letzya commented Apr 10, 2025

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors


PR Type

  • Enhancement
  • Documentation

Description

  • Restructure API creation and configuration steps.

  • Add collapsible detail blocks for guided instructions.

  • Clarify throttling configuration parameters.

  • Clean up markdown formatting and remove deprecated sections.


Changes walkthrough 📝

Relevant files
Enhancement
request-throttling.md
Update and enhance request throttling tutorial layout.     

tyk-docs/content/api-management/request-throttling.md

  • Changed API import instructions from bullet points to numbered steps.
  • Wrapped API definition and policy/key configuration details in
    expandable details blocks.
  • Updated throttling parameter explanations and default values.
  • Improved overall markdown formatting and removed outdated FAQs.
  • +129/-113

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @letzya letzya requested a review from sharadregoti April 10, 2025 20:22
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Typographical Errors

    Some newly added text contains typographical mistakes (for example, an incorrect splitting of "both" and a misspelling of "disabled"). Please review and correct these issues to improve clarity.

    To enable throttling,b oth fields must be set to a value greater than `0`. 
    
    ### Disable throttling
    
    The default value is `-1` and means it is disabled by default.
    Setting `throttle_interval` and `throttle_retry_limit` values to  any number smaller than `0`, to ensure the feature is diabled.
    
    
    Formatting Consistency

    The new collapsible instruction sections and bullet lists show slight variations in formatting and punctuation compared to the existing style. Ensure a consistent style and punctuation to maintain clear, professional documentation.

    #### API set up
    
    5.  **Create an API:**
        1. Log in to your Tyk Dashboard.
        2. Navigate to **API Management > APIs**
        3. Click **Add New API**
        4. Click **Import**
        5. Select **Import Type** as **Tyk API**
        6. Copy the below Tyk OAS definition in the text box and click **Import API** to create an API
    
            <details>

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix typos and clarify wording

    Correct the typos and clarify the wording for throttling configuration.

    tyk-docs/content/api-management/request-throttling.md [310-311]

    -+To enable throttling,b oth fields must be set to a value greater than `0`.
    -+Setting `throttle_interval` and `throttle_retry_limit` values to  any number smaller than `0`, to ensure the feature is diabled.
    ++To enable throttling, both fields must be set to a value greater than `0`.
    ++The default value of `-1` indicates that throttling is disabled.
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion accurately corrects typos and clarifies the throttling configuration text, improving documentation clarity, though its impact is moderate.

    Low
    Possible issue
    Align JSON value comments

    Align the inline comments with the actual numeric values in the JSON configuration.

    tyk-docs/content/api-management/request-throttling.md [380-381]

    -+  "throttle_interval": 2,       // Wait 1 second between retries
    -+  "throttle_retry_limit": 3,    // Attempt a maximum of 5 retries
    ++  "throttle_interval": 2,       // Wait 2 seconds between retries
    ++  "throttle_retry_limit": 3,    // Attempt a maximum of 3 retries
    Suggestion importance[1-10]: 4

    __

    Why: The suggestion fixes inconsistent inline comments in the JSON snippet by matching them with the actual numeric values; while correct, this change is a minor documentation improvement.

    Low

    @sharadregoti sharadregoti merged commit 5e4e80b into request-throttling Apr 15, 2025
    7 checks passed
    @sharadregoti sharadregoti deleted the letz-request-throttling branch April 15, 2025 10:07
    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