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

define formal media type (MIME type) for AsyncAPI Object #936

Open
tomkralidis opened this issue May 11, 2023 · 10 comments
Open

define formal media type (MIME type) for AsyncAPI Object #936

tomkralidis opened this issue May 11, 2023 · 10 comments

Comments

@tomkralidis
Copy link

In the spirit of OAI/OpenAPI-Specification#110, it would be valuable to have a similar effort here in AsyncAPI for IANA considerations (https://datatracker.ietf.org/doc/html/draft-polli-rest-api-mediatypes#name-iana-considerations).

Ref: opengeospatial/ogcapi-common#329

@github-actions
Copy link

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.

@fmvilas
Copy link
Member

fmvilas commented May 11, 2023

Awesome! Do you know what the process looks like? I honestly never did anything similar.

@tomkralidis
Copy link
Author

cc @cportele @ghobona @cmheazel on possible recommendations on IANA registration.

@github-actions
Copy link

github-actions bot commented Sep 9, 2023

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

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 ❤️

@github-actions github-actions bot added the stale label Sep 9, 2023
@tomkralidis
Copy link
Author

It looks like there is an application form at https://www.iana.org/form/media-types.

Having said this, it would be valuable to:

  1. review the application procedure
  2. determine which media types to register, example: application/vnd.aai.asyncapi+json;version=2.0 (YAML as well)?

cc @ghobona

@ghobona
Copy link

ghobona commented Sep 9, 2023

@fmvilas OGC is looking into using AsyncAPI in support of OGC API Standards. It would be helpful if the AsyncAPI Initiative either registered a media type for AsyncAPI definition documents at IANA, or specified a media type for AsyncAPI definition documents in the AsyncAPI specification.

Are you aware of any discussions, within the AsyncAPI initiative, towards specifying and registering a media type for AsyncAPI definition documents?

@cportele
Copy link

cportele commented Sep 9, 2023

Somewhat related: The IETF HTTP API WG is working on an Internet-Draft for media types for JSON Schema and OpenAPI (JSON and YAML): https://ietf-wg-httpapi.github.io/mediatypes/draft-ietf-httpapi-rest-api-mediatypes.html.

@github-actions github-actions bot removed the stale label Sep 10, 2023
Copy link

github-actions bot commented Jan 8, 2024

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

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 ❤️

@tomkralidis
Copy link
Author

At this point it looks like application/vnd.aai.asyncapi+yaml would be a suitable media type moving forward. Note that we are thinking this would be valuable for OGC API specifications (opengeospatial/ogcapi-environmental-data-retrieval#534), but decision by the AsyncAPI community would be preferred. What do you think @fmvilas?

@github-actions github-actions bot removed the stale label Apr 12, 2024
@fmvilas
Copy link
Member

fmvilas commented Apr 12, 2024

Sorry I missed lots of comments here somehow. I think application/vnd.aai.asyncapi would be good enough for now, even if unofficial. It would be awesome if could aim for application/asyncapi or text/asyncapi (not sure what would be best here) but we need someone to push this forward. Pinging @derberg as he's the executive director now and it may require some legal details in the process (honestly don't know).

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

4 participants