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

Remove references to vendor extensions in favor of extensions or x-extensions #643

Closed
earth2marsh opened this issue Apr 11, 2016 · 3 comments

Comments

@earth2marsh
Copy link
Member

During the working group 2.0 spec process, extensions were proposed to suit vendor usecases, and therefore were initially referred to as vendor extensions.

However, there are plenty of reasons to extend the spec without being a vendor, hence the name is too narrow. This proposal recommends deprecating any reference to vendor extensions in favor of extensions or x-extensions.

@IvanGoncharov
Copy link
Contributor

@earth2marsh Totally agree with you.
Moreover, it motivates vendors to create their own dialects like x-ms-*(see this).
And the same true for other vendors, see #616

Please also consider adding following recommendations:

  • to reuse existing extension
  • create more generic extensions, and provide a public specification for them.
  • add vendor namespace only if an extension is specific to this particular vendor.

@DavidBiesack
Copy link

agree dropping 'vendor' is good. (I suggest the term 'specification extensions' over x-extensions, but it's not hugely important.)

Namespaces for extension names perhaps should be addressed as a separate issue, though. Vendors or other non-vendor organizations will still likely use some x-mynamespacehere- prefix to avoid conflict. That will happen regardless of the term OAS uses (extension or vendor extension).

@fehguy
Copy link
Contributor

fehguy commented Feb 1, 2017

Fixed in #657

@fehguy fehguy closed this as completed Feb 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants