Skip to content

Docs for 5.9.0 #6567

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

Open
wants to merge 38 commits into
base: master
Choose a base branch
from
Open

Docs for 5.9.0 #6567

wants to merge 38 commits into from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Jun 19, 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

Documentation


Description

  • Adds official documentation for the Mapping processor using Bloblang

  • Provides usage examples and considerations for Mapping processor

  • Removes outdated notes and TODOs about Bloblang support

  • Updates event-driven and stream config docs for 5.9.0 Bloblang support


Changes walkthrough 📝

Relevant files
Documentation
event-driven-apis.md
Remove pre-5.9.0 Mapping processor warning and TODOs         

tyk-docs/content/api-management/event-driven-apis.md

  • Removes note about Mapping processor being unofficial before 5.9.0
  • Cleans up related TODO comments for Bloblang support
  • +0/-11   
    stream-config.md
    Add Mapping processor and Bloblang usage documentation     

    tyk-docs/content/api-management/stream-config.md

  • Adds comprehensive documentation for the Mapping processor using
    Bloblang
  • Provides a detailed example of mapping/filtering JSON with Bloblang
  • Lists considerations and error handling for Bloblang mappings
  • Removes all TODO comments about pending Bloblang support
  • +48/-12 

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    ⚠️ Deploy preview for PR #6567 did not become live after 3 attempts.
    Please check Netlify or try manually: Preview URL

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Documentation Accuracy

    The new documentation for the Mapping processor and Bloblang usage should be validated for technical accuracy, clarity, and completeness, especially the provided examples and the explanation of fallback behavior.

    ### Mapping
    
    Executes a Bloblang mapping on messages, creating a new document that replaces (or filters) the original message.
    
    Bloblang is a powerful language that enables various mapping, transformation, and filtering tasks. For more information, check out the [Bloblang docs](https://warpstreamlabs.github.io/bento/docs/guides/bloblang/about/).
    
    ```yml
    label: ""
    mapping: "" # No default (required)

    Example

    Given a JSON document with US location names and the states they are located in:

    {
      "locations": [
        {"name": "Seattle", "state": "WA"},
        {"name": "New York", "state": "NY"},
        {"name": "Bellevue", "state": "WA"},
        {"name": "Olympia", "state": "WA"}
      ]
    }

    If we want to collapse the location names from the state of Washington into a field Cities:

    {"Cities": "Bellevue, Olympia, Seattle"}

    We could use the following bloblang mapping:

    pipeline:
      processors:
        - mapping: |
            root.Cities = this.locations.
                            filter(loc -> loc.state == "WA").
                            map_each(loc -> loc.name).
                            sort().join(", ")

    Considerations

    • If a mapping fails, the message remains unchanged. However, Bloblang provides powerful ways to ensure your mappings do not fail by specifying desired fallback behaviour. See this section of the Bloblang docs.
    • Mapping operates by creating an entirely new object during assignments. This has the advantage of treating the original referenced document as immutable and, therefore, queryable at any stage of your mapping. As a result, the Cities JSON document in the above example is a new, separate copy of the original document, which remains unchanged.
    
    </details>
    
    </td></tr>
    </table>
    

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Jun 19, 2025

    PS. Add to the end of url /docs/nightly

    Name Link
    🔨 Latest commit 7cda21f
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68540e3edf45f600083ac313
    😎 Deploy Preview https://deploy-preview-6567--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 project configuration.

    Copy link

    netlify bot commented Jun 19, 2025

    PS. Add to the end of url /docs/nightly

    Name Link
    🔨 Latest commit 33f9fd1
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6875469216164e000890f668
    😎 Deploy Preview https://deploy-preview-6567--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 project configuration.

    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.

    5 participants