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

New section & guide on the UI for Streams #5721

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

Conversation

jay-deshmukh
Copy link
Contributor

@jay-deshmukh jay-deshmukh commented Nov 15, 2024

User description

Docs for creating streaming API using dashboard UI


PR Type

Documentation


Description

  • Added a comprehensive guide for configuring a Streams API using the Dashboard UI, detailing steps for setup, authentication, and access control.
  • Updated the documentation menu to include a new entry for the Streams API configuration guide, ensuring easy navigation.

Changes walkthrough 📝

Relevant files
Documentation
streams-configuration-using-ui.md
Add guide for configuring Streams API using Dashboard UI 

tyk-docs/content/product-stack/tyk-streaming/streams-configuration-using-ui.md

  • Added a new guide for configuring Streams API using the Dashboard UI.
  • Included detailed steps for creating, configuring, and securing a
    Streams API.
  • Provided instructions for creating policies and generating keys for
    API access.
  • Added images to illustrate the process.
  • +103/-0 
    Configuration changes
    menu.yaml
    Update menu to include Streams API configuration guide     

    tyk-docs/data/menu.yaml

  • Added a new menu entry for the Streams API configuration guide.
  • Updated the menu to include the new documentation path.
  • +4/-0     

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

    Copy link

    netlify bot commented Nov 15, 2024

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

    Name Link
    🔨 Latest commit d711da8
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673724e0f77b830008b5ddc2
    😎 Deploy Preview https://deploy-preview-5721--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.

    Copy link

    netlify bot commented Nov 15, 2024

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

    Name Link
    🔨 Latest commit bd3db7b
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673fffb9ba4a5800085dc969
    😎 Deploy Preview https://deploy-preview-5721--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.

    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
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    ## Create a Streams API

    ### Step 1: Define API Name and Type
    1. Click on **Streams & Events** from the sidebar. This will open a form for creating the Streams API.
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    After clicking on Streams & Events tab, are we sure there is no add API button? or this is true only for first time & during second time. There will be add api button.

    You may update the below images accordingly.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    The + Add API button has been deprecated in the new UI changes @sharadregoti

    - A popup will display the **Key Hash** and **Key ID**.

    - Use the **Key ID** to access the protected Streams API.

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Please add a section for Testing the API. There should be some option using curl or postman to test the created API. Also update the overview at the top accordingly.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    This guide focuses primarily on the configuration steps and does not include details on any specific APIs, as none have been configured yet. A separate documentation will be provided for API configuration and testing (Input / Output / Processor). Since testing an API without configured streams would not yield meaningful results, this section has been omitted from the current guide.

    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.

    3 participants