Skip to content

Commit

Permalink
Apiview feedback and release prep (#29844)
Browse files Browse the repository at this point in the history
* Apiview feedback and release prep

* PR feedback

* Ci fix
  • Loading branch information
rickle-msft authored Jul 7, 2022
1 parent 2ad1ca8 commit 7d5341c
Show file tree
Hide file tree
Showing 33 changed files with 109 additions and 141 deletions.
16 changes: 8 additions & 8 deletions eng/jacoco-test-coverage/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -293,17 +293,17 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
<version>12.18.0</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-batch</artifactId>
<version>12.14.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob-batch;current} -->
<version>12.14.0</version> <!-- {x-version-update;com.azure:azure-storage-blob-batch;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
Expand All @@ -313,7 +313,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-cryptography</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob-cryptography;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-blob-cryptography;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
Expand All @@ -323,22 +323,22 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-file-share</artifactId>
<version>12.14.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-file-share;current} -->
<version>12.14.0</version> <!-- {x-version-update;com.azure:azure-storage-file-share;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-file-datalake</artifactId>
<version>12.11.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-file-datalake;current} -->
<version>12.11.0</version> <!-- {x-version-update;com.azure:azure-storage-file-datalake;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-internal-avro</artifactId>
<version>12.4.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-internal-avro;current} -->
<version>12.4.0</version> <!-- {x-version-update;com.azure:azure-storage-internal-avro;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-queue</artifactId>
<version>12.14.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-queue;current} -->
<version>12.14.0</version> <!-- {x-version-update;com.azure:azure-storage-queue;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
Expand Down
16 changes: 8 additions & 8 deletions eng/versioning/version_client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,17 +136,17 @@ com.azure:azure-sdk-template-two;1.0.0-beta.1;1.0.0-beta.1
com.azure:azure-sdk-template-three;1.0.0-beta.1;1.0.0-beta.1
com.azure:azure-spring-data-cosmos;3.23.0;3.24.0-beta.1
com.azure:azure-spring-data-cosmos-test;3.0.0-beta.1;3.0.0-beta.1
com.azure:azure-storage-blob;12.17.1;12.18.0-beta.2
com.azure:azure-storage-blob-batch;12.13.1;12.14.0-beta.2
com.azure:azure-storage-blob;12.17.1;12.18.0
com.azure:azure-storage-blob-batch;12.13.1;12.14.0
com.azure:azure-storage-blob-changefeed;12.0.0-beta.18;12.0.0-beta.19
com.azure:azure-storage-blob-cryptography;12.16.1;12.17.0-beta.2
com.azure:azure-storage-blob-cryptography;12.16.1;12.17.0
com.azure:azure-storage-blob-nio;12.0.0-beta.19;12.0.0-beta.20
com.azure:azure-storage-common;12.16.1;12.17.0-beta.2
com.azure:azure-storage-file-share;12.13.1;12.14.0-beta.2
com.azure:azure-storage-file-datalake;12.10.1;12.11.0-beta.2
com.azure:azure-storage-internal-avro;12.3.1;12.4.0-beta.2
com.azure:azure-storage-common;12.16.1;12.17.0
com.azure:azure-storage-file-share;12.13.1;12.14.0
com.azure:azure-storage-file-datalake;12.10.1;12.11.0
com.azure:azure-storage-internal-avro;12.3.1;12.4.0
com.azure:azure-storage-perf;1.0.0-beta.1;1.0.0-beta.1
com.azure:azure-storage-queue;12.13.1;12.14.0-beta.2
com.azure:azure-storage-queue;12.13.1;12.14.0
com.azure:azure-template-perf;1.0.0-beta.1;1.0.0-beta.1
com.azure:azure-media-videoanalyzer-edge;1.0.0-beta.6;1.0.0-beta.7
com.azure:azure-verticals-agrifood-farming;1.0.0-beta.2;1.0.0-beta.3
Expand Down
9 changes: 2 additions & 7 deletions sdk/storage/azure-storage-blob-batch/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Release History

## 12.14.0-beta.2 (Unreleased)
## 12.14.0 (2022-07-07)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes
- 2021-08-06 service version.

## 12.14.0-beta.1 (2022-06-15)

Expand Down
2 changes: 1 addition & 1 deletion sdk/storage/azure-storage-blob-batch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ add the direct dependency to your project as follows.
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-batch</artifactId>
<version>12.14.0-beta.1</version>
<version>12.14.0</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand Down
6 changes: 3 additions & 3 deletions sdk/storage/azure-storage-blob-batch/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-batch</artifactId>
<version>12.14.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob-batch;current} -->
<version>12.14.0</version> <!-- {x-version-update;com.azure:azure-storage-blob-batch;current} -->

