Skip to content
This repository has been archived by the owner on Jun 18, 2023. It is now read-only.

Feature/add message binding to channel documentation #35

Conversation

sam0r040
Copy link
Collaborator

This PR extends the springwolf-ui to display message binding information which is added in springwolf-core in springwolf/springwolf-core#130.
It also moves the editable header example to the example view so that everything that can be edited and send to the backend to produce messages is now on one screen.

Changes:

  • A new tab "Message Bindings" is added to display the message binding spec (similar to operation binding)
  • The textbox for editing the headers example has been moved to the examples tab
  • A ready-only view of the headers example has been added to the headers tab
  • A textbox for editing the message binding example has been added to the example tab
  • The content of the message binding example textbox will be send to the backend when producing messages

@netlify
Copy link

netlify bot commented Jan 16, 2023

Deploy Preview for mellow-manatee-3041fb ready!

Name Link
🔨 Latest commit 967a029
🔍 Latest deploy log https://app.netlify.com/sites/mellow-manatee-3041fb/deploys/640b42c4975cde000787db93
😎 Deploy Preview https://deploy-preview-35--mellow-manatee-3041fb.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 settings.

@timonback
Copy link
Member

Great contribution!

The data in the message binding tab seems off and includes springwolf-ui internal data, is it intended that way?
https://deploy-preview-35--mellow-manatee-3041fb.netlify.app/springwolf-ui/asyncapi-ui.html#channel-kafka-example-producer-topic-subscribe-AnotherPayloadDto

In terms of layout, I wonder if the items in example should be sorted the other way round. As an user, I am mostly interested in the payload/data, which I tend to expect first. What do you think?

@timonback
Copy link
Member

@stavshamir I'd like to motivate once more a common code formatting style. To me, it does not matter, which formatting is used, but it should be consistent. It also avoids the changed lines due to added/missing spaces.
No need to change the content of the PR, but I attempt to get to a common formatting style. One example is present in #14

sam0r040 and others added 5 commits March 10, 2023 15:45
…dd header and message binding example to example tab
…he backend can use the message binding to construct a message
… creates a specification without message binding
Regression: Previously included mapped ui attributes
chore: Improve [protocol: string]: any typings

Co-authored-by: [email protected]
@sam0r040 sam0r040 force-pushed the feature/add_message_binding_to_channel_documentation branch from 3ffd54e to 967a029 Compare March 10, 2023 14:46
@timonback timonback merged commit bca7d2b into springwolf:master Mar 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants