spec icon indicating copy to clipboard operation
spec copied to clipboard

fix: allow reusability of Server Variable Objects

Open char0n opened this issue 2 years ago • 9 comments

Refs #775

char0n avatar May 03 '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 03 '22 08:05 sonarqubecloud[bot]

Answering your comment in the #775 issue:

I've issued a https://github.com/asyncapi/spec/pull/776 that remedies the situation and would probably suggest to go for 2.4.1 as soon as possible.

Yeah, I think it's a pretty good use case for a patch version.

fmvilas avatar May 05 '22 10:05 fmvilas

/dnm

fmvilas avatar May 05 '22 10:05 fmvilas

Do we really have to do 2.4.1? In my opinion, it's more of an oversight and that doesn't change the structure of the specification at all. When OpenAPI 3.1.0 came out, people were still making small improvements to the spec without releasing 3.1.1.

magicmatatjahu avatar May 05 '22 11:05 magicmatatjahu

Do we really have to do 2.4.1? In my opinion

No, it's not really necessary, I've just suggested it given the quick cadence of release process for the spec.

it's more of an oversight and that doesn't change the structure of the specification at all.

IMHO it does change the capabilities of the specification; strictly speaking it extends the capabilities, so feat would be more appropriate, but given the context and the fact that this is oversight I went with fix.

When OpenAPI 3.1.0 came out, people were still making small improvements to the spec without releasing 3.1.1.

Not sure this is correct observation (but I might be mistaken). OAS is considered immutable and the last commit to the 3.1.0 version is actually the release commit. No commits after that.

Commit history for the 3.1.0 spec: https://github.com/OAI/OpenAPI-Specification/commits/main/versions/3.1.0.md

char0n avatar May 05 '22 11:05 char0n

For me it looks also good. Thanks @char0n for extending the idea of reusability.

danielkocot avatar May 05 '22 12:05 danielkocot

The spec is defined in this repository, and not in the json schema definitions (those are supporting the spec, not defining them IMHO)

This has come up multiple times already during different conversations. What is actually the source of truth? I've created an issue to track this unclarity and the PR that tries to remedy it. IMHO the source of truth is always the makrdown specification.

char0n avatar May 05 '22 13:05 char0n

releasing a patch doesn't hurt 😄 we just merge and it magically happens 😄

all good on JSON Schema side?

All good as $ref is allowed as additional property: https://github.com/asyncapi/spec-json-schemas/blob/master/schemas/2.4.0.json#L209-L213

smoya avatar May 09 '22 16:05 smoya

@dalelane ~@fmvilas~ your review is needed here. Thanks!

smoya avatar Jul 07 '22 10:07 smoya

Given we've discontinued effort with 2.4.1 release and are going directly for 2.5.0, this PR needs to be send against next-spec and the title needs to changeto feat: allow re-usability of Server Variable Objects

char0n avatar Sep 13 '22 10:09 char0n

@char0n yup, I think you should be able to change the base branch

derberg avatar Sep 13 '22 20:09 derberg

Right, I'll do it right after https://github.com/asyncapi/spec/pull/831 is merged. I guess it would require re-review of all code owners.

char0n avatar Sep 14 '22 13:09 char0n

Base branch changed for next-spec.

char0n avatar Sep 15 '22 07:09 char0n

/ready-to-merge

char0n avatar Sep 15 '22 07:09 char0n

Changed title from fix: allow re-usability of Server Variable Objects to feat: allow re-usability of Server Variable Objects. Can I ask somebody to to remove do-not-merge label or merge this PR? Thanks!

char0n avatar Sep 15 '22 07:09 char0n

/rtm

derberg avatar Sep 15 '22 09:09 derberg

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

The release is available on GitHub release

Your semantic-release bot :package::rocket:

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