<name>Microsoft Azure client library for Blob Storage batching</name>
<description>This module contains client library for Microsoft Azure Blob Storage batching.</description>
Expand Down Expand Up @@ -79,7 +79,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
<version>12.18.0</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
</dependency>

<!-- Added this dependency to include necessary annotations used by reactor core.
Expand All @@ -95,7 +95,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<classifier>tests</classifier>
<type>test-jar</type>
<scope>test</scope>
Expand Down
1 change: 1 addition & 0 deletions sdk/storage/azure-storage-blob-changefeed/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## 12.0.0-beta.19 (Unreleased)

### Features Added
- GA release for STG 83

### Breaking Changes

Expand Down
4 changes: 2 additions & 2 deletions sdk/storage/azure-storage-blob-changefeed/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
<version>12.18.0</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
</dependency>

<!-- Added this dependency to include necessary annotations used by reactor core.
Expand All @@ -101,7 +101,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<classifier>tests</classifier>
<type>test-jar</type>
<scope>test</scope>
Expand Down
10 changes: 3 additions & 7 deletions sdk/storage/azure-storage-blob-cryptography/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Release History

## 12.17.0-beta.2 (Unreleased)
## 12.17.0 (2022-07-07)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes
- GA release for 2021-08-06 service version.
- GA release for encryption protocol version 2.

## 12.17.0-beta.1 (2022-06-15)

Expand Down
2 changes: 1 addition & 1 deletion sdk/storage/azure-storage-blob-cryptography/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ add the direct dependency to your project as follows.
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-cryptography</artifactId>
<version>12.17.0-beta.1</version>
<version>12.17.0</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand Down
6 changes: 3 additions & 3 deletions sdk/storage/azure-storage-blob-cryptography/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-cryptography</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob-cryptography;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-blob-cryptography;current} -->

<name>Microsoft Azure client library for Blob Storage cryptography</name>
<description>This module contains client library for Microsoft Azure Blob Storage cryptography.</description>
Expand Down Expand Up @@ -64,12 +64,12 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
<version>12.18.0</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<classifier>tests</classifier>
<type>test-jar</type>
<scope>test</scope>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -408,12 +408,12 @@ public Response<BlobProperties> downloadToFileWithResponse(BlobDownloadToFileOpt
}

