spec icon indicating copy to clipboard operation
spec copied to clipboard

Published 20 hours ago • verified publisher icon asyncapi

docs: clarify the resolution rules of Channel Item `$ref` field

Open char0n opened this issue 2 years ago • 6 comments

Refs #612

char0n avatar May 04 '22 08:05 char0n

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

sonarqubecloud[bot] avatar May 04 '22 08:05 sonarqubecloud[bot]

I think this PR can be removed in favor of #777?

fmvilas avatar May 05 '22 11:05 fmvilas

@fmvilas this change is for 2.x branch, the #777 is for 3.x branch. Assuming we don't know exactly how soon the 2.x branch of the spec goes away and it will clarify for 2.x consumers what the resolutions rules are.

char0n avatar May 05 '22 11:05 char0n

is it really needed? taking into account that the field is anyway deprecated, which means "do not use it"

derberg avatar May 10 '22 09:05 derberg

@derberg it's up to you to decide. I can only provide reasons why it would be maybe appropriate:

The only reason I created the PR is that I work on tooling implementation and I needed to implement resolution mechanism for this. I made an assumption that resolution here adheres to JSON Reference spec. This was not clear from the specification for me. Even though we say "do not use it" the mechanism is there and it should be crystal clear how it works, even though it's deprecated.

This doesn't change the specification in any way, it just clarifies something that is currently up to implement-or interpretation.

char0n avatar May 10 '22 12:05 char0n

@fmvilas this change is for 2.x branch, the #777 is for 3.x branch. Assuming we don't know exactly how soon the 2.x branch of the spec goes away and it will clarify for 2.x consumers what the resolutions rules are.

Sorry for the confusion, @char0n. You're right.

fmvilas avatar Jun 09 '22 10:06 fmvilas

@derberg @dalelane can I ask you to look into this PR? Thanks!

char0n avatar Sep 06 '22 12:09 char0n

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

sonarqubecloud[bot] avatar Sep 07 '22 13:09 sonarqubecloud[bot]

/rtm

derberg avatar Sep 07 '22 13:09 derberg

:tada: This PR is included in version 2.5.0-next-major-spec.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

asyncapi-bot avatar Sep 22 '22 13:09 asyncapi-bot

Forget about the last comment saying it was released in version 2.5.0-next-major-spec.1. I made a mistake and it created this version but it should actually be 3.0.0-next-major-spec.1. There's a notice in the release. Apologies for the noise.

fmvilas avatar Sep 22 '22 14:09 fmvilas

:tada: This PR is included in version 2.5.0-next-spec.5 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

asyncapi-bot avatar Jan 31 '23 09:01 asyncapi-bot

Recent comments about the release from the bot were added by mistake. More details in https://github.com/asyncapi/spec/issues/899

derberg avatar Jan 31 '23 10:01 derberg