Make Server Variables Object available as reusable objects under the Component object

[danielkocot]

Hello everybody,

it is just an idea that came to my mind when I started to write a new post about AsyncAPI in reference to the releases 2.2.0 and 2.3.0. In my example I'm using two servers description for staging and production. Both of them have the same variable in reference to the port of the server.
So I thought it would be good to make Server Variables Objects available as reusable objects under the Component Object.

But let's discuss about it.

Best,
Daniel

[github-actions]

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.

[magicmatatjahu]

@danielkocot Hi! We don't have Variable(s) Object but Variable Object, I think that you have in mind that second :)

However, a similar idea has been floating around in my head for a few days now 😅 You can define reusable Channel's Parameters in the Components Object, so you should be able to define Server Variable as well. However, I wonder if we can "unify" Server Variable and Channel Parameter to the one Spec Object and reuse it across Channels and Servers. I created some months ago similar issue #583 but related to the inconsistencies of schemas in server.variables and channel.parameters. Atm only problem I see is related to the location in the single Parameter Object, so we have to think how to handle that location because in Server Variable we don't have such a field. schema and description we can still unify, but not that location.

[danielkocot]

Yeah, @magicmatatjahu. You're right! Thanks for spotting me to the issue you created and I saw that it is set for the roadmap of the 3.0.0. release. Maybe we can work together on a pull request get the ideas we have in a more clear direction. What do you think?

[magicmatatjahu]

Maybe we can work together on a pull request get the ideas we have in a more clear direction. What do you think?

We can, no problem :) Of course we can also go with direction that first we will add possibility to declare that Server Variable in the components section (in the 2.4.0 version of spec) and in the 3.0.0 we will introduce unified Spec Object for both Parameter and Server Variable :) Merge of Server Variable and Parameter will introduce braking change, so we need wait for that for 3.0.0.

For me, we can go with that new field in the components section and in next major version simplify it. cc @derberg @fmvilas @jonaslagoni @smoya

[fmvilas]

Yup, always in favor of more and better reusability 👍

[danielkocot]

Related PR #717

[smoya]

All PRs have been aproved. Would you mind @derberg @fmvilas or @dalelane mark this as RFC Stage 3 (Accepted) and merge (at least the spec one)?

• feat: added server variable object as reusable object #717
• feat: make server variables reuseable spec-json-schemas#174
• feat: add methods and tests for serverVariables parser-js#476

[derberg]

yup, all seems to be there, there is only a merge conflict in one of the PRs

[smoya]

This issue can be now closed as it got merged and released. @danielkocot