-
Notifications
You must be signed in to change notification settings - Fork 153
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
base: master
Are you sure you want to change the base?
Conversation
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
User description
Docs for creating streaming API using dashboard UI
PR Type
Documentation
Description
Changes walkthrough 📝
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
Streams API.
API access.
menu.yaml
Update menu to include Streams API configuration guide
tyk-docs/data/menu.yaml