search

cdevents / spec

A common specification for Continuous Delivery events
Apache License 2.0
125 stars 22 forks source link

Investigate using Microcks and asyncapi.com for docs and test automation #148

Open afrittoli opened 1 year ago

afrittoli commented 1 year ago

Following up the presentation by the Microcks team to the SIG events, there is an opportunity for use to improve our documentation automation as well as testing through functionality provided by Microcks and asyncapi.com

yada commented 1 year ago

https://www.asyncapi.com not async.io I guess ;-)

afrittoli commented 1 year ago

Thank you @yada, fixed now

derberg commented 11 months ago

do you need a hand with AsyncAPI? one of the maintainers here 👋🏼 I can hop on a call if ya need something

e-backmark-ericsson commented 11 months ago

@derberg , thanks for reaching out!

Given what was discussed on the SIG Events meeting where Microcks presented its solution and AsyncAPI, I believe one thing to start looking into would be how to formalize our Cloudevents binding specification of CDEvents, using AsyncAPI. If you'd look at https://github.com/cdevents/spec/blob/main/cloudevents-binding.md, what would a formal AsyncAPI specification of that binding look like?

e-backmark-ericsson commented 11 months ago

Also, what possibilities could AsyncAPI provide in order to generate a documentation for our JSON schemas? I understood from the meeting held with Microcks that there is a possibility to at least include example structures as part of the AsyncAPI spec, which are not actually part of the JSON schemas, to include them in a generated documentation of the spec. How would that be realized?

Would it be possible to generate something similar to a document like this https://github.com/cdevents/spec/blob/main/source-code-version-control.md from an AsyncAPI specification of the included events, for example corresponding to a JSON schema of an event like this: https://github.com/cdevents/spec/blob/main/schemas/changecreated.json ?