@Override
public final BlobInputStream openInputStream() {
public BlobInputStream openInputStream() {
return openInputStream((BlobRange) null, null);
}

@Override
public final BlobInputStream openInputStream(BlobRange range, BlobRequestConditions requestConditions) {
public BlobInputStream openInputStream(BlobRange range, BlobRequestConditions requestConditions) {
return openInputStream(new BlobInputStreamOptions().setRange(range).setRequestConditions(requestConditions));
}

Expand All @@ -422,7 +422,8 @@ public BlobInputStream openInputStream(BlobInputStreamOptions options) {
return openInputStream(options, null);
}

protected BlobInputStream openInputStream(BlobInputStreamOptions options, Context context) {
@Override
public BlobInputStream openInputStream(BlobInputStreamOptions options, Context context) {
context = context == null ? Context.NONE : context;
options.setRequestConditions(options.getRequestConditions() == null ? new BlobRequestConditions()
: options.getRequestConditions());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
requires transitive com.azure.storage.blob;

requires com.fasterxml.jackson.dataformat.xml;
requires com.azure.core;

exports com.azure.storage.blob.specialized.cryptography;

Expand Down
4 changes: 2 additions & 2 deletions sdk/storage/azure-storage-blob-nio/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
<version>12.18.0</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<classifier>tests</classifier>
<type>test-jar</type>
<scope>test</scope>
Expand Down
63 changes: 32 additions & 31 deletions sdk/storage/azure-storage-blob/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Release History

## 12.18.0-beta.2 (Unreleased)
## 12.18.0 (2022-07-07)

### Features Added
- BlobOutputStream.close() will now attempt to close the stream at first attempt. Subsequent calls to close have no effect.
- GA release for 2021-08-06 service version.

## 12.18.0-beta.1 (2022-06-15)

Expand Down Expand Up @@ -313,6 +314,36 @@ and
- Added overloads to BlockBlobClient.getBlobOutputStream to allow users to provide parallel transfer options, http headers, metadata, access tier, and request conditions.


## 11.1.1 (2019.04.30)
- Upgraded to version 2.1.1 of the autorest-clientime which upgrades to a more secure version of jackson and fixes a NPE on unkown host errors.

## 11.0.0 (2019.03.22)
- Upgraded to version 2.1.0 of the autorest-clientruntime which includes several important fixes to mitigate a commonly-seen "Connection reset by peer" error and other similar bugs.
- Support for 2018-11-09 REST version. Please see our REST API documentation and blogs for information about the related added features.
- Added appendBlockFromURL method. A block may be created with another blob as its source.
- Added uploadPagesFromURL method. Pages may be written to with another blob as their source.
- Fixed a bug that would set an invalid range header when downloading an empty blob.
- Modified the LoggingFactory to redact SAS signatures on outgoing requests.
- HTTPGetterInfo was made an internal type as it is an internal implementation detail.
- Removed DEFAULT and NONE static variables. Empty constructors should be used instead. DEFAULT static values were error prone and unsafe to use because although the field was final, the objects were mutable, so it was possible the value could be changed accidentally and alter the behavior of the program.
- Optimized the TransferManager download to file method to skip the initial HEAD request.
- Added an option to configure that maximum size data that will be uploaded in a single shot via the TransferManager.
- Added request Http Method, URL, and headers to logging messages.
- Changed *ListingDetails to *ListDetails. These name changes are to mitigate conflicts with v8, allowing for side-by-side loading of different versions, which may help with upgrading.
- Removed the extra quotes around etags in some responses so they are consistently now consistently formatted.
- Moved the Generated*** types into the blob package to avoid conflicts with generated types from other services (i.e. queues and files)
- Changed the logger name to be the name of class that uses it, which is a more conventional practice
- Support added for SAS tokens to scope to blob snapshot.
- Added getUserDelegationKey to ServiceURL, the result of which can be used to generate a user-delegation SAS.
- Made the max results field on listing responses Integer instead of int as it is an optional field only returned when specified in the request.

## 10.5.0 (2019.02.15)
- Added uploadFromNonReplayableFlowable to support uploading arbitrary data sources (like network streams) to a block blob.

## 10.4.0 (2019.01.11)
- Fixed a bug that caused errors when java.io.tempdir has no trailing separator.
- Upgrade autorest-clientruntime dependency to include some bug fixes.

## 12.2.0-beta.1 (2019-12-17)
- Added SAS generation methods on clients to improve discoverability and convenience of sas. Deprecated setContainerName, setBlobName, setSnapshotId, generateSasQueryParameters methods on BlobServiceSasSignatureValues to direct users to using the methods added on clients.
- Fixed a bug where Account SAS would not work when set on clients.
Expand Down Expand Up @@ -450,36 +481,6 @@ For details on the Azure SDK for Java (July 2019 Preview) release, you can refer
- Client and pipeline configuration is now available via keyword arguments at both the client level.
- Authentication using `azure-identity` credentials.

## 11.1.1 (2019.04.30)
- Upgraded to version 2.1.1 of the autorest-clientime which upgrades to a more secure version of jackson and fixes a NPE on unkown host errors.

## 11.0.0 (2019.03.22)
- Upgraded to version 2.1.0 of the autorest-clientruntime which includes several important fixes to mitigate a commonly-seen "Connection reset by peer" error and other similar bugs.
- Support for 2018-11-09 REST version. Please see our REST API documentation and blogs for information about the related added features.
- Added appendBlockFromURL method. A block may be created with another blob as its source.
- Added uploadPagesFromURL method. Pages may be written to with another blob as their source.
- Fixed a bug that would set an invalid range header when downloading an empty blob.
- Modified the LoggingFactory to redact SAS signatures on outgoing requests.
- HTTPGetterInfo was made an internal type as it is an internal implementation detail.
- Removed DEFAULT and NONE static variables. Empty constructors should be used instead. DEFAULT static values were error prone and unsafe to use because although the field was final, the objects were mutable, so it was possible the value could be changed accidentally and alter the behavior of the program.
- Optimized the TransferManager download to file method to skip the initial HEAD request.
- Added an option to configure that maximum size data that will be uploaded in a single shot via the TransferManager.
- Added request Http Method, URL, and headers to logging messages.
- Changed *ListingDetails to *ListDetails. These name changes are to mitigate conflicts with v8, allowing for side-by-side loading of different versions, which may help with upgrading.
- Removed the extra quotes around etags in some responses so they are consistently now consistently formatted.
- Moved the Generated*** types into the blob package to avoid conflicts with generated types from other services (i.e. queues and files)
- Changed the logger name to be the name of class that uses it, which is a more conventional practice
- Support added for SAS tokens to scope to blob snapshot.
- Added getUserDelegationKey to ServiceURL, the result of which can be used to generate a user-delegation SAS.
- Made the max results field on listing responses Integer instead of int as it is an optional field only returned when specified in the request.

## 10.5.0 (2019.02.15)
- Added uploadFromNonReplayableFlowable to support uploading arbitrary data sources (like network streams) to a block blob.

## 10.4.0 (2019.01.11)
- Fixed a bug that caused errors when java.io.tempdir has no trailing separator.
- Upgrade autorest-clientruntime dependency to include some bug fixes.

## 10.3.0 (2018.11.19)
- Added support for SLF4J.
- Included default logging to log warnings and errors to the temp directory by default.
Expand Down
2 changes: 1 addition & 1 deletion sdk/storage/azure-storage-blob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ add the direct dependency to your project as follows.
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.1</version>
<version>12.18.0</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand Down
8 changes: 4 additions & 4 deletions sdk/storage/azure-storage-blob/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.18.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->
<version>12.18.0</version> <!-- {x-version-update;com.azure:azure-storage-blob;current} -->

<name>Microsoft Azure client library for Blob Storage</name>
<description>This module contains client library for Microsoft Azure Blob Storage.</description>
Expand Down Expand Up @@ -86,12 +86,12 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-internal-avro</artifactId>
<version>12.4.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-internal-avro;current} -->
<version>12.4.0</version> <!-- {x-version-update;com.azure:azure-storage-internal-avro;current} -->
</dependency>

<!-- Added this dependency to include necessary annotations used by reactor core.
Expand All @@ -106,7 +106,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.17.0-beta.2</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<version>12.17.0</version> <!-- {x-version-update;com.azure:azure-storage-common;current} -->
<classifier>tests</classifier>
<type>test-jar</type>
<scope>test</scope>
Expand Down
Loading

0 comments on commit 7d5341c

Please sign in to comment.