feat: render bindings in relevant sections #259

195858 · 2021-03-08T15:41:07Z

Description

Changes proposed in this pull request:

Created a new bindings/binding component, which can render simple, nested and Schema Object properties
Added helper functions to determine the type of a binding property, Schema Objects are listed for now as there don't seem to be schemas for bindings at this stage?
Added styles for the new component
Updated the types to include bindings in the appropriate interfaces
Updated server, channel, operation and message components to render bindings if present
Slightly changed operation/messages rendering

magicmatatjahu

Great! Thanks for contribution! I will also make review for this part with rendering in new way the messages/payloads section. Probably we should introduce these changes in followup issue/PR.

library/src/types.ts

library/src/helpers/bindingsHelpers.ts

library/src/containers/Bindings/BindingField.tsx

library/src/containers/Bindings/Bindings.tsx

195858 · 2021-03-09T13:16:19Z

Hi,
I've made the changes you suggested except for the "bindingsHelper.isObject" method.

Co-authored-by: Maciej Urbańczyk <[email protected]>

magicmatatjahu · 2021-03-10T11:01:53Z

@195858 Very good, but I have some problems with modified part related to messages/operations:

Could you fix styling (paddings) for header title here? In addition, make that the badge subscribe should be a few px away from the title (I think we use 6 or 12 in another part for that case). Please also fix it for publish badge.

I don't know from which part we have this blank content, but it should be removed.

Do you wanna to render the summary and description in toggle? If this is intentional, I would prefer to do this in followup PR and modify other parts including channels, schematic etc, because currently we have inconsistencies. In addition, as you can see, the styles don't look very good :)

magicmatatjahu · 2021-03-10T10:46:07Z

library/src/containers/Channels/Operation.tsx

+    <section
+      className={bemClasses.element(`${className}-oneOf-${payloadType}`)}
+    >
+      <header
+        className={bemClasses.element(
+          `${className}-oneOf-${payloadType}-header`,
+        )}
+      >
+        <h3>
+          {isPublish && isSubscribe ? (
+            <Badge
+              type={
+                payloadType === PayloadType.PUBLISH
+                  ? BadgeType.PUBLISH
+                  : BadgeType.SUBSCRIBE
+              }
+            />
+          ) : null}
+          <span>
+            {payloadType === PayloadType.PUBLISH
+              ? ONE_OF_FOLLOWING_MESSAGES_PUBLISH_SINGLE_TEXT
+              : ONE_OF_FOLLOWING_MESSAGES_SUBSCRIBE_SINGLE_TEXT}
+          </span>
+        </h3>
+      </header>
+      {operation.summary && (
+        <div className={bemClasses.element(`${className}-description`)}>
+          <Markdown>{operation.summary}</Markdown>
+        </div>
+      )}


Why do you wanna render single message with styling for oneOf?

I simply reused the existing styles - I think the action to take here is to create separate styles.
I just wanted the message to be rendered similar to one-of because the previous rendering omitted information. If a channel had both subscribe and publish operations the result was really confusing.
Hence I added the help text and the summary if it exists.

195858 · 2021-03-11T11:18:28Z

@195858 Very good, but I have some problems with modified part related to messages/operations:

Could you fix styling (paddings) for header title here? In addition, make that the badge subscribe should be a few px away from the title (I think we use 6 or 12 in another part for that case). Please also fix it for publish badge.

Will do.

I don't know from which part we have this blank content, but it should be removed.

It's because the message does have neither a description nor a summary.
I'll see how I can omit this in this case.

Do you wanna to render the summary and description in toggle? If this is intentional, I would prefer to do this in followup PR and modify other parts including channels, schematic etc, because currently we have inconsistencies. In addition, as you can see, the styles don't look very good :)

OK, the toggle was there before - however I see that the description is now presented in the collapsed view. I'll address this

195858 · 2021-03-11T13:19:42Z

Do you wanna to render the summary and description in toggle? If this is intentional, I would prefer to do this in followup PR and modify other parts including channels, schematic etc, because currently we have inconsistencies. In addition, as you can see, the styles don't look very good :)

A further remark - summary was rendered as part fo the header before. I don;t think I changed it - however I'll clean it up/find a better looking way.

magicmatatjahu · 2021-03-12T11:24:54Z

@195858 Thank you very much for your work! I appreciate that. Please ping me when you done :)

195858 · 2021-03-19T08:27:32Z

@magicmatatjahu - made some changes ...

The channel operation has a new header format. Operation binding and messages section is now indented so it's easier to see how the sections relate.

The top level message section is adjusted as well

magicmatatjahu · 2021-03-22T08:38:14Z

@195858 Thanks for patience and for your work! I wanted to see it in my local machine, but as I see, styles aren't update from 14 days. Do you could push changes for new styling described in your last comment? I like the styles very much :)

sonarqubecloud · 2021-03-22T09:39:15Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

