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

Use of AsyncAPI in PubSub #9

Open
chris-little opened this issue Jul 19, 2023 · 1 comment
Open

Use of AsyncAPI in PubSub #9

chris-little opened this issue Jul 19, 2023 · 1 comment

Comments

@chris-little
Copy link
Collaborator

Should the use of AsyncAPI be mandated to describe the PubSub facilities?
E.g: An OGC API SHALL provide the description of its Publish-Subscribe capabilities using AsyncAPI to describe supported protocols, channels and message payload descriptions.

As far as I know, AsyncAPI can describe the various likely candidate protocols such as MQTT, AMQP, etc., so I am in favour if keeping it simple, as above.

OGC API Common Part 1: Core, clause 6.6.2 states a looser requirement for OpenAPI:-
This OGC API Standard uses OpenAPI 3.0 fragments in examples and to formally state requirements. Using OpenAPI 3.0 is not required for implementing an OGC API. Other API definition languages may be used along with, or instead of, OpenAPI. However, any API definition language used should have an associated conformance class advertised through the / conformance path. This Standard includes a conformance class for OGC API definitions that follow the OpenAPI specification 3.0. Alternative API definition languages are also allowed. Conformance classes for additional API definition languages will be added as the OGC API landscape continues to evolve.

@tomkralidis
Copy link
Contributor

Related: asyncapi/spec#936 (definition of IANA media type for AsyncAPI).

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