From 310680c381be7c5ff20e7ef3321a46df40aaefb2 Mon Sep 17 00:00:00 2001 From: anushreeringne Date: Thu, 6 Feb 2020 12:25:29 -0800 Subject: [PATCH 1/3] Updating the OperationId Updating the OperationId because the grouping of operations isn't correct. --- .../hdinsight-kafka-rest-proxy/proxy.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json b/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json index 8b7e5335e37a..6cf1e547f5a0 100644 --- a/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json +++ b/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json @@ -39,7 +39,7 @@ "tags": [ "v1consumer" ], "summary": "Consume records using a simple consumer", "description": "Consume records from one partition of a topic beginning with a specific offset. By default count is 1. It can read maximum of 6 megabytes of data at once", - "operationId": "consumeTopicInPartitionWithOffset", + "operationId": "Consumer_ConsumeTopicInPartitionWithOffset", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ @@ -111,7 +111,7 @@ "tags": [ "v1metadata" ], "summary": "Get a list of Kafka brokers", "description": "Get a list of Kafka brokers with hostname, port, and broker id", - "operationId": "getBrokers", + "operationId": "Metadata_GetBrokers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { @@ -147,7 +147,7 @@ "tags": [ "v1metadata" ], "summary": "Get a list of Kafka topics", "description": "Get a list of Kafka topics. If it is a newly created topic, please wait a few seconds for it to show up.", - "operationId": "getTopics", + "operationId": "Metadata_GetTopics", "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { @@ -183,7 +183,7 @@ "tags": [ "v1metadata" ], "summary": "Get metadata about all partitions for a specific topic", "description": "Get metadata about all partitions for a specific topic with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas", - "operationId": "getPartitions", + "operationId": "Metadata_GetTopicPartitions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ @@ -228,7 +228,7 @@ "tags": [ "v1metadata" ], "summary": "Get metadata about a specific Kafka topic-partition", "description": "Get metadata about a specific Kafka topic-partition with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas", - "operationId": "getPartitionMetadata", + "operationId": "Metadata_GetMetadataForPartitionId", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ @@ -281,7 +281,7 @@ "tags": [ "v1producer" ], "summary": "Produce records", "description": "Produce records to a topic in Kafka. If producing records to a newly created topic, please wait a few seconds for the topic to show up.", - "operationId": "produceMessageToTopic", + "operationId": "Producer_ProduceMessageToTopic", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ @@ -335,7 +335,7 @@ "tags": [ "v1status" ], "summary": "Check the status of Kafka Rest proxy server", "description": "Check the status of Kafka Rest proxy server", - "operationId": "checkRestproxyStatus", + "operationId": "Admin_CheckRestProxyStatus", "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { @@ -353,7 +353,7 @@ "tags": [ "v1topics" ], "summary": "Create a topic", "description": "Create a topic in Kafka with topic configuration", - "operationId": "putTopics", + "operationId": "Admin_CreateTopic", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ From 850afe6fa0f121cf50573799dcfddb5a290f8765 Mon Sep 17 00:00:00 2001 From: anushreeringne Date: Thu, 6 Feb 2020 12:34:10 -0800 Subject: [PATCH 2/3] Updating the operationId spelling --- specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json b/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json index 6cf1e547f5a0..ec57bc5bcac8 100644 --- a/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json +++ b/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json @@ -228,7 +228,7 @@ "tags": [ "v1metadata" ], "summary": "Get metadata about a specific Kafka topic-partition", "description": "Get metadata about a specific Kafka topic-partition with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas", - "operationId": "Metadata_GetMetadataForPartitionId", + "operationId": "Metadata_GetMetadataForPartition", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ From 8b5182dde0e361ce0f46ff65e77a296223430448 Mon Sep 17 00:00:00 2001 From: anushreeringne Date: Fri, 21 Feb 2020 01:52:20 -0800 Subject: [PATCH 3/3] Making prettier fixes as outputed --- .../hdinsight-kafka-rest-proxy/proxy.json | 104 +++++++++++++----- 1 file changed, 78 insertions(+), 26 deletions(-) diff --git a/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json b/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json index ec57bc5bcac8..d09da2b64632 100644 --- a/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json +++ b/specification/hdinsight/hdinsight-kafka-rest-proxy/proxy.json @@ -32,16 +32,24 @@ "description": "Manage Kafka topics" } ], - "schemes": [ "https" ], + "schemes": [ + "https" + ], "paths": { "/v1/consumer/topics/{topic}/partitions/{partition}/offsets/{offset}": { "get": { - "tags": [ "v1consumer" ], + "tags": [ + "v1consumer" + ], "summary": "Consume records using a simple consumer", "description": "Consume records from one partition of a topic beginning with a specific offset. By default count is 1. It can read maximum of 6 megabytes of data at once", "operationId": "Consumer_ConsumeTopicInPartitionWithOffset", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "name": "topic", @@ -108,12 +116,18 @@ }, "/v1/metadata/brokers": { "get": { - "tags": [ "v1metadata" ], + "tags": [ + "v1metadata" + ], "summary": "Get a list of Kafka brokers", "description": "Get a list of Kafka brokers with hostname, port, and broker id", "operationId": "Metadata_GetBrokers", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "responses": { "200": { "description": "successful operation", @@ -144,12 +158,18 @@ }, "/v1/metadata/topics": { "get": { - "tags": [ "v1metadata" ], + "tags": [ + "v1metadata" + ], "summary": "Get a list of Kafka topics", "description": "Get a list of Kafka topics. If it is a newly created topic, please wait a few seconds for it to show up.", "operationId": "Metadata_GetTopics", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "responses": { "200": { "description": "successful operation", @@ -180,12 +200,18 @@ }, "/v1/metadata/topics/{topic}/partitions": { "get": { - "tags": [ "v1metadata" ], + "tags": [ + "v1metadata" + ], "summary": "Get metadata about all partitions for a specific topic", "description": "Get metadata about all partitions for a specific topic with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas", "operationId": "Metadata_GetTopicPartitions", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "name": "topic", @@ -225,12 +251,18 @@ }, "/v1/metadata/topics/{topic}/partitions/{partition}": { "get": { - "tags": [ "v1metadata" ], + "tags": [ + "v1metadata" + ], "summary": "Get metadata about a specific Kafka topic-partition", "description": "Get metadata about a specific Kafka topic-partition with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas", "operationId": "Metadata_GetMetadataForPartition", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "name": "topic", @@ -278,12 +310,18 @@ }, "/v1/producer/topics/{topic}": { "post": { - "tags": [ "v1producer" ], + "tags": [ + "v1producer" + ], "summary": "Produce records", "description": "Produce records to a topic in Kafka. If producing records to a newly created topic, please wait a few seconds for the topic to show up.", "operationId": "Producer_ProduceMessageToTopic", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "name": "topic", @@ -332,12 +370,18 @@ }, "/v1/status": { "get": { - "tags": [ "v1status" ], + "tags": [ + "v1status" + ], "summary": "Check the status of Kafka Rest proxy server", "description": "Check the status of Kafka Rest proxy server", "operationId": "Admin_CheckRestProxyStatus", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "responses": { "200": { "description": "successful operation", @@ -350,12 +394,18 @@ }, "/v1/topics/{topic}": { "put": { - "tags": [ "v1topics" ], + "tags": [ + "v1topics" + ], "summary": "Create a topic", "description": "Create a topic in Kafka with topic configuration", "operationId": "Admin_CreateTopic", - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "name": "topic", @@ -447,7 +497,9 @@ }, "ProducerRecord": { "type": "object", - "required": [ "value" ], + "required": [ + "value" + ], "properties": { "value": { "type": "object",