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

Invalid Operation References in Example Snippets #619

Closed
balogal opened this issue Sep 9, 2021 · 5 comments · Fixed by #620
Closed

Invalid Operation References in Example Snippets #619

balogal opened this issue Sep 9, 2021 · 5 comments · Fixed by #620
Labels

Comments

@balogal
Copy link
Contributor

balogal commented Sep 9, 2021

Hi all,

both v2.1.0 and v2.0.0 of the specification document contain a couple of invalid example snippets. It's always the following snippet or a slight variation of it:

user/signedup:
  subscribe:
    $ref: "#/components/messages/userSignUp"

This is not valid according to the JSON schema and the specification itself since no reference object may be used in place of an Operation object. Let alone a reference to a Message object.

The snippet appears in the following sections:

@github-actions
Copy link

github-actions bot commented Sep 9, 2021

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.

Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@fmvilas
Copy link
Member

fmvilas commented Sep 15, 2021

Good catch @balogal. Would you be open to submitting a PR?

@balogal
Copy link
Contributor Author

balogal commented Sep 15, 2021

Hi @fmvilas, there's already a PR opened alongside this issue.

@fmvilas
Copy link
Member

fmvilas commented Sep 15, 2021

Oh sorry, my bad. Thanks a lot 🙏 Left comments in the PR.

@smoya smoya linked a pull request Oct 8, 2021 that will close this issue
@smoya
Copy link
Member

smoya commented Oct 8, 2021

Fixed by #620

@smoya smoya closed this as completed Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants