asyncapi / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
https://asyncapi.com/docs/tools/generator
Apache License 2.0
772 stars 235 forks source link

Support for application/cloudevents+json #976

Closed murari-goswami closed 4 months ago

murari-goswami commented 1 year ago

I am using AsyncAPI in conjunction with cloudevents. For this the default content type as for media I chose as "application/cloudevents+json" as per the official cloudevent spec https://github.com/cloudevents/spec/blob/main/cloudevents/formats/json-format.md. Accordingly, I use defaultContentType: application/cloudevents+json in the AsyncAPI specification. All good until here. Later in the process when we generate markdown from the api spec, the AsyncAPI markdown generator puts hyperlink for "application/cloudevents+json" as https://www.iana.org/assignments/media-types/application/cloudevents+json. Where as iana has no valid "application/cloudevents+json" as media type yet. Can anyone help me here how can "application/cloudevents+json" is registered in iana. Alternatively, can the hyperlink generator from markdown converter be suppressed for this broken link ?

github-actions[bot] commented 1 year ago

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.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] commented 9 months ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

AnimeshKumar923 commented 9 months ago

is this still valid? @derberg

github-actions[bot] commented 5 months ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

lmgyuan commented 4 months ago

@derberg Do you think this is still valid?

derberg commented 4 months ago

we can't really help much in generator. on IANA side and cloudevents mime type - this is not in our scope really.

and regarding markdown template - we need an issue and some idea how we could disable linking to iana -> https://github.com/search?q=repo%3Aasyncapi%2Fmarkdown-template%20iana&type=code - in markdown-template repo

easiest would be to probably add some parameter to disable linking to iana - PR would be appriciated 🙏🏼

closing it here