changelog has not been updated for two versions

Question

changelog has not been updated for two versions

Closed this issue 8 years ago · 9 comments

The broker API changelog was introduced to provide documentation to broker authors about when new versions were introduced, what changed in each version (this is also documented in the version specific docs), and what changes were made to the docs that did not impact the api spec. For example, we used to get questions that made us realize our docs were wrong, or required clarification. If a broker author revisits the docs and sees that the content has changed without a version bump, the changelog explains that this change occurred.

The last entry in the changelog is 2015-11-08, when 2.8 of the spec was released. There have been two versions since then. It appears the changelog is not being maintained. I would suggest CAPI commit to keeping it updated, add an entry declaring deprecation, or remove it.

Answer 1 · 2016-08-18T17:48:16.000Z

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/128596865

The labels on this github issue will be updated when the story is started.

Answer 2 · 2016-08-18T18:41:56.000Z

Thanks @shalako, we have been updating each Changes Since, wasn't aware of this other page. We'll fix.

Answer 3 · 2016-09-06T21:55:01.000Z

Hello @shalako,

I submitted a pull request to update the change log. When you feel that your issue has been resolved, please go ahead and close it.

Thanks for bringing this to our attention!

@youreddy
CF CAPI TEAM

Answer 4 · 2016-09-09T17:02:29.000Z

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/130110417

The labels on this github issue will be updated when the story is started.

Answer 5 · 2016-09-09T17:05:44.000Z

@shalako See staging link: http://docs-cloudfoundry-staging.cfapps.io/services/v2-api-changelog.html. Will be live next prod push.

Answer 6 · 2016-09-09T17:08:49.000Z

Please clarify the changelog entry made for 2.9 on 2016-06-14. Quite confusing.

Looking at the API, I might suggest:

Last operation endpoint now supports service_id and plan_id as request parameters
Brokers may now optionally return operation field in responses for Provision, Update, and Deprovision. Broker clients may provide this same object as a request parameter when polling Last operation.

Answer 7 · 2016-09-09T17:39:50.000Z

Please see the latest edits: http://docs-cloudfoundry-staging.cfapps.io/services/v2-api-changelog.html

Answer 8 · 2016-09-12T20:04:09.000Z

Much better, thanks

Answer 9 · 2016-09-12T22:46:15.000Z

Great, thanks @shalako. Closing.