From 879f63e6591531060215fa76b5997ce5da24ea6a Mon Sep 17 00:00:00 2001 From: Gauri Prasad <51212198+gapra-msft@users.noreply.github.com> Date: Wed, 7 Jul 2021 13:53:53 -0700 Subject: [PATCH] Updated queues swagger (#22620) --- .../queue/implementation/MessagesImpl.java | 4 +- .../queue/implementation/QueuesImpl.java | 16 +-- .../queue/implementation/ServicesImpl.java | 2 +- .../storage/queue/models/QueueMetrics.java | 2 +- .../azure-storage-queue/swagger/README.md | 112 ------------------ 5 files changed, 12 insertions(+), 124 deletions(-) diff --git a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/MessagesImpl.java b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/MessagesImpl.java index 7d414cf6620f5..1dbcea534a8cb 100644 --- a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/MessagesImpl.java +++ b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/MessagesImpl.java @@ -99,8 +99,8 @@ Mono enqueue( @UnexpectedResponseExceptionType(com.azure.storage.queue.models.QueueStorageException.class) Mono peek( @HostParam("url") String url, - @QueryParam("peekonly") String peekonly, @PathParam("queueName") String queueName, + @QueryParam("peekonly") String peekonly, @QueryParam("numofmessages") Integer numberOfMessages, @QueryParam("timeout") Integer timeout, @HeaderParam("x-ms-version") String version, @@ -252,8 +252,8 @@ public Mono peekWithResponseAsync( final String accept = "application/xml"; return service.peek( this.client.getUrl(), - peekonly, queueName, + peekonly, numberOfMessages, timeout, this.client.getVersion(), diff --git a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/QueuesImpl.java b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/QueuesImpl.java index a1733d0793b7a..35ef82d12e190 100644 --- a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/QueuesImpl.java +++ b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/QueuesImpl.java @@ -87,8 +87,8 @@ Mono delete( @UnexpectedResponseExceptionType(com.azure.storage.queue.models.QueueStorageException.class) Mono getProperties( @HostParam("url") String url, - @QueryParam("comp") String comp, @PathParam("queueName") String queueName, + @QueryParam("comp") String comp, @QueryParam("timeout") Integer timeout, @HeaderParam("x-ms-version") String version, @HeaderParam("x-ms-client-request-id") String requestId, @@ -100,8 +100,8 @@ Mono getProperties( @UnexpectedResponseExceptionType(com.azure.storage.queue.models.QueueStorageException.class) Mono setMetadata( @HostParam("url") String url, - @QueryParam("comp") String comp, @PathParam("queueName") String queueName, + @QueryParam("comp") String comp, @QueryParam("timeout") Integer timeout, @HeaderParam("x-ms-meta-") Map metadata, @HeaderParam("x-ms-version") String version, @@ -114,8 +114,8 @@ Mono setMetadata( @UnexpectedResponseExceptionType(com.azure.storage.queue.models.QueueStorageException.class) Mono getAccessPolicy( @HostParam("url") String url, - @QueryParam("comp") String comp, @PathParam("queueName") String queueName, + @QueryParam("comp") String comp, @QueryParam("timeout") Integer timeout, @HeaderParam("x-ms-version") String version, @HeaderParam("x-ms-client-request-id") String requestId, @@ -127,8 +127,8 @@ Mono getAccessPolicy( @UnexpectedResponseExceptionType(com.azure.storage.queue.models.QueueStorageException.class) Mono setAccessPolicy( @HostParam("url") String url, - @QueryParam("comp") String comp, @PathParam("queueName") String queueName, + @QueryParam("comp") String comp, @QueryParam("timeout") Integer timeout, @HeaderParam("x-ms-version") String version, @HeaderParam("x-ms-client-request-id") String requestId, @@ -216,7 +216,7 @@ public Mono getPropertiesWithResponseAsync( final String comp = "metadata"; final String accept = "application/xml"; return service.getProperties( - this.client.getUrl(), comp, queueName, timeout, this.client.getVersion(), requestId, accept, context); + this.client.getUrl(), queueName, comp, timeout, this.client.getVersion(), requestId, accept, context); } /** @@ -245,8 +245,8 @@ public Mono setMetadataWithResponseAsync( final String accept = "application/xml"; return service.setMetadata( this.client.getUrl(), - comp, queueName, + comp, timeout, metadata, this.client.getVersion(), @@ -277,7 +277,7 @@ public Mono getAccessPolicyWithResponseAsync( final String comp = "acl"; final String accept = "application/xml"; return service.getAccessPolicy( - this.client.getUrl(), comp, queueName, timeout, this.client.getVersion(), requestId, accept, context); + this.client.getUrl(), queueName, comp, timeout, this.client.getVersion(), requestId, accept, context); } /** @@ -308,8 +308,8 @@ public Mono setAccessPolicyWithResponseAsync( SignedIdentifiersWrapper queueAclConverted = new SignedIdentifiersWrapper(queueAcl); return service.setAccessPolicy( this.client.getUrl(), - comp, queueName, + comp, timeout, this.client.getVersion(), requestId, diff --git a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/ServicesImpl.java b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/ServicesImpl.java index 0676e0290704b..a2453e2a92073 100644 --- a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/ServicesImpl.java +++ b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/implementation/ServicesImpl.java @@ -226,7 +226,7 @@ public Mono getStatisticsWithResponseAsync( * operation crosses a partition boundary, then the service will return a continuation token for retrieving the * remainder of the results. For this reason, it is possible that the service will return fewer results than * specified by maxresults, or than the default of 5000. - * @param include Include this parameter to specify that the queues's metadata be returned as part of the response + * @param include Include this parameter to specify that the queues' metadata be returned as part of the response * body. * @param timeout The The timeout parameter is expressed in seconds. For more information, see <a * href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations>Setting diff --git a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/models/QueueMetrics.java b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/models/QueueMetrics.java index a8dc6b764a756..3d1e7422197fe 100644 --- a/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/models/QueueMetrics.java +++ b/sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/models/QueueMetrics.java @@ -8,7 +8,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement; -/** The QueueMetrics model. */ +/** a summary of request statistics grouped by API in hour or minute aggregates for queues. */ @JacksonXmlRootElement(localName = "Metrics") @Fluent public final class QueueMetrics { diff --git a/sdk/storage/azure-storage-queue/swagger/README.md b/sdk/storage/azure-storage-queue/swagger/README.md index e49478ee7a33c..8a1767c361bf9 100644 --- a/sdk/storage/azure-storage-queue/swagger/README.md +++ b/sdk/storage/azure-storage-queue/swagger/README.md @@ -33,118 +33,6 @@ customization-jar-path: target/azure-storage-queue-customization-1.0.0-beta.1.ja customization-class: com.azure.storage.queue.customization.QueueStorageCustomization ``` -### /{queueName} -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}"] - transform: > - let param = $.put.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const path = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - $.put.parameters.splice(0, 0, { "$ref": path }); - $.delete.parameters.splice(0, 0, { "$ref": path }); - } -``` - -### /{queueName}?comp=metadata -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}?comp=metadata"] - transform: > - let param = $.put.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const path = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - $.put.parameters.splice(0, 0, { "$ref": path }); - $.get.parameters.splice(0, 0, { "$ref": path }); - } -``` - -### /{queueName}?comp=acl -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}?comp=acl"] - transform: > - let param = $.put.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const path = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - $.put.parameters.splice(0, 0, { "$ref": path }); - $.get.parameters.splice(0, 0, { "$ref": path }); - } -``` - -### /{queueName}/messages -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}/messages"] - transform: > - let param = $.get.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const path = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - $.get.parameters.splice(0, 0, { "$ref": path }); - $.delete.parameters.splice(0, 0, { "$ref": path }); - } -``` - -### /{queueName}/messages?visibilitytimeout={visibilityTimeout}&messagettl={messageTimeToLive} -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}/messages?visibilitytimeout={visibilityTimeout}&messagettl={messageTimeToLive}"] - transform: > - let param = $.post.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const path = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - $.post.parameters.splice(0, 0, { "$ref": path }); - } -``` - -### /{queueName}/messages?peekonly=true -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}/messages?peekonly=true"] - transform: > - let param = $.get.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const path = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - $.get.parameters.splice(0, 0, { "$ref": path }); - } -``` - -### /{queueName}/messages/{messageid}?popreceipt={popReceipt}&visibilitytimeout={visibilityTimeout} -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}/messages/{messageid}?popreceipt={popReceipt}&visibilitytimeout={visibilityTimeout}"] - transform: > - let param = $.put.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const queueNamePath = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - const messageIdPath = param["$ref"].replace(/[#].*$/, "#/parameters/MessageId"); - $.put.parameters.splice(0, 0, { "$ref": queueNamePath }); - $.put.parameters.splice(1, 0, { "$ref": messageIdPath }); - } -``` - -### /{queueName}/messages/{messageid}?popreceipt={popReceipt} -``` yaml -directive: -- from: swagger-document - where: $["x-ms-paths"]["/{queueName}/messages/{messageid}?popreceipt={popReceipt}"] - transform: > - let param = $.delete.parameters[0]; - if (!param["$ref"].endsWith("QueueName")) { - const queueNamePath = param["$ref"].replace(/[#].*$/, "#/parameters/QueueName"); - const messageIdPath = param["$ref"].replace(/[#].*$/, "#/parameters/MessageId"); - $.delete.parameters.splice(0, 0, { "$ref": queueNamePath }); - $.delete.parameters.splice(1, 0, { "$ref": messageIdPath }); - } -``` - ### Rename MessageItems ``` yaml directive: