search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.64k stars 5.08k forks source link

Semver-style Changelogs for Resource Provider Swagger Definitions #7558

Open tombuildsstuff opened 5 years ago

tombuildsstuff commented 5 years ago

This was previously requested in #1770 - but the issue was closed without being resolved - as such would it be possible to start putting together Changelog's for each Resource Provider? These could then be collated into the Azure SDK's at release time. As a consumer - I'd started looking for this in both the Resource Provider folder or in the folder containing the API versions (but didn't see it in either).

More details can be found in #1770 - but generally speaking we're looking for something like this:

# Compute API

## Version 2019-01-01:

NEW FEATURES:

* Virtual Machines: support for toggling on/off Disk Encryption
* Disks: Support for super-fast disks

CHANGES:

* Virtual Machines: the Delete API now requires that Virtual Machines must be shut down prior to the Delete API being called

DEPRECATIONS:

* Virtual Machines: Unmanaged Disks are now deprecated

Thanks!

fengzhou-msft commented 5 years ago

Thanks for submitting this issue. We will dicuss about the work.

fengzhou-msft commented 4 years ago

@akning-ms can you take a look at this feature request and evaluate?

tombuildsstuff commented 4 years ago

ping @akning-ms (cc @vladbarosan fyi)

akning-ms commented 4 years ago

Hi @tombuildsstuff sorry for reply late, Looks I missed last ping from @fengzhou-msft. add our PM @mozehgir . awareness and decide

mozehgir commented 4 years ago

Hey @tombuildsstuff - we are currently investigating the feasibility and implementation of this. Will post more details here after.