search

opengeospatial / ogcapi-common

OGC API - Common provides those elements shared by most or all of the OGC API standards to ensure consistency across the family.
https://ogcapi.ogc.org/common
Other
46 stars 14 forks source link

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

Open ghobona opened 1 year ago

ghobona commented 1 year ago

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 commented 1 year ago

Cc: @tomkralidis @jerstlouis @cportele

tomkralidis commented 1 year ago

FYI issued raised in https://github.com/asyncapi/spec/issues/936