Enabled contract validation

Author: germanosin

contract-typespec/api/acls.tsp

@@ -8,7 +8,7 @@ using OpenAPI;
 @route("/api/clusters/{clusterName}/acls")
 @tag("Acls")
 interface AclApi {
-  @doc("listKafkaAcls")
+  @summary("listKafkaAcls")
   @get
   @operationId("listAcls")
   listAcls(
@@ -20,41 +20,42 @@ interface AclApi {
   ): KafkaAcl[];
 
   @route("/csv")
-  @doc("getAclAsCsv")
+  @summary("getAclAsCsv")
   @get
   @operationId("getAclAsCsv")
   getAclAsCsv(@path clusterName: string): string;
 
   @route("/csv")
-  @doc("syncAclsCsv")
+  @summary("syncAclsCsv")
   @post
   @operationId("syncAclsCsv")
   syncAclsCsv(@path clusterName: string, @body content: string): void | ApiBadRequestResponse;
 
-  @doc("createAcl")
   @post
   @operationId("createAcl")
+  @summary("createAcl")
   createAcl(@path clusterName: string, @body acl: KafkaAcl): void | ApiBadRequestResponse;
 
-  @doc("deleteAcl")
+  @summary("deleteAcl")
   @delete
   @operationId("deleteAcl")
+  @summary("deleteAcl")
   deleteAcl(
     @path clusterName: string,
     @body acl: KafkaAcl,
   ): void | ApiNotFoundResponse;
 
   @route("/consumer")
-  @doc("createConsumerAcl")
   @post
   @operationId("createConsumerAcl")
+  @summary("createConsumerAcl")
   createConsumerAcl(
     @path clusterName: string,
     @body payload: CreateConsumerAcl,
   ): void | ApiBadRequestResponse;
 
   @route("/producer")
-  @doc("createProducerAcl")
+  @summary("createProducerAcl")
   @operationId("createProducerAcl")
   @post
   createProducerAcl(
@@ -63,7 +64,7 @@ interface AclApi {
   ): void | ApiBadRequestResponse;
 
   @route("/streamapp")
-  @doc("createStreamAppAcl")
+  @summary("createStreamAppAcl")
   @post
   @operationId("createStreamAppAcl")
   createStreamAppAcl(

contract-typespec/api/auth.tsp

@@ -8,14 +8,14 @@ using OpenAPI;
 @tag("Authorization")
 interface AuthorizationApi {
   @route("/api/authorization")
-  @doc("Get user authorization related info")
+  @summary("Get user authorization related info")
   @operationId("getUserAuthInfo")
   @get
   getUserAuthInfo(): AuthenticationInfo;
 }
 
 @route("/login")
-@doc("Authenticate")
+@summary("Authenticate")
 @operationId("authenticate")
 @post
 @tag("Unmapped")

contract-typespec/api/brokers.tsp

@@ -10,19 +10,19 @@ using OpenAPI;
 interface BrokersApi {
   @get
   @operationId("getBrokers")
-  @doc("getBrokers")
+  @summary("getBrokers")
   getBrokers(@path clusterName: string): Broker[];
 
   @get
   @route("/{id}/configs")
   @operationId("getBrokerConfig")
-  @doc("getBrokerConfig")
+  @summary("getBrokerConfig")
   getBrokerConfig(@path clusterName: string, @path id: int32): BrokerConfig[];
 
   @put
   @route("/{id}/configs/{name}")
   @operationId("updateBrokerConfigByName")
-  @doc("updateBrokerConfigByName")
+  @summary("updateBrokerConfigByName")
   updateBrokerConfigByName(
     @path clusterName: string,
     @path id: int32,
@@ -33,13 +33,13 @@ interface BrokersApi {
   @get
   @route("/{id}/metrics")
   @operationId("getBrokersMetrics")
-  @doc("getBrokersMetrics")
+  @summary("getBrokersMetrics")
   getBrokersMetrics(@path clusterName: string, @path id: int32): BrokerMetrics;
 
   @get
   @route("/logdirs")
   @operationId("getAllBrokersLogdirs")
-  @doc("getAllBrokersLogdirs")
+  @summary("getAllBrokersLogdirs")
   getAllBrokersLogdirs(
     @path clusterName: string,
     @query broker?: int32[],
@@ -48,7 +48,7 @@ interface BrokersApi {
   @patch(#{implicitOptionality: true})
   @route("/{id}/logdirs")
   @operationId("updateBrokerTopicPartitionLogDir")
-  @doc("updateBrokerTopicPartitionLogDir")
+  @summary("updateBrokerTopicPartitionLogDir")
   updateBrokerTopicPartitionLogDir(
     @path clusterName: string,
     @path id: int32,

contract-typespec/api/clusters.tsp

@@ -11,25 +11,25 @@ using OpenAPI;
 interface ClustersApi {
   @get
   @operationId("getClusters")
-  @doc("getClusters")
+  @summary("getClusters")
   getClusters(): Cluster[];
 
   @post
   @route("/{clusterName}/cache")
   @operationId("updateClusterInfo")
-  @doc("updateClusterInfo")
+  @summary("updateClusterInfo")
   updateClusterInfo(@path clusterName: string): Cluster;
 
   @get
   @route("/{clusterName}/metrics")
   @operationId("getClusterMetrics")
-  @doc("getClusterMetrics")
+  @summary("getClusterMetrics")
   getClusterMetrics(@path clusterName: string): ClusterMetrics;
 
   @get
   @route("/{clusterName}/stats")
   @operationId("getClusterStats")
-  @doc("getClusterStats")
+  @summary("getClusterStats")
   getClusterStats(@path clusterName: string): ClusterStats;
 }
 

contract-typespec/api/config.tsp

@@ -7,33 +7,33 @@ using TypeSpec.Http;
 using OpenAPI;
 
 @route("/api/info")
-@doc("Gets application info")
+@summary("Gets application info")
 @get
 @tag("ApplicationConfig")
 op getApplicationInfo(): ApplicationInfo;
 
 @route("/api/config")
 @tag("ApplicationConfig")
 interface ApplicationConfigApi {
-  @doc("Gets current application configuration")
+  @summary("Gets current application configuration")
   @get
   @operationId("getCurrentConfig")
   getCurrentConfig(): ApplicationConfig;
 
   @put
-  @doc("Restarts application with specified configuration")
+  @summary("Restarts application with specified configuration")
   @operationId("restartWithConfig")
   restartWithConfig(@body config: RestartRequest): void | ApiBadRequestResponse;
 
   @put
   @route("/validated")
-  @doc("Restarts application with specified configuration")
+  @summary("Restarts application with specified configuration")
   @operationId("validateConfig")
   validateConfig(@body config: ApplicationConfig): ApplicationConfigValidation | ApiBadRequestResponse;
 
   @post
   @route("/relatedfiles")
-  @doc("Upload config related file")
+  @summary("Upload config related file")
   @operationId("uploadConfigRelatedFile")
   uploadConfigRelatedFile(
     @multipartBody body: {
@@ -43,7 +43,7 @@ interface ApplicationConfigApi {
 
   @get
   @route("/authentication")
-  @doc("Get authentication methods enabled for the app and other related settings")
+  @summary("Get authentication methods enabled for the app and other related settings")
   @operationId("getAuthenticationSettings")
   getAuthenticationSettings(): AppAuthenticationSettings;
 }

contract-typespec/api/consumer-groups.tsp

@@ -12,6 +12,7 @@ interface ConsumerGroupsApi {
   @get
   @route("/paged")
   @operationId("getConsumerGroupsPage")
+  @summary("getConsumerGroupsPage")
   getConsumerGroupsPage(
     @path clusterName: string,
     @query page?: int32,
@@ -24,6 +25,7 @@ interface ConsumerGroupsApi {
   @get
   @route("/{id}")
   @operationId("getConsumerGroup")
+  @summary("getConsumerGroup")
   getConsumerGroup(
     @path clusterName: string,
     @path id: string,
@@ -32,11 +34,13 @@ interface ConsumerGroupsApi {
   @delete
   @route("/{id}")
   @operationId("deleteConsumerGroup")
+  @summary("deleteConsumerGroup")
   deleteConsumerGroup(@path clusterName: string, @path id: string): void;
 
   @post
   @route("/{id}/offsets")
   @operationId("resetConsumerGroupOffsets")
+  @summary("resetConsumerGroupOffsets")
   resetConsumerGroupOffsets(
     @path clusterName: string,
     @path id: string,
@@ -46,6 +50,7 @@ interface ConsumerGroupsApi {
   @delete
   @route("/{id}/topics/{topicName}")
   @operationId("deleteConsumerGroupOffsets")
+  @summary("deleteConsumerGroupOffsets")
   deleteConsumerGroupOffsets(
     @path clusterName: string,
     @path id: string,
@@ -58,6 +63,7 @@ interface ConsumerGroupsApi {
 interface TopicConsumerGroupsApi {
   @get
   @operationId("getTopicConsumerGroups")
+  @summary("getTopicConsumerGroups")
   getTopicConsumerGroups(
     @path clusterName: string,
     @path topicName: string,

contract-typespec/api/kafka-connect.tsp

@@ -11,11 +11,12 @@ using OpenAPI;
 interface ConnectInstancesApi {
   @get
   @operationId("getConnects")
+  @summary("getConnects")
   getConnects(@path clusterName: string, @query withStats?: boolean): Connect[];
 
   @get
   @route("/{connectName}/plugins")
-  @doc("get connector plugins")
+  @summary("get connector plugins")
   @operationId("getConnectorPlugins")
   getConnectorPlugins(
     @path clusterName: string,
@@ -24,7 +25,7 @@ interface ConnectInstancesApi {
 
   @put
   @route("/{connectName}/plugins/{pluginName}/config/validate")
-  @doc("validate connector plugin configuration")
+  @summary("validate connector plugin configuration")
   @operationId("validateConnectorPluginConfig")
   validateConnectorPluginConfig(
     @path clusterName: string,
@@ -40,6 +41,7 @@ interface ConnectInstancesApi {
 interface ConnectorsApi {
   @get
   @operationId("getAllConnectors")
+  @summary("getAllConnectors")
   getAllConnectors(
     @path clusterName: string,
     @query search?: string,
@@ -54,10 +56,12 @@ interface ConnectorsApi {
 interface KafkaConnectConnectorsApi {
   @get
   @operationId("getConnectors")
+  @summary("getConnectors")
   getConnectors(@path clusterName: string, @path connectName: string): string[];
 
   @post
   @operationId("createConnector")
+  @summary("createConnector")
   createConnector(
     @path clusterName: string,
     @path connectName: string,
@@ -67,6 +71,7 @@ interface KafkaConnectConnectorsApi {
   @get
   @route("/{connectorName}")
   @operationId("getConnector")
+  @summary("getConnector")
   getConnector(
     @path clusterName: string,
     @path connectName: string,
@@ -76,6 +81,7 @@ interface KafkaConnectConnectorsApi {
   @delete
   @route("/{connectorName}")
   @operationId("deleteConnector")
+  @summary("deleteConnector")
   deleteConnector(
     @path clusterName: string,
     @path connectName: string,
@@ -85,6 +91,7 @@ interface KafkaConnectConnectorsApi {
   @post
   @route("/{connectorName}/action/{action}")
   @operationId("updateConnectorState")
+  @summary("updateConnectorState")
   updateConnectorState(
     @path clusterName: string,
     @path connectName: string,
@@ -95,6 +102,7 @@ interface KafkaConnectConnectorsApi {
   @get
   @route("/{connectorName}/config")
   @operationId("getConnectorConfig")
+  @summary("getConnectorConfig")
   getConnectorConfig(
     @path clusterName: string,
     @path connectName: string,
@@ -104,6 +112,7 @@ interface KafkaConnectConnectorsApi {
   @put
   @route("/{connectorName}/config")
   @operationId("setConnectorConfig")
+  @summary("setConnectorConfig")
   setConnectorConfig(
     @path clusterName: string,
     @path connectName: string,
@@ -114,6 +123,7 @@ interface KafkaConnectConnectorsApi {
   @get
   @route("/{connectorName}/tasks")
   @operationId("getConnectorTasks")
+  @summary("getConnectorTasks")
   getConnectorTasks(
     @path clusterName: string,
     @path connectName: string,
@@ -123,6 +133,7 @@ interface KafkaConnectConnectorsApi {
   @post
   @route("/{connectorName}/tasks/{taskId}/action/restart")
   @operationId("restartConnectorTask")
+  @summary("restartConnectorTask")
   restartConnectorTask(
     @path clusterName: string,
     @path connectName: string,
@@ -133,6 +144,7 @@ interface KafkaConnectConnectorsApi {
   @delete
   @route("/{connectorName}/offsets")
   @operationId("resetConnectorOffsets")
+  @summary("resetConnectorOffsets")
   resetConnectorOffsets(
     @path clusterName: string,
     @path connectName: string,

contract-typespec/api/ksql.tsp

@@ -12,6 +12,7 @@ interface KsqlApi {
   @post
   @route("/v2")
   @operationId("executeKsql")
+  @summary("executeKsql")
   executeKsql(
     @path clusterName: string,
     @body command: KsqlCommandV2,
@@ -20,16 +21,19 @@ interface KsqlApi {
   @get
   @route("/tables")
   @operationId("listTables")
+  @summary("listTables")
   listTables(@path clusterName: string): KsqlTableDescription[];
 
   @get
   @route("/streams")
   @operationId("listStreams")
+  @summary("listStreams")
   listStreams(@path clusterName: string): KsqlStreamDescription[];
 
   @get
   @route("/response")
   @operationId("openKsqlResponsePipe")
+  @summary("openKsqlResponsePipe")
   openKsqlResponsePipe(
     @path clusterName: string,
     @query pipeId: string,