Add REST API Documentation Links #4557
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -108,6 +108,9 @@ public URL getQueueUrl() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.create} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4">Azure Docs</a>.</p> | ||
| * | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If a queue with the same name already exists in the queue service. | ||
| */ | ||
|
|
@@ -124,6 +127,9 @@ public Mono<VoidResponse> create() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.create#map} | ||
| * | ||
| * <p>For more information, see the | ||
|
There was a problem hiding this comment. Adding Rest docs link in javadocs, There was a problem hiding this comment. This isn't a guideline for Track 2 SDKs, more of a nice to have feature given the depth of complexity in some of the Storage REST APIs. Additionally, Blobs has REST API doc links in previous versions and in Preview 1, so it is being consistent with it. There was a problem hiding this comment. @g2vinay in general, changes to our rest surface are only additive, and each parameter that was an addition at some point in time has a minimum version prominent in the description. If there is ever a breaking change to our rest surface, it is handled on a case by case basis. However, we don't diverge documentation pages. I would be impressed if one of these links became obsolete or problematic. There was a problem hiding this comment. Huh. So I'm looking into our links a bit more. It seems that we may break links, but I'm having trouble finding a scenario where we would direct you to the wrong one. |
||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4">Azure Docs</a>.</p> | ||
| * | ||
| * @param metadata Metadata to associate with the queue | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If a queue with the same name and different metadata already exists in the queue service. | ||
|
|
@@ -142,6 +148,9 @@ public Mono<VoidResponse> create(Map<String, String> metadata) { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.delete} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3">Azure Docs</a>.</p> | ||
| * | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the queue doesn't exist | ||
| */ | ||
|
|
@@ -159,6 +168,9 @@ public Mono<VoidResponse> delete() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.getProperties} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata">Azure Docs</a>.</p> | ||
| * | ||
| * @return A response containing a {@link QueueProperties} value which contains the metadata and approximate | ||
| * messages count of the queue. | ||
| * @throws StorageErrorException If the queue doesn't exist | ||
|
|
@@ -183,6 +195,9 @@ public Mono<Response<QueueProperties>> getProperties() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.clearMetadata#map} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata">Azure Docs</a>.</p> | ||
| * | ||
| * @param metadata Metadata to set on the queue | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the queue doesn't exist | ||
|
|
@@ -201,6 +216,9 @@ public Mono<VoidResponse> setMetadata(Map<String, String> metadata) { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.getAccessPolicy} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl">Azure Docs</a>.</p> | ||
| * | ||
| * @return The stored access policies specified on the queue. | ||
| * @throws StorageErrorException If the queue doesn't exist | ||
| */ | ||
|
|
@@ -218,6 +236,9 @@ public Flux<SignedIdentifier> getAccessPolicy() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.setAccessPolicy} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl">Azure Docs</a>.</p> | ||
| * | ||
| * @param permissions Access policies to set on the queue | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the queue doesn't exist, a stored access policy doesn't have all fields filled out, | ||
|
|
@@ -237,6 +258,9 @@ public Mono<VoidResponse> setAccessPolicy(List<SignedIdentifier> permissions) { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.clearMessages} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages">Azure Docs</a>.</p> | ||
| * | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the queue doesn't exist | ||
| */ | ||
|
|
@@ -254,6 +278,9 @@ public Mono<VoidResponse> clearMessages() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.enqueueMessage#string} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/put-message">Azure Docs</a>.</p> | ||
| * | ||
| * @param messageText Message text | ||
| * @return A {@link EnqueuedMessage} value that contains the {@link EnqueuedMessage#messageId() messageId} and | ||
| * {@link EnqueuedMessage#popReceipt() popReceipt} that are used to interact with the message and other metadata | ||
|
|
@@ -277,6 +304,9 @@ public Mono<Response<EnqueuedMessage>> enqueueMessage(String messageText) { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.enqueueMessageLiveTime#string-duration-duration} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/put-message">Azure Docs</a>.</p> | ||
| * | ||
| * @param messageText Message text | ||
| * @param visibilityTimeout Optional. The timeout period for how long the message is invisible in the queue in seconds. | ||
| * If unset the value will default to 0 and the message will be instantly visible. The timeout must be between 0 | ||
|
|
@@ -307,6 +337,9 @@ public Mono<Response<EnqueuedMessage>> enqueueMessage(String messageText, Durati | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.dequeueMessages} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages">Azure Docs</a>.</p> | ||
| * | ||
| * @return The first {@link DequeuedMessage} in the queue, it contains | ||
| * {@link DequeuedMessage#messageId() messageId} and {@link DequeuedMessage#popReceipt() popReceipt} used to interact | ||
| * with the message, additionally it contains other metadata about the message. | ||
|
|
@@ -325,6 +358,9 @@ public Flux<DequeuedMessage> dequeueMessages() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.dequeueMessages#integer} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages">Azure Docs</a>.</p> | ||
| * | ||
| * @param maxMessages Optional. Maximum number of messages to get, if there are less messages exist in the queue than requested | ||
| * all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 | ||
| * messages. | ||
|
|
@@ -347,6 +383,9 @@ public Flux<DequeuedMessage> dequeueMessages(Integer maxMessages) { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.dequeueMessages#integer-duration} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages">Azure Docs</a>.</p> | ||
| * | ||
| * @param maxMessages Optional. Maximum number of messages to get, if there are less messages exist in the queue than requested | ||
| * all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 | ||
| * messages. | ||
|
|
@@ -376,6 +415,9 @@ public Flux<DequeuedMessage> dequeueMessages(Integer maxMessages, Duration visib | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.peekMessages} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages">Azure Docs</a>.</p> | ||
| * | ||
| * @return A {@link PeekedMessage} that contains metadata about the message. | ||
| */ | ||
| public Flux<PeekedMessage> peekMessages() { | ||
|
|
@@ -394,6 +436,9 @@ public Flux<PeekedMessage> peekMessages() { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.peekMessages#integer} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages">Azure Docs</a>.</p> | ||
| * | ||
| * @param maxMessages Optional. Maximum number of messages to peek, if there are less messages exist in the queue than requested | ||
| * all the messages will be peeked. If left empty only 1 message will be peeked, the allowed range is 1 to 32 | ||
| * messages. | ||
|
|
@@ -415,6 +460,9 @@ public Flux<PeekedMessage> peekMessages(Integer maxMessages) { | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.updateMessage} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/update-message">Azure Docs</a>.</p> | ||
| * | ||
| * @param messageText Updated value for the message | ||
| * @param messageId Id of the message to update | ||
| * @param popReceipt Unique identifier that must match for the message to be updated | ||
|
|
@@ -440,6 +488,9 @@ public Mono<Response<UpdatedMessage>> updateMessage(String messageText, String m | |
| * | ||
| * {@codesnippet com.azure.storage.queue.queueAsyncClient.deleteMessage} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2">Azure Docs</a>.</p> | ||
| * | ||
| * @param messageId Id of the message to deleted | ||
| * @param popReceipt Unique identifier that must match for the message to be deleted | ||
| * @return A response that only contains headers and response status code | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of generic "Azure Docs", it's nice to see where this links to like: "Azure Docs: Create queue"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, even I think something like this "Azure Docs: Create queue" could be useful!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, will this mean, that we will need to update the azure docs format in blob api too, to ensure consistency?