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

Advertising JSON-encoded AsyncAPI definition documents in PubSub enabled OGC API landing pages #329

Open
ghobona opened this issue May 11, 2023 · 2 comments
Labels
2023-04 Sprint Part 1 Applicable to Part 1 Core

Comments

@ghobona
Copy link
Contributor

ghobona commented May 11, 2023

One of the observations made at the April 2023 code sprint was that there is a need to identify a media type for AsyncAPI.

Consider the following fragment from the links in a landing page, for instance. The only way to distinguish between links to the OpenAPI and AsyncAPI definition documents is through the type property. The media type application/json however is too general and would likely need disambiguation in the future if another JSON-encoded API definition language came along. Is anyone aware of alternative options for media types for representing AsyncAPI definition documents?

        {
            "rel": "service-desc",
            "type": "application/vnd.oai.openapi+json;version=3.0",
            "title": "The OpenAPI definition as JSON",
            "href": "http://localhost:5000/openapi"
        },
        {
            "rel": "service-desc",
            "type": "application/json",
            "title": "AsyncAPI document in JSON",
            "href": "http://localhost:5000/asyncapi"
        }, 
@ghobona
Copy link
Contributor Author

ghobona commented May 11, 2023

Cc: @tomkralidis @jerstlouis @cportele

@tomkralidis
Copy link

FYI issued raised in asyncapi/spec#936

@jerstlouis jerstlouis added the Part 1 Applicable to Part 1 Core label Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2023-04 Sprint Part 1 Applicable to Part 1 Core
Projects
None yet
Development

No branches or pull requests

3 participants