Swagger–OpenAPI supports vendor extensions using an x- prefix on property names. Kin Lane has put up a page with vendor extensions here:
http://definitions.apievangelist.com/openapi-spec/extensions/
Vendor extensions only work at the instance document level, not at the specification level. There's no standard way to specify a vendor extension as a JSON schema.
But it shouldn't be very hard to define convention for modeling and documenting these extensions. The main part of the definition would be a set of JSON Schema definitions, with embedded descriptions to document the semantics and behavior. The convention should also have a way to specify the context(s) in which each extended property could be used.
With these bits of information, it should be possible to weave together a composite schema that includes the Swagger base schema + vendor extensions. SwagEdit could then offer code assist and validation, including vendor extensions.
This would also need a way to register vendor extensions, so SwagEdit is aware of which extensions it needs to include. This can be incorporated into the Preferences for SwagEdit.
Swagger–OpenAPI supports vendor extensions using an
x-prefix on property names. Kin Lane has put up a page with vendor extensions here:http://definitions.apievangelist.com/openapi-spec/extensions/
Vendor extensions only work at the instance document level, not at the specification level. There's no standard way to specify a vendor extension as a JSON schema.
But it shouldn't be very hard to define convention for modeling and documenting these extensions. The main part of the definition would be a set of JSON Schema definitions, with embedded descriptions to document the semantics and behavior. The convention should also have a way to specify the context(s) in which each extended property could be used.
With these bits of information, it should be possible to weave together a composite schema that includes the Swagger base schema + vendor extensions. SwagEdit could then offer code assist and validation, including vendor extensions.
This would also need a way to register vendor extensions, so SwagEdit is aware of which extensions it needs to include. This can be incorporated into the Preferences for SwagEdit.