search

openservicebrokerapi / servicebroker

Open Service Broker API Specification
https://openservicebrokerapi.org/
Apache License 2.0
1.19k stars 433 forks source link

Do we need to update swagger.yaml to latest version? #656

Closed leonwanghui closed 5 years ago

leonwanghui commented 5 years ago

What is the problem? swagger.yaml only supports 2.13 version, and it's out of date compared to current specification.

Who does this affect? Currently I'm working for https://github.com/openservicebrokerapi/osb-checker/pull/77, and I want to leverage go-swagger tool to generate source code automatically from specification, but then I found the swagger.yaml only supports v2.13.

Do you have any proposed solutions? If there is no concern to modify swagger.yaml file, I'm willing to help update it to latest version.

Additional context Add reviewers: @mattmcneeney @fmui @jberkhahn @tinygrasshopper

mattmcneeney commented 5 years ago

Hey @leonwanghui We've been trying to keep the swagger spec in line with the spec on the master branch, but it seems like some stuff got dropped! Thanks for putting this together. I think having the master branch swagger always being aligned with the spec.md is important.

mattmcneeney commented 5 years ago

We should create a Pull Request template reminding contributors to update both the openapi and swagger docs when submitting a change.

mattmcneeney commented 5 years ago

I have added a very simple PR template to help us remember to update these files!