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.

Sign up for GitHub

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

fix(rule): update async api rule #86

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(rule): update async api rule #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...pi/rules/must-provide-api-specification-using-asyncapi-for-asyncrhonous-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ id: R200005
We use the [AsyncAPI](https://www.asyncapi.com/) specification as a standard to define contracts for asynchronous APIs.
Any event published for integration with other services must be described using the AsyncAPI specification.

The API description format used must be [AsyncAPI 2.3.0](https://v2.asyncapi.com/docs/reference/specification/v2.3.0) or newer.
We will extend it according to our needs by using [specification extensions](https://v2.asyncapi.com/docs/reference/specification/v2.3.0#specificationExtensions) in order to describe the functionality that we require.
The API description format used must be [AsyncAPI 3.0.0](https://www.asyncapi.com/docs/reference/specification/v3.0.0) or newer.
We use extensions to extend the specification to our needs by using [specification extensions](https://www.asyncapi.com/docs/reference/specification/v3.0.0#specificationExtensions) in order to describe the functionality that we require.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The extension part seems duplicated :)

Suggested change
We use extensions to extend the specification to our needs by using [specification extensions](https://www.asyncapi.com/docs/reference/specification/v3.0.0#specificationExtensions) in order to describe the functionality that we require.
We extend the specification to our needs by using [specification extensions](https://www.asyncapi.com/docs/reference/specification/v3.0.0#specificationExtensions) in order to describe the functionality that we require.


We publish the specification in [backstage](https://backstage.live.si.cloud.otto.de/startpage)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As external users might not be aware of the term "Backstage", I'd explain it. Furthermore, I was wondering if this is actually a MUST and if it is a MUST, shouldn't it rather be a dedicated rule? Currently it would be quite hard to find.

Suggested change
We publish the specification in [backstage](https://backstage.live.si.cloud.otto.de/startpage)
The specifications can be published in [our internal developer portal](https://backstage.live.si.cloud.otto.de/startpage)

Loading