195858 · 2021-03-22T09:40:24Z

@magicmatatjahu - sorry forgot to push my changes.

magicmatatjahu

LGTM! :) Thanks for contribution!

magicmatatjahu · 2021-03-23T15:51:37Z

@195858 I forgot that non-maintainers hasn't access to merge... Very, very sorry for delay and thanks again for contribution!

asyncapi-bot · 2021-03-23T15:56:45Z

🎉 This PR is included in version 0.21.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

derberg · 2021-03-24T12:10:04Z

@all-contributors please add @195858 for code

allcontributors · 2021-03-24T12:10:12Z

@derberg

I've put up a pull request to add @195858! 🎉

195858 added 7 commits March 2, 2021 15:30

feat: render bindings in relevant sections

577ac50

feat: render bindings in relevant sections

09a8a65

Merge branch 'master' of github.com:solace-iot-team/asyncapi-react

9d86bcf

fix: render complex bindings/ schema objects

e0977d9

feat: bindings - render Schema Objects

f79b3f2

fix: added bindings and corrected kafka binding example

193eb54

Merge branch 'master' into master

b5253d3

magicmatatjahu requested changes Mar 9, 2021

View reviewed changes

fix: changes based on PR comments

b2e359f

195858 and others added 2 commits March 9, 2021 13:18

fix: no empty interfaces, defaulting to BaseBindings interface for now

58e3716

fix: bindingHelpers.isObject as per PR suggestion

d1b9ba7

Co-authored-by: Maciej Urbańczyk <[email protected]>

195858 requested a review from magicmatatjahu March 10, 2021 09:15

magicmatatjahu reviewed Mar 10, 2021

View reviewed changes

magicmatatjahu mentioned this pull request Mar 10, 2021

[RFC] Support JSON Schema for bindings asyncapi/spec#507

Closed

195858 added 5 commits March 12, 2021 12:52

fix: added operation descriptions

b3c656a

fix: inferredName can be null/undefined

406f7d8

fix: operation and messages section format

3f4f7ac

Merge branch 'master' of github.com:asyncapi/asyncapi-react

3095888

Merge branch 'master' into master

559e622

Merge branch 'master' of github.com:solace-iot-team/asyncapi-react

b5eb41b

magicmatatjahu approved these changes Mar 22, 2021

View reviewed changes

magicmatatjahu merged commit b85715d into asyncapi:master Mar 23, 2021

asyncapi-bot added the released label Mar 23, 2021

allcontributors bot mentioned this pull request Mar 24, 2021

docs: add 195858 as a contributor #274

Merged

magicmatatjahu mentioned this pull request May 4, 2021

Support missing fields/objects from spec 2.0.0 #63

Closed

11 tasks

magicmatatjahu mentioned this pull request May 13, 2021

chore(blog): add article about asyncapi activites on April asyncapi/website#257

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: render bindings in relevant sections #259

feat: render bindings in relevant sections #259

195858 commented Mar 8, 2021

magicmatatjahu left a comment •

edited

Loading

195858 commented Mar 9, 2021

magicmatatjahu commented Mar 10, 2021

magicmatatjahu Mar 10, 2021

195858 Mar 11, 2021

195858 commented Mar 11, 2021

195858 commented Mar 11, 2021

magicmatatjahu commented Mar 12, 2021

195858 commented Mar 19, 2021

magicmatatjahu commented Mar 22, 2021 •

edited

Loading

sonarqubecloud bot commented Mar 22, 2021

195858 commented Mar 22, 2021

magicmatatjahu left a comment

magicmatatjahu commented Mar 23, 2021

asyncapi-bot commented Mar 23, 2021

derberg commented Mar 24, 2021

allcontributors bot commented Mar 24, 2021

feat: render bindings in relevant sections #259

feat: render bindings in relevant sections #259

Conversation

195858 commented Mar 8, 2021

magicmatatjahu left a comment • edited Loading

Choose a reason for hiding this comment

195858 commented Mar 9, 2021

magicmatatjahu commented Mar 10, 2021

magicmatatjahu Mar 10, 2021

Choose a reason for hiding this comment

195858 Mar 11, 2021

Choose a reason for hiding this comment

195858 commented Mar 11, 2021

195858 commented Mar 11, 2021

magicmatatjahu commented Mar 12, 2021

195858 commented Mar 19, 2021

magicmatatjahu commented Mar 22, 2021 • edited Loading

sonarqubecloud bot commented Mar 22, 2021

195858 commented Mar 22, 2021

magicmatatjahu left a comment

Choose a reason for hiding this comment

magicmatatjahu commented Mar 23, 2021

asyncapi-bot commented Mar 23, 2021

derberg commented Mar 24, 2021

allcontributors bot commented Mar 24, 2021

magicmatatjahu left a comment •

edited

Loading

magicmatatjahu commented Mar 22, 2021 •

edited

Loading