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

Mark channels as deprecated as pr the spec #726

Closed
mifriis opened this issue May 9, 2023 · 2 comments
Closed

Mark channels as deprecated as pr the spec #726

mifriis opened this issue May 9, 2023 · 2 comments

Comments

@mifriis
Copy link

mifriis commented May 9, 2023

Description

Hi folks,

The AsyncAPI specification seems to support deprecation of channels (mentioned in Fixed Fields on https://www.asyncapi.com/docs/reference/specification/v2.3.0) but doesn't seem to have any effect on how a channel is displayed in the UI component.

It would be cool if it followed the same approach as OpenAPI by greying it out or similar.

Reasons

As new event formats, guidelines and similiar start to emerge in our organization, the need to move ahead to different ways to expose messages and chanels without breaking consumers/producers integration becomes increasingly important.

This react component is our primary way of viewing the spec.

As a consumer of an AsyncAPI I would like to know which channels are deprecated so i may choose the most relevant in case there is an overlap.

As a producer of events I would like to have the ability to provide an upgrade path to my consumers in case a channel is deprecated.

Attachments

Example from OpenAPI & Swagger
image

@github-actions
Copy link

github-actions bot commented May 9, 2023

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link
Member

derberg commented Jun 28, 2023

@mifriis deprecated is mentioned in a spec as additional field you can use in the AsyncAPI Schema, when describing message payload. It is not channel related.

what you need is not in place yet, as there was no interest in the community. I recommend you join asyncapi/spec#305 and for now I would close this issue. Are you ok with that?

@mifriis mifriis closed this as completed Jun 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants