Skip to content

Monetize async apis #6270

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

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from
Draft

Monetize async apis #6270

wants to merge 11 commits into from

Conversation

sharadregoti
Copy link
Contributor

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

  • Added comprehensive async API monetization documentation

  • Detailed guide for publishing async APIs via the Developer Portal

  • Included webhook subscription configuration instructions

  • Updated navigation menu for new monetization page


Changes walkthrough 📝

Relevant files
Documentation
monetize-event-driven-apis.md
New Async API Monetization Documentation                                 

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

  • New markdown file introducing async API monetization
  • Instructions for publishing async APIs using developer portal
  • Details on async API documentation and webhook subscriptions
  • YAML configuration example included
  • +88/-0   
    Configuration changes
    menu.yaml
    Update Navigation Menu for Async API Monetization               

    tyk-docs/data/menu.yaml

  • Added new menu item for Monetize Async APIs
  • Updated Tyk Streams menu ordering
  • +4/-0     

    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

    github-actions bot commented Apr 7, 2025

    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

    Naming Consistency

    The title defined in the front matter ("Tyk Streams – Manage Event-Driven APIs") does not match the section heading ("Monetize APIs using Developer Portal"). Consider standardizing the naming for clarity.

    title: "Tyk Streams – Manage Event-Driven APIs"
    date: 2025-02-10
    tags: ["Tyk Streams", "Glossary", "Use Cases", "Asynchronus APIs", "Async", "Configuration"]
    description: "Introduction to Tyk Streams"
    keywords: ["Tyk Streams", "Glossary", "Use Cases", "Asynchronus APIs", "Async", "Configuration"]
    ---
    
    ### Monetize APIs using Developer Portal
    Typo

    Review the spelling of "Asynchronus" in the tags. It should likely be "Asynchronous".

    tags: ["Tyk Streams", "Glossary", "Use Cases", "Asynchronus APIs", "Async", "Configuration"]

    Copy link
    Contributor

    github-actions bot commented Apr 7, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Apr 7, 2025

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

    Name Link
    🔨 Latest commit 81e9a9d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67f364008b8a7d0008b613be
    😎 Deploy Preview https://deploy-preview-6270--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.

    1 similar comment
    Copy link

    netlify bot commented Apr 7, 2025

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

    Name Link
    🔨 Latest commit 81e9a9d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67f364008b8a7d0008b613be
    😎 Deploy Preview https://deploy-preview-6270--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 marked this pull request as draft April 7, 2025 07:18
    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.

    1 participant