asyncapi/spec

Confusing Operation Object Example

ctasada opened this issue · 2 comments

ctasada commented

Describe the bug

The https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#operation-object-example example describes the security field as

  "security": [
    {
     "petstore_auth": [
       "write:pets",
       "read:pets"
     ]
    }
  ],

But none of the Security Schemas match that definition. Based on the format, I may guess the correct example should be:

  "security": [
    {
     "type": "openIdConnect",
    "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
     "scopes": [
       "write:pets",
       "read:pets"
     ]
    }
  ],

Another alternative would be "type": "oauth2" but then the example would be more complex.

github-actions commented

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.

github-actions commented

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️