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

Generate and validate asyncapi to keep it up to date with current state #684

Open
DiamondJoseph opened this issue Oct 24, 2024 · 2 comments
Labels
cli Relates to CLI code messaging Relates to asynchronous messaging code tests Issues around increasing test coverage/fixing tests

Comments

@DiamondJoseph
Copy link
Contributor

DiamondJoseph commented Oct 24, 2024

Changes in event-model's structure due to adopting the copier template made our asyncapi invalid. Generating the asyncapi.yaml should be done as part of the build, similar to the opanapi.yaml, so that we catch any breaking changes and can ensure that the api that we publish is actually the one that we support: there have been other changes in event-model main that have not been reflected in the version of event-model that is valid for the deployment.

@DiamondJoseph DiamondJoseph added tests Issues around increasing test coverage/fixing tests cli Relates to CLI code messaging Relates to asynchronous messaging code labels Oct 24, 2024
@callumforrester
Copy link
Contributor

This was originally not done because there was no library that did it. We should also consider if we still want to make use of asyncapi as part of DiamondLightSource/messagebus#20

@DiamondJoseph
Copy link
Contributor Author

DiamondJoseph commented Oct 25, 2024

We'd still need to register our schema, and our schema uses the event-model schema.
After discussion with @coretl and @evalott100, if we point to the event-model schema we have as part of the installed version of event-model, that will match what we are emitting: and prevents us requiring github to be able to construct it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Relates to CLI code messaging Relates to asynchronous messaging code tests Issues around increasing test coverage/fixing tests
Projects
None yet
Development

No branches or pull requests

2 participants