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

Fix description of Operation Trait object #994

Closed
smoya opened this issue Nov 22, 2023 · 5 comments · Fixed by #1001
Closed

Fix description of Operation Trait object #994

smoya opened this issue Nov 22, 2023 · 5 comments · Fixed by #1001
Labels
🤷‍♀️ Ambiguity An issue/PR which identifies or fixes spec ambiguity good first issue

Comments

@smoya
Copy link
Member

smoya commented Nov 22, 2023

The following sentence located in the description of the Operation Trait object is wrong:

This object MAY contain any property from the Operation Object, except the action, channel and traits ones.

Source: https://www.asyncapi.com/docs/reference/specification/v3.0.0-next-major-spec.16#operationTraitObject

If you take a look at the fields an Operation Trait object has, messages field is not included.

Google Chrome_QsRekblp@2x

You can confirm this is by design and expected by checking its corresponding JSON Schema definition at https://github.com/asyncapi/spec-json-schemas/blob/next-major-spec/definitions/3.0.0/operationTrait.json.

We should fix that sentence.

Originally posted by @smoya in #991 (comment)

@HassanBahati
Copy link

hi @smoya , i am interested in working on this issue.

is the requirement to add messages to the operationTrait.json

something like;

    "messages": {
      "description": "A short summary of what the messages for this operation.",
      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/messages"
    },

@smoya
Copy link
Member Author

smoya commented Dec 6, 2023

hi @smoya , i am interested in working on this issue.

is the requirement to add messages to the operationTrait.json

something like;

    "messages": {
      "description": "A short summary of what the messages for this operation.",
      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/messages"
    },

No. We just should include the field messages in the list of exclusions mentioned in the specification. Something like:

This object MAY contain any property from the Operation Object, except the action, channel, messages, and traits ones.

@HassanBahati
Copy link

oh okay..thank you @smoya for the clarity....i do see an open pr #1001 by @akkshitgupta ...please do have a look at it

@sami-mahmodi
Copy link

Hi @smoya I am interested working on this issue. I think we just missing a "messages" word in Operationtrait.json file in descriptioon field.

@smoya
Copy link
Member Author

smoya commented Dec 19, 2023

Hi @smoya I am interested working on this issue. I think we just missing a "messages" word in Operationtrait.json file in descriptioon field.

There is already a PR #1001

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤷‍♀️ Ambiguity An issue/PR which identifies or fixes spec ambiguity good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants