AsyncAPI EDA Design & Documentation ecosystem update (1 July - 30 September 2022)

asyncapi-eda-design-01-07-30-09-2022-update.md

AsyncAPI EDA Design & Documentation ecosystem update (1 July - 30 September 2022)

Update refers to repositories:

• studio
• asyncapi-react
• html-template
• markdown-template
• server-api
• generator
• cli

Note: the generator and cli update is described from an EDA design & documentation point of view. For more changes please refer to update in the EDA Development area.

studio

• New Features:
  • Studio supports 2.5.0 AsyncAPI
• Opened PRs:
  • We are very close to enable Spectral validation in the Studio. We are very excited!
  • Switch to visualiser library PR is still opened because it does not support all the capabilities and styles that we have. Hopefully we will merge it in upcoming days.
  • Support arm64 architecture in Docker image created by Daniel Sandoval.
  • Enable to mount local spec for docker container created by Riku Takeuchi. We have also opened similar one - import spec from file on editor init - created by Steve Hook.
  • There is a PR, which adds semi-multi-tabs behaviour to our editor. Check fix: ask user for reload and use url in parsing PR. It checks whether a given spec is fetched from an external source and, based on that, change editor's to overwrite/edit mode of a spec from localStorage.
• Ideas/discussions/issues:
  • We started first discussion about Drag & Drop Project! Firstly we wanna discuss how we wanna representant the blocks in our new side-app in the Studio. Feel free to comment. Check discussion.
  • Users raised problem with arm64 architecture in Docker image. We have also corresponding opened PR (mentioned above).
  • Users want to start Docker image with local spec file via Docker volume. We have also corresponding opened PRs (mentioned above).
  • We have opened some problems related to writing complex schemes in the editor - then the template is broken.
    • Import from URL should not use custom fetching but parseFromUrl
    • Studio gets blank white while writing complex binding
  • We should move to the latest cra and dependencies related to the monaco-editor (we use it as text editor in the Studio)
  • Some users want to have possibility to launch Studio without editor and new file options to extends the asyncapi start studio features.

asyncapi-react

NOTE: Included changes only for next branch.

• New Features:
  • Bump internal dependencies.
  • Component supports 2.5.0 AsyncAPI - tags and extensions on Server Object.
  • Fix rendering of a default and const boolean values in Schema section. We had a bug, when if someone defined const (or default) JSON Schema keyword with false value, then component rendered it as "empty" content.
  • We added config to override PUB/SUB label text. Some companies need to define given labels with custom names. Thanks Bradley Odell!
  • We also added the button to the Schema content to collapse deep schemas/values by one click. No more clicks hell to check deep schema!
• Opened PRs:
  • We wanna add anchors in sections to create automaticly anchors in page href.
  • We wanna make sidebar to be collapsible.
  • We wanna add config option to expand/collapse the examples payload.
• Ideas/discussions/issues:
  • We started discussion about our design for component. At the moment we use default styling and colors from TailwindCSS project, but we wanna have our own design system. Check this discussion and feel free to comment! First we wanna design the message's payload/schema output.
  • Maybe we should group servers in sidebar navigation like Operation Objects. What do you think? Feel free to comment.
  • Some people want to add slotting mechanism for extra HTML content. What do you think? Feel free to comment.
  • We should render schema examples in more "prettier way".

html-template

You can find more info about changes in the look of generated sections in the react-component section.

• New Features:
  • Template supports 2.5.0 version of AsyncAPI
• Opened PRs:
  • We have PR with adding parameter to enable setting favicon for rendered HTML documentation page. Thanks Rüdiger Busche!
• Ideas/discussions/issues: Nothing

markdown-template

• New Features:
  • Template supports 2.5.0 version of AsyncAPI
  • Now we escape pipe operators in table values. However that "feature" created bug - Markdown: Vertical bars not "escaped" within tables..
• Opened PRs: Nothing
• Ideas/discussions/issues:
  • Markdown: Vertical bars not "escaped" within tables.

server-api

• New Features:
  • ServerAPI supports 2.5.0 version of AsyncAPI
• Opened PRs:
  • Add the ability to send document references
  • Add /optimize path
• Ideas/discussions/issues:
  • We should add help/{command} endpoint to return instruction of given command to the user. For example help/generate should return available parameters such an available templates etc.

generator

• New Features: Nothing
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

cli

• New Features:
  • We are very close to enable Spectral validation in the CLI. We are very excited!
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

Reminder: latest cli uses latest studio that you can open by asyncapi new --studio or asyncapi start studio.

See you in next time!